privatelinkresources

package
v0.20240312.1161024 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 12, 2024 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/migrate/2020-07-07/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service migrate (API Version 2020-07-07).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/migrate/2020-07-07/privatelinkresources"

Client Initialization

client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourcesClient.GetPrivateLinkResource

ctx := context.TODO()
id := privatelinkresources.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "masterSiteValue", "privateLinkResourceValue")

read, err := client.GetPrivateLinkResource(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PrivateLinkResourcesClient.GetPrivateLinkResources

ctx := context.TODO()
id := privatelinkresources.NewMasterSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "masterSiteValue")

// alternatively `client.GetPrivateLinkResources(ctx, id)` can be used to do batched pagination
items, err := client.GetPrivateLinkResourcesComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateMasterSiteID 

func ValidateMasterSiteID(input interface{}, key string) (warnings []string, errors []error)

ValidateMasterSiteID checks that 'input' can be parsed as a Master Site ID

func ValidatePrivateLinkResourceID 

func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateLinkResourceID checks that 'input' can be parsed as a Private Link Resource ID

Types

type GetPrivateLinkResourceOperationResponse 

type GetPrivateLinkResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResource
}

type GetPrivateLinkResourcesCompleteResult added in v0.20240226.1173038 

type GetPrivateLinkResourcesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateLinkResource
}

type GetPrivateLinkResourcesOperationResponse 

type GetPrivateLinkResourcesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateLinkResource
}

type MasterSiteId 

type MasterSiteId struct {
	SubscriptionId    string
	ResourceGroupName string
	MasterSiteName    string
}

MasterSiteId is a struct representing the Resource ID for a Master Site

func NewMasterSiteID 

func NewMasterSiteID(subscriptionId string, resourceGroupName string, masterSiteName string) MasterSiteId

NewMasterSiteID returns a new MasterSiteId struct

func ParseMasterSiteID 

func ParseMasterSiteID(input string) (*MasterSiteId, error)

ParseMasterSiteID parses 'input' into a MasterSiteId

func ParseMasterSiteIDInsensitively 

func ParseMasterSiteIDInsensitively(input string) (*MasterSiteId, error)

ParseMasterSiteIDInsensitively parses 'input' case-insensitively into a MasterSiteId note: this method should only be used for API response data and not user input

func (*MasterSiteId) FromParseResult 

func (id *MasterSiteId) FromParseResult(input resourceids.ParseResult) error

func (MasterSiteId) ID 

func (id MasterSiteId) ID() string

ID returns the formatted Master Site ID

func (MasterSiteId) Segments 

func (id MasterSiteId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Master Site ID

func (MasterSiteId) String 

func (id MasterSiteId) String() string

String returns a human-readable description of this Master Site ID

type PrivateLinkResource 

type PrivateLinkResource struct {
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type PrivateLinkResourceId 

type PrivateLinkResourceId struct {
	SubscriptionId          string
	ResourceGroupName       string
	MasterSiteName          string
	PrivateLinkResourceName string
}

PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource

func NewPrivateLinkResourceID 

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, masterSiteName string, privateLinkResourceName string) PrivateLinkResourceId

NewPrivateLinkResourceID returns a new PrivateLinkResourceId struct

func ParsePrivateLinkResourceID 

func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)

ParsePrivateLinkResourceID parses 'input' into a PrivateLinkResourceId

func ParsePrivateLinkResourceIDInsensitively 

func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)

ParsePrivateLinkResourceIDInsensitively parses 'input' case-insensitively into a PrivateLinkResourceId note: this method should only be used for API response data and not user input

func (*PrivateLinkResourceId) FromParseResult 

func (id *PrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error

func (PrivateLinkResourceId) ID 

func (id PrivateLinkResourceId) ID() string

ID returns the formatted Private Link Resource ID

func (PrivateLinkResourceId) Segments 

func (id PrivateLinkResourceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Link Resource ID

func (PrivateLinkResourceId) String 

func (id PrivateLinkResourceId) String() string

String returns a human-readable description of this Private Link Resource ID

type PrivateLinkResourceOperationPredicate added in v0.20240226.1173038 

type PrivateLinkResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PrivateLinkResourceOperationPredicate) Matches added in v0.20240226.1173038 

func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI 

func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)

func (PrivateLinkResourcesClient) GetPrivateLinkResource 

func (c PrivateLinkResourcesClient) GetPrivateLinkResource(ctx context.Context, id PrivateLinkResourceId) (result GetPrivateLinkResourceOperationResponse, err error)

GetPrivateLinkResource ...

func (PrivateLinkResourcesClient) GetPrivateLinkResources 

func (c PrivateLinkResourcesClient) GetPrivateLinkResources(ctx context.Context, id MasterSiteId) (result GetPrivateLinkResourcesOperationResponse, err error)

GetPrivateLinkResources ...

func (PrivateLinkResourcesClient) GetPrivateLinkResourcesComplete added in v0.20240226.1173038 

func (c PrivateLinkResourcesClient) GetPrivateLinkResourcesComplete(ctx context.Context, id MasterSiteId) (GetPrivateLinkResourcesCompleteResult, error)

GetPrivateLinkResourcesComplete retrieves all the results into a single object

func (PrivateLinkResourcesClient) GetPrivateLinkResourcesCompleteMatchingPredicate added in v0.20240226.1173038 

func (c PrivateLinkResourcesClient) GetPrivateLinkResourcesCompleteMatchingPredicate(ctx context.Context, id MasterSiteId, predicate PrivateLinkResourceOperationPredicate) (result GetPrivateLinkResourcesCompleteResult, err error)

GetPrivateLinkResourcesCompleteMatchingPredicate retrieves all the results and then applies the predicate

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.