privatelink

package
v0.20241023.1122425 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

The privatelink SDK allows for interaction with Azure Resource Manager notificationhubs (API Version 2023-09-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/notificationhubs/2023-09-01/privatelink"

Client Initialization

client := privatelink.NewPrivateLinkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkClient.PrivateEndpointConnectionsDelete

ctx := context.TODO()
id := privatelink.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "privateEndpointConnectionName")

if err := client.PrivateEndpointConnectionsDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PrivateLinkClient.PrivateEndpointConnectionsGet

ctx := context.TODO()
id := privatelink.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "privateEndpointConnectionName")

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

Example Usage: PrivateLinkClient.PrivateEndpointConnectionsGetGroupId

ctx := context.TODO()
id := privatelink.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "privateLinkResourceName")

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

Example Usage: PrivateLinkClient.PrivateEndpointConnectionsList

ctx := context.TODO()
id := privatelink.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName")

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

Example Usage: PrivateLinkClient.PrivateEndpointConnectionsListGroupIds

ctx := context.TODO()
id := privatelink.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName")

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

Example Usage: PrivateLinkClient.PrivateEndpointConnectionsUpdate

ctx := context.TODO()
id := privatelink.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "privateEndpointConnectionName")

payload := privatelink.PrivateEndpointConnectionResource{
	// ...
}


if err := client.PrivateEndpointConnectionsUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForPrivateEndpointConnectionProvisioningState 

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateLinkConnectionStatus 

func PossibleValuesForPrivateLinkConnectionStatus() []string

func ValidateNamespaceID 

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

func ValidatePrivateEndpointConnectionID 

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

ValidatePrivateEndpointConnectionID checks that 'input' can be parsed as a Private Endpoint Connection 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 NamespaceId 

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID 

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID 

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively 

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult 

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

func (NamespaceId) ID 

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments 

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

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

func (NamespaceId) String 

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type PrivateEndpointConnectionId 

type PrivateEndpointConnectionId struct {
	SubscriptionId                string
	ResourceGroupName             string
	NamespaceName                 string
	PrivateEndpointConnectionName string
}

PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, namespaceName string, privateEndpointConnectionName string) PrivateEndpointConnectionId

NewPrivateEndpointConnectionID returns a new PrivateEndpointConnectionId struct

func ParsePrivateEndpointConnectionID 

func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)

ParsePrivateEndpointConnectionID parses 'input' into a PrivateEndpointConnectionId

func ParsePrivateEndpointConnectionIDInsensitively 

func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)

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

func (*PrivateEndpointConnectionId) FromParseResult 

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

func (PrivateEndpointConnectionId) ID 

func (id PrivateEndpointConnectionId) ID() string

ID returns the formatted Private Endpoint Connection ID

func (PrivateEndpointConnectionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Endpoint Connection ID

func (PrivateEndpointConnectionId) String 

func (id PrivateEndpointConnectionId) String() string

String returns a human-readable description of this Private Endpoint Connection ID

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                   `json:"groupIds,omitempty"`
	PrivateEndpoint                   *RemotePrivateEndpointConnection            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *RemotePrivateLinkServiceConnectionState    `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating        PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleted         PrivateEndpointConnectionProvisioningState = "Deleted"
	PrivateEndpointConnectionProvisioningStateDeleting        PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateDeletingByProxy PrivateEndpointConnectionProvisioningState = "DeletingByProxy"
	PrivateEndpointConnectionProvisioningStateSucceeded       PrivateEndpointConnectionProvisioningState = "Succeeded"
	PrivateEndpointConnectionProvisioningStateUnknown         PrivateEndpointConnectionProvisioningState = "Unknown"
	PrivateEndpointConnectionProvisioningStateUpdating        PrivateEndpointConnectionProvisioningState = "Updating"
	PrivateEndpointConnectionProvisioningStateUpdatingByProxy PrivateEndpointConnectionProvisioningState = "UpdatingByProxy"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON 

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

type PrivateEndpointConnectionResource 

type PrivateEndpointConnectionResource struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionResourceOperationPredicate added in v0.20240226.1173038 

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

func (PrivateEndpointConnectionResourceOperationPredicate) Matches added in v0.20240226.1173038 

func (p PrivateEndpointConnectionResourceOperationPredicate) Matches(input PrivateEndpointConnectionResource) bool

type PrivateEndpointConnectionsDeleteOperationResponse 

type PrivateEndpointConnectionsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type PrivateEndpointConnectionsGetGroupIdOperationResponse 

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

type PrivateEndpointConnectionsGetOperationResponse 

type PrivateEndpointConnectionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnectionResource
}

type PrivateEndpointConnectionsListCompleteResult added in v0.20240226.1173038 

type PrivateEndpointConnectionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateEndpointConnectionResource
}

type PrivateEndpointConnectionsListCustomPager added in v0.20240628.1153531 

type PrivateEndpointConnectionsListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *PrivateEndpointConnectionsListCustomPager) NextPageLink() *odata.Link

type PrivateEndpointConnectionsListGroupIdsCompleteResult added in v0.20240226.1173038 

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

type PrivateEndpointConnectionsListGroupIdsCustomPager added in v0.20240628.1153531 

type PrivateEndpointConnectionsListGroupIdsCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *PrivateEndpointConnectionsListGroupIdsCustomPager) NextPageLink() *odata.Link

type PrivateEndpointConnectionsListGroupIdsOperationResponse 

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

type PrivateEndpointConnectionsListOperationResponse 

type PrivateEndpointConnectionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnectionResource
}

type PrivateEndpointConnectionsUpdateOperationResponse 

type PrivateEndpointConnectionsUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnectionResource
}

type PrivateLinkClient 

type PrivateLinkClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkClientWithBaseURI 

func NewPrivateLinkClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkClient, error)

func (PrivateLinkClient) PrivateEndpointConnectionsDelete 

func (c PrivateLinkClient) PrivateEndpointConnectionsDelete(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionsDeleteOperationResponse, err error)

PrivateEndpointConnectionsDelete ...

func (PrivateLinkClient) PrivateEndpointConnectionsDeleteThenPoll 

func (c PrivateLinkClient) PrivateEndpointConnectionsDeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error

PrivateEndpointConnectionsDeleteThenPoll performs PrivateEndpointConnectionsDelete then polls until it's completed

func (PrivateLinkClient) PrivateEndpointConnectionsGet 

func (c PrivateLinkClient) PrivateEndpointConnectionsGet(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionsGetOperationResponse, err error)

PrivateEndpointConnectionsGet ...

func (PrivateLinkClient) PrivateEndpointConnectionsGetGroupId 

func (c PrivateLinkClient) PrivateEndpointConnectionsGetGroupId(ctx context.Context, id PrivateLinkResourceId) (result PrivateEndpointConnectionsGetGroupIdOperationResponse, err error)

PrivateEndpointConnectionsGetGroupId ...

func (PrivateLinkClient) PrivateEndpointConnectionsList 

func (c PrivateLinkClient) PrivateEndpointConnectionsList(ctx context.Context, id NamespaceId) (result PrivateEndpointConnectionsListOperationResponse, err error)

PrivateEndpointConnectionsList ...

func (PrivateLinkClient) PrivateEndpointConnectionsListComplete added in v0.20240226.1173038 

func (c PrivateLinkClient) PrivateEndpointConnectionsListComplete(ctx context.Context, id NamespaceId) (PrivateEndpointConnectionsListCompleteResult, error)

PrivateEndpointConnectionsListComplete retrieves all the results into a single object

func (PrivateLinkClient) PrivateEndpointConnectionsListCompleteMatchingPredicate added in v0.20240226.1173038 

func (c PrivateLinkClient) PrivateEndpointConnectionsListCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate PrivateEndpointConnectionResourceOperationPredicate) (result PrivateEndpointConnectionsListCompleteResult, err error)

PrivateEndpointConnectionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkClient) PrivateEndpointConnectionsListGroupIds 

func (c PrivateLinkClient) PrivateEndpointConnectionsListGroupIds(ctx context.Context, id NamespaceId) (result PrivateEndpointConnectionsListGroupIdsOperationResponse, err error)

PrivateEndpointConnectionsListGroupIds ...

func (PrivateLinkClient) PrivateEndpointConnectionsListGroupIdsComplete added in v0.20240226.1173038 

func (c PrivateLinkClient) PrivateEndpointConnectionsListGroupIdsComplete(ctx context.Context, id NamespaceId) (PrivateEndpointConnectionsListGroupIdsCompleteResult, error)

PrivateEndpointConnectionsListGroupIdsComplete retrieves all the results into a single object

func (PrivateLinkClient) PrivateEndpointConnectionsListGroupIdsCompleteMatchingPredicate added in v0.20240226.1173038 

func (c PrivateLinkClient) PrivateEndpointConnectionsListGroupIdsCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate PrivateLinkResourceOperationPredicate) (result PrivateEndpointConnectionsListGroupIdsCompleteResult, err error)

PrivateEndpointConnectionsListGroupIdsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkClient) PrivateEndpointConnectionsUpdate 

func (c PrivateLinkClient) PrivateEndpointConnectionsUpdate(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnectionResource) (result PrivateEndpointConnectionsUpdateOperationResponse, err error)

PrivateEndpointConnectionsUpdate ...

func (PrivateLinkClient) PrivateEndpointConnectionsUpdateThenPoll 

func (c PrivateLinkClient) PrivateEndpointConnectionsUpdateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnectionResource) error

PrivateEndpointConnectionsUpdateThenPoll performs PrivateEndpointConnectionsUpdate then polls until it's completed

type PrivateLinkConnectionStatus 

type PrivateLinkConnectionStatus string
const (
	PrivateLinkConnectionStatusApproved     PrivateLinkConnectionStatus = "Approved"
	PrivateLinkConnectionStatusDisconnected PrivateLinkConnectionStatus = "Disconnected"
	PrivateLinkConnectionStatusPending      PrivateLinkConnectionStatus = "Pending"
	PrivateLinkConnectionStatusRejected     PrivateLinkConnectionStatus = "Rejected"
)

func (*PrivateLinkConnectionStatus) UnmarshalJSON 

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

type PrivateLinkResource 

type PrivateLinkResource struct {
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type PrivateLinkResourceId 

type PrivateLinkResourceId struct {
	SubscriptionId          string
	ResourceGroupName       string
	NamespaceName           string
	PrivateLinkResourceName string
}

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

func NewPrivateLinkResourceID 

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, namespaceName 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) 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 added in v0.20240226.1173038 

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

func (PrivateLinkResourceOperationPredicate) Matches added in v0.20240226.1173038 

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 RemotePrivateEndpointConnection 

type RemotePrivateEndpointConnection struct {
	Id *string `json:"id,omitempty"`
}

type RemotePrivateLinkServiceConnectionState 

type RemotePrivateLinkServiceConnectionState struct {
	ActionsRequired *string                      `json:"actionsRequired,omitempty"`
	Description     *string                      `json:"description,omitempty"`
	Status          *PrivateLinkConnectionStatus `json:"status,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.