privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/appconfiguration/2022-05-01/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service appconfiguration (API Version 2022-05-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/appconfiguration/2022-05-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", "configurationStoreValue", "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.ListByConfigurationStore

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

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

Documentation

Index

• func ValidateConfigurationStoreID(input interface{}, key string) (warnings []string, errors []error)
• func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
• type ConfigurationStoreId
  • func NewConfigurationStoreID(subscriptionId string, resourceGroupName string, configurationStoreName string) ConfigurationStoreId
  • func ParseConfigurationStoreID(input string) (*ConfigurationStoreId, error)
  • func ParseConfigurationStoreIDInsensitively(input string) (*ConfigurationStoreId, error)
  • func (id ConfigurationStoreId) ID() string
  • func (id ConfigurationStoreId) Segments() []resourceids.Segment
  • func (id ConfigurationStoreId) String() string
• type GetOperationResponse
• type ListByConfigurationStoreCompleteResult
• type ListByConfigurationStoreOperationResponse
  • func (r ListByConfigurationStoreOperationResponse) HasMore() bool
  • func (r ListByConfigurationStoreOperationResponse) LoadMore(ctx context.Context) (resp ListByConfigurationStoreOperationResponse, err error)
• type PrivateLinkResource
• type PrivateLinkResourceId
  • func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, configurationStoreName 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(endpoint string) PrivateLinkResourcesClient
  • func (c PrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkResourceId) (result GetOperationResponse, err error)
  • func (c PrivateLinkResourcesClient) ListByConfigurationStore(ctx context.Context, id ConfigurationStoreId) (resp ListByConfigurationStoreOperationResponse, err error)
  • func (c PrivateLinkResourcesClient) ListByConfigurationStoreComplete(ctx context.Context, id ConfigurationStoreId) (ListByConfigurationStoreCompleteResult, error)
  • func (c PrivateLinkResourcesClient) ListByConfigurationStoreCompleteMatchingPredicate(ctx context.Context, id ConfigurationStoreId, ...) (resp ListByConfigurationStoreCompleteResult, err error)

Functions

func ValidateConfigurationStoreID

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

ValidateConfigurationStoreID checks that 'input' can be parsed as a Configuration Store 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 ConfigurationStoreId

type ConfigurationStoreId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ConfigurationStoreName string
}

ConfigurationStoreId is a struct representing the Resource ID for a Configuration Store

func NewConfigurationStoreID

func NewConfigurationStoreID(subscriptionId string, resourceGroupName string, configurationStoreName string) ConfigurationStoreId

NewConfigurationStoreID returns a new ConfigurationStoreId struct

func ParseConfigurationStoreID

func ParseConfigurationStoreID(input string) (*ConfigurationStoreId, error)

ParseConfigurationStoreID parses 'input' into a ConfigurationStoreId

func ParseConfigurationStoreIDInsensitively

func ParseConfigurationStoreIDInsensitively(input string) (*ConfigurationStoreId, error)

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

func (ConfigurationStoreId) ID

func (id ConfigurationStoreId) ID() string

ID returns the formatted Configuration Store ID

func (ConfigurationStoreId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Configuration Store ID

func (ConfigurationStoreId) String

func (id ConfigurationStoreId) String() string

String returns a human-readable description of this Configuration Store ID

type GetOperationResponse

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

type ListByConfigurationStoreCompleteResult

type ListByConfigurationStoreCompleteResult struct {
	Items []PrivateLinkResource
}

type ListByConfigurationStoreOperationResponse

type ListByConfigurationStoreOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]PrivateLinkResource
	// contains filtered or unexported fields
}

func (ListByConfigurationStoreOperationResponse) HasMore

func (r ListByConfigurationStoreOperationResponse) HasMore() bool

func (ListByConfigurationStoreOperationResponse) LoadMore

func (r ListByConfigurationStoreOperationResponse) LoadMore(ctx context.Context) (resp ListByConfigurationStoreOperationResponse, err error)

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
	ConfigurationStoreName  string
	PrivateLinkResourceName string
}

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

func NewPrivateLinkResourceID

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, configurationStoreName 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"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(endpoint string) PrivateLinkResourcesClient

func (PrivateLinkResourcesClient) Get

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

Get ...

func (PrivateLinkResourcesClient) ListByConfigurationStore

func (c PrivateLinkResourcesClient) ListByConfigurationStore(ctx context.Context, id ConfigurationStoreId) (resp ListByConfigurationStoreOperationResponse, err error)

ListByConfigurationStore ...

func (PrivateLinkResourcesClient) ListByConfigurationStoreComplete

func (c PrivateLinkResourcesClient) ListByConfigurationStoreComplete(ctx context.Context, id ConfigurationStoreId) (ListByConfigurationStoreCompleteResult, error)

ListByConfigurationStoreComplete retrieves all of the results into a single object

func (PrivateLinkResourcesClient) ListByConfigurationStoreCompleteMatchingPredicate

func (c PrivateLinkResourcesClient) ListByConfigurationStoreCompleteMatchingPredicate(ctx context.Context, id ConfigurationStoreId, predicate PrivateLinkResourceOperationPredicate) (resp ListByConfigurationStoreCompleteResult, err error)

ListByConfigurationStoreCompleteMatchingPredicate retrieves all of the results and then applied the predicate