privateendpointconnectionresource

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2022-09-01/privateendpointconnectionresource Documentation

The privateendpointconnectionresource SDK allows for interaction with the Azure Resource Manager Service storagesync (API Version 2022-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/storagesync/2022-09-01/privateendpointconnectionresource"

Client Initialization

client := privateendpointconnectionresource.NewPrivateEndpointConnectionResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateEndpointConnectionResourceClient.PrivateEndpointConnectionsListByStorageSyncService

ctx := context.TODO()
id := privateendpointconnectionresource.NewStorageSyncServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue")

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

Documentation

Index

• func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string
• func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string
• func ValidateStorageSyncServiceID(input interface{}, key string) (warnings []string, errors []error)
• type PrivateEndpoint
• type PrivateEndpointConnection
• type PrivateEndpointConnectionListResult
• type PrivateEndpointConnectionProperties
• type PrivateEndpointConnectionProvisioningState
  • func (s *PrivateEndpointConnectionProvisioningState) UnmarshalJSON(bytes []byte) error
• type PrivateEndpointConnectionResourceClient
  • func NewPrivateEndpointConnectionResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionResourceClient, error)
  • func (c PrivateEndpointConnectionResourceClient) PrivateEndpointConnectionsListByStorageSyncService(ctx context.Context, id StorageSyncServiceId) (result PrivateEndpointConnectionsListByStorageSyncServiceOperationResponse, ...)
• type PrivateEndpointConnectionsListByStorageSyncServiceOperationResponse
• type PrivateEndpointServiceConnectionStatus
  • func (s *PrivateEndpointServiceConnectionStatus) UnmarshalJSON(bytes []byte) error
• type PrivateLinkServiceConnectionState
• type StorageSyncServiceId
  • func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId
  • func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)
  • func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)
  • func (id *StorageSyncServiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id StorageSyncServiceId) ID() string
  • func (id StorageSyncServiceId) Segments() []resourceids.Segment
  • func (id StorageSyncServiceId) String() string

Functions

func PossibleValuesForPrivateEndpointConnectionProvisioningState

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func ValidateStorageSyncServiceID

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

ValidateStorageSyncServiceID checks that 'input' can be parsed as a Storage Sync Service ID

Types

type PrivateEndpoint

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

type PrivateEndpointConnection

type PrivateEndpointConnection 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 PrivateEndpointConnectionListResult

type PrivateEndpointConnectionListResult struct {
	Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}

type PrivateEndpointConnectionProperties

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

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON

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

type PrivateEndpointConnectionResourceClient

type PrivateEndpointConnectionResourceClient struct {
	Client *resourcemanager.Client
}

func NewPrivateEndpointConnectionResourceClientWithBaseURI

func NewPrivateEndpointConnectionResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionResourceClient, error)

func (PrivateEndpointConnectionResourceClient) PrivateEndpointConnectionsListByStorageSyncService

func (c PrivateEndpointConnectionResourceClient) PrivateEndpointConnectionsListByStorageSyncService(ctx context.Context, id StorageSyncServiceId) (result PrivateEndpointConnectionsListByStorageSyncServiceOperationResponse, err error)

PrivateEndpointConnectionsListByStorageSyncService ...

type PrivateEndpointConnectionsListByStorageSyncServiceOperationResponse

type PrivateEndpointConnectionsListByStorageSyncServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnectionListResult
}

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON

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

type PrivateLinkServiceConnectionState

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

type StorageSyncServiceId

type StorageSyncServiceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
}

StorageSyncServiceId is a struct representing the Resource ID for a Storage Sync Service

func NewStorageSyncServiceID

func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId

NewStorageSyncServiceID returns a new StorageSyncServiceId struct

func ParseStorageSyncServiceID

func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)

ParseStorageSyncServiceID parses 'input' into a StorageSyncServiceId

func ParseStorageSyncServiceIDInsensitively

func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)

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

func (*StorageSyncServiceId) FromParseResult

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

func (StorageSyncServiceId) ID

func (id StorageSyncServiceId) ID() string

ID returns the formatted Storage Sync Service ID

func (StorageSyncServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Storage Sync Service ID

func (StorageSyncServiceId) String

func (id StorageSyncServiceId) String() string

String returns a human-readable description of this Storage Sync Service ID