privatelinkresource

README

github.com/hashicorp/go-azure-sdk/resource-manager/purview/2021-07-01/privatelinkresource Documentation

The privatelinkresource SDK allows for interaction with Azure Resource Manager purview (API Version 2021-07-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/purview/2021-07-01/privatelinkresource"

Client Initialization

client := privatelinkresource.NewPrivateLinkResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourceClient.GetByGroupId

ctx := context.TODO()
id := privatelinkresource.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "groupId")

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

Example Usage: PrivateLinkResourceClient.ListByAccount

ctx := context.TODO()
id := privatelinkresource.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName")

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

Documentation

Index

• func ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)
• func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
• type AccountId
  • func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId
  • func ParseAccountID(input string) (*AccountId, error)
  • func ParseAccountIDInsensitively(input string) (*AccountId, error)
  • func (id *AccountId) FromParseResult(input resourceids.ParseResult) error
  • func (id AccountId) ID() string
  • func (id AccountId) Segments() []resourceids.Segment
  • func (id AccountId) String() string
• type GetByGroupIdOperationResponse
• type ListByAccountCompleteResult
• type ListByAccountCustomPager
  • func (p *ListByAccountCustomPager) NextPageLink() *odata.Link
• type ListByAccountOperationResponse
• type PrivateLinkResource
• type PrivateLinkResourceClient
  • func NewPrivateLinkResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourceClient, error)
  • func (c PrivateLinkResourceClient) GetByGroupId(ctx context.Context, id PrivateLinkResourceId) (result GetByGroupIdOperationResponse, err error)
  • func (c PrivateLinkResourceClient) ListByAccount(ctx context.Context, id AccountId) (result ListByAccountOperationResponse, err error)
  • func (c PrivateLinkResourceClient) ListByAccountComplete(ctx context.Context, id AccountId) (ListByAccountCompleteResult, error)
  • func (c PrivateLinkResourceClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, ...) (result ListByAccountCompleteResult, err error)
• type PrivateLinkResourceId
  • func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, accountName string, ...) PrivateLinkResourceId
  • func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)
  • func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)
  • func (id *PrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error
  • func (id PrivateLinkResourceId) ID() string
  • func (id PrivateLinkResourceId) Segments() []resourceids.Segment
  • func (id PrivateLinkResourceId) String() string
• type PrivateLinkResourceOperationPredicate
  • func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool
• type PrivateLinkResourceProperties

Functions

func ValidateAccountID

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

ValidateAccountID checks that 'input' can be parsed as a Account 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 AccountId

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult

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

func (AccountId) ID

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Account ID

func (AccountId) String

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type GetByGroupIdOperationResponse

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

type ListByAccountCompleteResult

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

type ListByAccountCustomPager

type ListByAccountCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByAccountCustomPager) NextPageLink

func (p *ListByAccountCustomPager) NextPageLink() *odata.Link

type ListByAccountOperationResponse

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

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 PrivateLinkResourceClient

type PrivateLinkResourceClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourceClientWithBaseURI

func NewPrivateLinkResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourceClient, error)

func (PrivateLinkResourceClient) GetByGroupId

func (c PrivateLinkResourceClient) GetByGroupId(ctx context.Context, id PrivateLinkResourceId) (result GetByGroupIdOperationResponse, err error)

GetByGroupId ...

func (PrivateLinkResourceClient) ListByAccount

func (c PrivateLinkResourceClient) ListByAccount(ctx context.Context, id AccountId) (result ListByAccountOperationResponse, err error)

ListByAccount ...

func (PrivateLinkResourceClient) ListByAccountComplete

func (c PrivateLinkResourceClient) ListByAccountComplete(ctx context.Context, id AccountId) (ListByAccountCompleteResult, error)

ListByAccountComplete retrieves all the results into a single object

func (PrivateLinkResourceClient) ListByAccountCompleteMatchingPredicate

func (c PrivateLinkResourceClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate PrivateLinkResourceOperationPredicate) (result ListByAccountCompleteResult, err error)

ListByAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PrivateLinkResourceId

type PrivateLinkResourceId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	GroupId           string
}

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

func NewPrivateLinkResourceID

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, accountName string, groupId 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

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