README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2023-02-01/privateendpointconnection
Documentation
The privateendpointconnection
SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup
(API Version 2023-02-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/recoveryservicesbackup/2023-02-01/privateendpointconnection"
Client Initialization
client := privateendpointconnection.NewPrivateEndpointConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateEndpointConnectionClient.Delete
ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "privateEndpointConnectionValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionClient.Get
ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "privateEndpointConnectionValue")
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: PrivateEndpointConnectionClient.Put
ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "privateEndpointConnectionValue")
payload := privateendpointconnection.PrivateEndpointConnectionResource{
// ...
}
if err := client.PutThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForPrivateEndpointConnectionStatus() []string
- func PossibleValuesForProvisioningState() []string
- func PossibleValuesForVaultSubResourceType() []string
- func ValidatePrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)
- type DeleteOperationResponse
- type GetOperationResponse
- type PrivateEndpoint
- type PrivateEndpointConnection
- type PrivateEndpointConnectionClient
- func (c PrivateEndpointConnectionClient) Delete(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
- func (c PrivateEndpointConnectionClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
- func (c PrivateEndpointConnectionClient) Get(ctx context.Context, id PrivateEndpointConnectionId) (result GetOperationResponse, err error)
- func (c PrivateEndpointConnectionClient) Put(ctx context.Context, id PrivateEndpointConnectionId, ...) (result PutOperationResponse, err error)
- func (c PrivateEndpointConnectionClient) PutThenPoll(ctx context.Context, id PrivateEndpointConnectionId, ...) error
- type PrivateEndpointConnectionId
- func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, vaultName string, ...) PrivateEndpointConnectionId
- func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)
- func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)
- type PrivateEndpointConnectionResource
- type PrivateEndpointConnectionStatus
- type PrivateLinkServiceConnectionState
- type ProvisioningState
- type PutOperationResponse
- type VaultSubResourceType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPrivateEndpointConnectionStatus ¶
func PossibleValuesForPrivateEndpointConnectionStatus() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func PossibleValuesForVaultSubResourceType ¶ added in v0.20230424.1231037
func PossibleValuesForVaultSubResourceType() []string
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
Types ¶
type DeleteOperationResponse ¶
type DeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *PrivateEndpointConnectionResource }
type PrivateEndpoint ¶
type PrivateEndpoint struct {
Id *string `json:"id,omitempty"`
}
type PrivateEndpointConnection ¶
type PrivateEndpointConnection struct { GroupIds *[]VaultSubResourceType `json:"groupIds,omitempty"` PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"` PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` }
type PrivateEndpointConnectionClient ¶
type PrivateEndpointConnectionClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewPrivateEndpointConnectionClientWithBaseURI ¶
func NewPrivateEndpointConnectionClientWithBaseURI(endpoint string) PrivateEndpointConnectionClient
func (PrivateEndpointConnectionClient) Delete ¶
func (c PrivateEndpointConnectionClient) Delete(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
Delete ...
func (PrivateEndpointConnectionClient) DeleteThenPoll ¶
func (c PrivateEndpointConnectionClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
DeleteThenPoll performs Delete then polls until it's completed
func (PrivateEndpointConnectionClient) Get ¶
func (c PrivateEndpointConnectionClient) Get(ctx context.Context, id PrivateEndpointConnectionId) (result GetOperationResponse, err error)
Get ...
func (PrivateEndpointConnectionClient) Put ¶
func (c PrivateEndpointConnectionClient) Put(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnectionResource) (result PutOperationResponse, err error)
Put ...
func (PrivateEndpointConnectionClient) PutThenPoll ¶
func (c PrivateEndpointConnectionClient) PutThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnectionResource) error
PutThenPoll performs Put then polls until it's completed
type PrivateEndpointConnectionId ¶
type PrivateEndpointConnectionId struct { SubscriptionId string ResourceGroupName string VaultName string PrivateEndpointConnectionName string }
PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection
func NewPrivateEndpointConnectionID ¶
func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, vaultName 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) 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 PrivateEndpointConnectionResource ¶
type PrivateEndpointConnectionResource struct { ETag *string `json:"eTag,omitempty"` Id *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *PrivateEndpointConnection `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type PrivateEndpointConnectionStatus ¶
type PrivateEndpointConnectionStatus string
const ( PrivateEndpointConnectionStatusApproved PrivateEndpointConnectionStatus = "Approved" PrivateEndpointConnectionStatusDisconnected PrivateEndpointConnectionStatus = "Disconnected" PrivateEndpointConnectionStatusPending PrivateEndpointConnectionStatus = "Pending" PrivateEndpointConnectionStatusRejected PrivateEndpointConnectionStatus = "Rejected" )
type PrivateLinkServiceConnectionState ¶
type PrivateLinkServiceConnectionState struct { ActionsRequired *string `json:"actionsRequired,omitempty"` Description *string `json:"description,omitempty"` Status *PrivateEndpointConnectionStatus `json:"status,omitempty"` }
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStatePending ProvisioningState = "Pending" ProvisioningStateSucceeded ProvisioningState = "Succeeded" )
type PutOperationResponse ¶
type PutOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type VaultSubResourceType ¶ added in v0.20230424.1231037
type VaultSubResourceType string
const ( VaultSubResourceTypeAzureBackup VaultSubResourceType = "AzureBackup" VaultSubResourceTypeAzureBackupSecondary VaultSubResourceType = "AzureBackup_secondary" VaultSubResourceTypeAzureSiteRecovery VaultSubResourceType = "AzureSiteRecovery" )