privatelinkhubprivatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/privatelinkhubprivatelinkresources Documentation

The privatelinkhubprivatelinkresources SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-01).

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/synapse/2021-06-01/privatelinkhubprivatelinkresources"

Client Initialization

client := privatelinkhubprivatelinkresources.NewPrivateLinkHubPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkHubPrivateLinkResourcesClient.Get

ctx := context.TODO()
id := privatelinkhubprivatelinkresources.NewPrivateLinkHubPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkHubValue", "privateLinkResourceValue")

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

Example Usage: PrivateLinkHubPrivateLinkResourcesClient.List

ctx := context.TODO()
id := privatelinkhubprivatelinkresources.NewPrivateLinkHubID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkHubValue")

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

Documentation

Index

• func ValidatePrivateLinkHubID(input interface{}, key string) (warnings []string, errors []error)
• func ValidatePrivateLinkHubPrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type PrivateLinkHubId
  • func NewPrivateLinkHubID(subscriptionId string, resourceGroupName string, privateLinkHubName string) PrivateLinkHubId
  • func ParsePrivateLinkHubID(input string) (*PrivateLinkHubId, error)
  • func ParsePrivateLinkHubIDInsensitively(input string) (*PrivateLinkHubId, error)
  • func (id *PrivateLinkHubId) FromParseResult(input resourceids.ParseResult) error
  • func (id PrivateLinkHubId) ID() string
  • func (id PrivateLinkHubId) Segments() []resourceids.Segment
  • func (id PrivateLinkHubId) String() string
• type PrivateLinkHubPrivateLinkResourceId
  • func NewPrivateLinkHubPrivateLinkResourceID(subscriptionId string, resourceGroupName string, privateLinkHubName string, ...) PrivateLinkHubPrivateLinkResourceId
  • func ParsePrivateLinkHubPrivateLinkResourceID(input string) (*PrivateLinkHubPrivateLinkResourceId, error)
  • func ParsePrivateLinkHubPrivateLinkResourceIDInsensitively(input string) (*PrivateLinkHubPrivateLinkResourceId, error)
  • func (id *PrivateLinkHubPrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error
  • func (id PrivateLinkHubPrivateLinkResourceId) ID() string
  • func (id PrivateLinkHubPrivateLinkResourceId) Segments() []resourceids.Segment
  • func (id PrivateLinkHubPrivateLinkResourceId) String() string
• type PrivateLinkHubPrivateLinkResourcesClient
  • func NewPrivateLinkHubPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkHubPrivateLinkResourcesClient, error)
  • func (c PrivateLinkHubPrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkHubPrivateLinkResourceId) (result GetOperationResponse, err error)
  • func (c PrivateLinkHubPrivateLinkResourcesClient) List(ctx context.Context, id PrivateLinkHubId) (result ListOperationResponse, err error)
  • func (c PrivateLinkHubPrivateLinkResourcesClient) ListComplete(ctx context.Context, id PrivateLinkHubId) (ListCompleteResult, error)
  • func (c PrivateLinkHubPrivateLinkResourcesClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateLinkHubId, ...) (result ListCompleteResult, err error)
• type PrivateLinkResource
• type PrivateLinkResourceOperationPredicate
  • func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool
• type PrivateLinkResourceProperties

Functions

func ValidatePrivateLinkHubID

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

ValidatePrivateLinkHubID checks that 'input' can be parsed as a Private Link Hub ID

func ValidatePrivateLinkHubPrivateLinkResourceID

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

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

Types

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type PrivateLinkHubId

type PrivateLinkHubId struct {
	SubscriptionId     string
	ResourceGroupName  string
	PrivateLinkHubName string
}

PrivateLinkHubId is a struct representing the Resource ID for a Private Link Hub

func NewPrivateLinkHubID

func NewPrivateLinkHubID(subscriptionId string, resourceGroupName string, privateLinkHubName string) PrivateLinkHubId

NewPrivateLinkHubID returns a new PrivateLinkHubId struct

func ParsePrivateLinkHubID

func ParsePrivateLinkHubID(input string) (*PrivateLinkHubId, error)

ParsePrivateLinkHubID parses 'input' into a PrivateLinkHubId

func ParsePrivateLinkHubIDInsensitively

func ParsePrivateLinkHubIDInsensitively(input string) (*PrivateLinkHubId, error)

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

func (*PrivateLinkHubId) FromParseResult

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

func (PrivateLinkHubId) ID

func (id PrivateLinkHubId) ID() string

ID returns the formatted Private Link Hub ID

func (PrivateLinkHubId) Segments

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

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

func (PrivateLinkHubId) String

func (id PrivateLinkHubId) String() string

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

type PrivateLinkHubPrivateLinkResourceId

type PrivateLinkHubPrivateLinkResourceId struct {
	SubscriptionId          string
	ResourceGroupName       string
	PrivateLinkHubName      string
	PrivateLinkResourceName string
}

PrivateLinkHubPrivateLinkResourceId is a struct representing the Resource ID for a Private Link Hub Private Link Resource

func NewPrivateLinkHubPrivateLinkResourceID

func NewPrivateLinkHubPrivateLinkResourceID(subscriptionId string, resourceGroupName string, privateLinkHubName string, privateLinkResourceName string) PrivateLinkHubPrivateLinkResourceId

NewPrivateLinkHubPrivateLinkResourceID returns a new PrivateLinkHubPrivateLinkResourceId struct

func ParsePrivateLinkHubPrivateLinkResourceID

func ParsePrivateLinkHubPrivateLinkResourceID(input string) (*PrivateLinkHubPrivateLinkResourceId, error)

ParsePrivateLinkHubPrivateLinkResourceID parses 'input' into a PrivateLinkHubPrivateLinkResourceId

func ParsePrivateLinkHubPrivateLinkResourceIDInsensitively

func ParsePrivateLinkHubPrivateLinkResourceIDInsensitively(input string) (*PrivateLinkHubPrivateLinkResourceId, error)

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

func (*PrivateLinkHubPrivateLinkResourceId) FromParseResult

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

func (PrivateLinkHubPrivateLinkResourceId) ID

func (id PrivateLinkHubPrivateLinkResourceId) ID() string

ID returns the formatted Private Link Hub Private Link Resource ID

func (PrivateLinkHubPrivateLinkResourceId) Segments

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

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

func (PrivateLinkHubPrivateLinkResourceId) String

func (id PrivateLinkHubPrivateLinkResourceId) String() string

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

type PrivateLinkHubPrivateLinkResourcesClient

type PrivateLinkHubPrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkHubPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkHubPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkHubPrivateLinkResourcesClient, error)

func (PrivateLinkHubPrivateLinkResourcesClient) Get

func (c PrivateLinkHubPrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkHubPrivateLinkResourceId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkHubPrivateLinkResourcesClient) List

func (c PrivateLinkHubPrivateLinkResourcesClient) List(ctx context.Context, id PrivateLinkHubId) (result ListOperationResponse, err error)

List ...

func (PrivateLinkHubPrivateLinkResourcesClient) ListComplete

func (c PrivateLinkHubPrivateLinkResourcesClient) ListComplete(ctx context.Context, id PrivateLinkHubId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PrivateLinkHubPrivateLinkResourcesClient) ListCompleteMatchingPredicate

func (c PrivateLinkHubPrivateLinkResourcesClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateLinkHubId, predicate PrivateLinkResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 PrivateLinkResourceOperationPredicate

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

func (PrivateLinkResourceOperationPredicate) Matches

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"`
}