privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/azureactivedirectory/2020-03-01/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service azureactivedirectory (API Version 2020-03-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/azureactivedirectory/2020-03-01/privatelinkresources"

Client Initialization

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

Example Usage: PrivateLinkResourcesClient.Get

ctx := context.TODO()
id := privatelinkresources.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkForAzureAdValue", "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: PrivateLinkResourcesClient.ListByPrivateLinkPolicy

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

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

Documentation

Index

• func ValidatePrivateLinkForAzureAdID(input interface{}, key string) (warnings []string, errors []error)
• func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListByPrivateLinkPolicyCompleteResult
• type ListByPrivateLinkPolicyOperationResponse
• type PrivateLinkForAzureAdId
  • func NewPrivateLinkForAzureAdID(subscriptionId string, resourceGroupName string, ...) PrivateLinkForAzureAdId
  • func ParsePrivateLinkForAzureAdID(input string) (*PrivateLinkForAzureAdId, error)
  • func ParsePrivateLinkForAzureAdIDInsensitively(input string) (*PrivateLinkForAzureAdId, error)
  • func (id PrivateLinkForAzureAdId) ID() string
  • func (id PrivateLinkForAzureAdId) Segments() []resourceids.Segment
  • func (id PrivateLinkForAzureAdId) String() string
• type PrivateLinkResource
• type PrivateLinkResourceId
  • func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, ...) PrivateLinkResourceId
  • func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)
  • func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, 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
• type PrivateLinkResourcesClient
  • func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)
  • func (c PrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkResourceId) (result GetOperationResponse, err error)
  • func (c PrivateLinkResourcesClient) ListByPrivateLinkPolicy(ctx context.Context, id PrivateLinkForAzureAdId) (result ListByPrivateLinkPolicyOperationResponse, err error)
  • func (c PrivateLinkResourcesClient) ListByPrivateLinkPolicyComplete(ctx context.Context, id PrivateLinkForAzureAdId) (ListByPrivateLinkPolicyCompleteResult, error)
  • func (c PrivateLinkResourcesClient) ListByPrivateLinkPolicyCompleteMatchingPredicate(ctx context.Context, id PrivateLinkForAzureAdId, ...) (result ListByPrivateLinkPolicyCompleteResult, err error)

Functions

func ValidatePrivateLinkForAzureAdID

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

ValidatePrivateLinkForAzureAdID checks that 'input' can be parsed as a Private Link For Azure Ad 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 GetOperationResponse

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

type ListByPrivateLinkPolicyCompleteResult

type ListByPrivateLinkPolicyCompleteResult struct {
	Items []PrivateLinkResource
}

type ListByPrivateLinkPolicyOperationResponse

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

type PrivateLinkForAzureAdId

type PrivateLinkForAzureAdId struct {
	SubscriptionId            string
	ResourceGroupName         string
	PrivateLinkForAzureAdName string
}

PrivateLinkForAzureAdId is a struct representing the Resource ID for a Private Link For Azure Ad

func NewPrivateLinkForAzureAdID

func NewPrivateLinkForAzureAdID(subscriptionId string, resourceGroupName string, privateLinkForAzureAdName string) PrivateLinkForAzureAdId

NewPrivateLinkForAzureAdID returns a new PrivateLinkForAzureAdId struct

func ParsePrivateLinkForAzureAdID

func ParsePrivateLinkForAzureAdID(input string) (*PrivateLinkForAzureAdId, error)

ParsePrivateLinkForAzureAdID parses 'input' into a PrivateLinkForAzureAdId

func ParsePrivateLinkForAzureAdIDInsensitively

func ParsePrivateLinkForAzureAdIDInsensitively(input string) (*PrivateLinkForAzureAdId, error)

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

func (PrivateLinkForAzureAdId) ID

func (id PrivateLinkForAzureAdId) ID() string

ID returns the formatted Private Link For Azure Ad ID

func (PrivateLinkForAzureAdId) Segments

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

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

func (PrivateLinkForAzureAdId) String

func (id PrivateLinkForAzureAdId) String() string

String returns a human-readable description of this Private Link For Azure Ad 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
	PrivateLinkForAzureAdName string
	PrivateLinkResourceName   string
}

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

func NewPrivateLinkResourceID

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, privateLinkForAzureAdName 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) 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"`
}

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

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

func (PrivateLinkResourcesClient) Get

func (c PrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkResourceId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicy

func (c PrivateLinkResourcesClient) ListByPrivateLinkPolicy(ctx context.Context, id PrivateLinkForAzureAdId) (result ListByPrivateLinkPolicyOperationResponse, err error)

ListByPrivateLinkPolicy ...

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicyComplete

func (c PrivateLinkResourcesClient) ListByPrivateLinkPolicyComplete(ctx context.Context, id PrivateLinkForAzureAdId) (ListByPrivateLinkPolicyCompleteResult, error)

ListByPrivateLinkPolicyComplete retrieves all the results into a single object

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicyCompleteMatchingPredicate

func (c PrivateLinkResourcesClient) ListByPrivateLinkPolicyCompleteMatchingPredicate(ctx context.Context, id PrivateLinkForAzureAdId, predicate PrivateLinkResourceOperationPredicate) (result ListByPrivateLinkPolicyCompleteResult, err error)

ListByPrivateLinkPolicyCompleteMatchingPredicate retrieves all the results and then applies the predicate