privatelinkassociation

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-05-01/privatelinkassociation Documentation

The privatelinkassociation SDK allows for interaction with Azure Resource Manager resources (API Version 2020-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-05-01/privatelinkassociation"

Client Initialization

client := privatelinkassociation.NewPrivateLinkAssociationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkAssociationClient.Delete

ctx := context.TODO()
id := privatelinkassociation.NewPrivateLinkAssociationID("groupId", "plaId")

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

Example Usage: PrivateLinkAssociationClient.Get

ctx := context.TODO()
id := privatelinkassociation.NewPrivateLinkAssociationID("groupId", "plaId")

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: PrivateLinkAssociationClient.List

ctx := context.TODO()
id := commonids.NewManagementGroupID("groupId")

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

Example Usage: PrivateLinkAssociationClient.Put

ctx := context.TODO()
id := privatelinkassociation.NewPrivateLinkAssociationID("groupId", "plaId")

payload := privatelinkassociation.PrivateLinkAssociationObject{
	// ...
}


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

Documentation

Index

• func PossibleValuesForPublicNetworkAccessOptions() []string
• func ValidatePrivateLinkAssociationID(input interface{}, key string) (warnings []string, errors []error)
• type DeleteOperationResponse
• type GetOperationResponse
• type ListOperationResponse
• type PrivateLinkAssociation
• type PrivateLinkAssociationClient
  • func NewPrivateLinkAssociationClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkAssociationClient, error)
  • func (c PrivateLinkAssociationClient) Delete(ctx context.Context, id PrivateLinkAssociationId) (result DeleteOperationResponse, err error)
  • func (c PrivateLinkAssociationClient) Get(ctx context.Context, id PrivateLinkAssociationId) (result GetOperationResponse, err error)
  • func (c PrivateLinkAssociationClient) List(ctx context.Context, id commonids.ManagementGroupId) (result ListOperationResponse, err error)
  • func (c PrivateLinkAssociationClient) Put(ctx context.Context, id PrivateLinkAssociationId, ...) (result PutOperationResponse, err error)
• type PrivateLinkAssociationGetResult
• type PrivateLinkAssociationId
  • func NewPrivateLinkAssociationID(groupId string, plaId string) PrivateLinkAssociationId
  • func ParsePrivateLinkAssociationID(input string) (*PrivateLinkAssociationId, error)
  • func ParsePrivateLinkAssociationIDInsensitively(input string) (*PrivateLinkAssociationId, error)
  • func (id *PrivateLinkAssociationId) FromParseResult(input resourceids.ParseResult) error
  • func (id PrivateLinkAssociationId) ID() string
  • func (id PrivateLinkAssociationId) Segments() []resourceids.Segment
  • func (id PrivateLinkAssociationId) String() string
• type PrivateLinkAssociationObject
• type PrivateLinkAssociationProperties
• type PrivateLinkAssociationPropertiesExpanded
• type PublicNetworkAccessOptions
  • func (s *PublicNetworkAccessOptions) UnmarshalJSON(bytes []byte) error
• type PutOperationResponse

Functions

func PossibleValuesForPublicNetworkAccessOptions

func PossibleValuesForPublicNetworkAccessOptions() []string

func ValidatePrivateLinkAssociationID

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

ValidatePrivateLinkAssociationID checks that 'input' can be parsed as a Private Link Association ID

Types

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

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

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkAssociationGetResult
}

type PrivateLinkAssociation

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

type PrivateLinkAssociationClient

type PrivateLinkAssociationClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkAssociationClientWithBaseURI

func NewPrivateLinkAssociationClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkAssociationClient, error)

func (PrivateLinkAssociationClient) Delete

func (c PrivateLinkAssociationClient) Delete(ctx context.Context, id PrivateLinkAssociationId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateLinkAssociationClient) Get

func (c PrivateLinkAssociationClient) Get(ctx context.Context, id PrivateLinkAssociationId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkAssociationClient) List

func (c PrivateLinkAssociationClient) List(ctx context.Context, id commonids.ManagementGroupId) (result ListOperationResponse, err error)

List ...

func (PrivateLinkAssociationClient) Put

func (c PrivateLinkAssociationClient) Put(ctx context.Context, id PrivateLinkAssociationId, input PrivateLinkAssociationObject) (result PutOperationResponse, err error)

Put ...

type PrivateLinkAssociationGetResult

type PrivateLinkAssociationGetResult struct {
	Value *[]PrivateLinkAssociation `json:"value,omitempty"`
}

type PrivateLinkAssociationId

type PrivateLinkAssociationId struct {
	GroupId string
	PlaId   string
}

PrivateLinkAssociationId is a struct representing the Resource ID for a Private Link Association

func NewPrivateLinkAssociationID

func NewPrivateLinkAssociationID(groupId string, plaId string) PrivateLinkAssociationId

NewPrivateLinkAssociationID returns a new PrivateLinkAssociationId struct

func ParsePrivateLinkAssociationID

func ParsePrivateLinkAssociationID(input string) (*PrivateLinkAssociationId, error)

ParsePrivateLinkAssociationID parses 'input' into a PrivateLinkAssociationId

func ParsePrivateLinkAssociationIDInsensitively

func ParsePrivateLinkAssociationIDInsensitively(input string) (*PrivateLinkAssociationId, error)

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

func (*PrivateLinkAssociationId) FromParseResult

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

func (PrivateLinkAssociationId) ID

func (id PrivateLinkAssociationId) ID() string

ID returns the formatted Private Link Association ID

func (PrivateLinkAssociationId) Segments

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

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

func (PrivateLinkAssociationId) String

func (id PrivateLinkAssociationId) String() string

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

type PrivateLinkAssociationObject

type PrivateLinkAssociationObject struct {
	Properties *PrivateLinkAssociationProperties `json:"properties,omitempty"`
}

type PrivateLinkAssociationProperties

type PrivateLinkAssociationProperties struct {
	PrivateLink         *string                     `json:"privateLink,omitempty"`
	PublicNetworkAccess *PublicNetworkAccessOptions `json:"publicNetworkAccess,omitempty"`
}

type PrivateLinkAssociationPropertiesExpanded

type PrivateLinkAssociationPropertiesExpanded struct {
	PrivateLink         *string                     `json:"privateLink,omitempty"`
	PublicNetworkAccess *PublicNetworkAccessOptions `json:"publicNetworkAccess,omitempty"`
	Scope               *string                     `json:"scope,omitempty"`
	TenantID            *string                     `json:"tenantID,omitempty"`
}

type PublicNetworkAccessOptions

type PublicNetworkAccessOptions string

const (
	PublicNetworkAccessOptionsDisabled PublicNetworkAccessOptions = "Disabled"
	PublicNetworkAccessOptionsEnabled  PublicNetworkAccessOptions = "Enabled"
)

func (*PublicNetworkAccessOptions) UnmarshalJSON

func (s *PublicNetworkAccessOptions) UnmarshalJSON(bytes []byte) error

type PutOperationResponse

type PutOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkAssociation
}