README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/privateendpointconnections
Documentation
The privateendpointconnections
SDK allows for interaction with the Azure Resource Manager Service apimanagement
(API Version 2022-08-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/apimanagement/2022-08-01/privateendpointconnections"
Client Initialization
client := privateendpointconnections.NewPrivateEndpointConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionCreateOrUpdate
ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "privateEndpointConnectionValue")
payload := privateendpointconnections.PrivateEndpointConnectionRequest{
// ...
}
if err := client.PrivateEndpointConnectionCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionDelete
ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "privateEndpointConnectionValue")
if err := client.PrivateEndpointConnectionDeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionGetByName
ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "privateEndpointConnectionValue")
read, err := client.PrivateEndpointConnectionGetByName(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionGetPrivateLinkResource
ctx := context.TODO()
id := privateendpointconnections.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "privateLinkResourceValue")
read, err := client.PrivateEndpointConnectionGetPrivateLinkResource(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionListByService
ctx := context.TODO()
id := privateendpointconnections.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
read, err := client.PrivateEndpointConnectionListByService(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionListPrivateLinkResources
ctx := context.TODO()
id := privateendpointconnections.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
read, err := client.PrivateEndpointConnectionListPrivateLinkResources(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 ValidatePrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type PrivateEndpoint
- type PrivateEndpointConnection
- type PrivateEndpointConnectionCreateOrUpdateOperationResponse
- type PrivateEndpointConnectionDeleteOperationResponse
- type PrivateEndpointConnectionGetByNameOperationResponse
- type PrivateEndpointConnectionGetPrivateLinkResourceOperationResponse
- type PrivateEndpointConnectionId
- func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, serviceName string, ...) PrivateEndpointConnectionId
- func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)
- func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)
- type PrivateEndpointConnectionListByServiceOperationResponse
- type PrivateEndpointConnectionListPrivateLinkResourcesOperationResponse
- type PrivateEndpointConnectionListResult
- type PrivateEndpointConnectionProperties
- type PrivateEndpointConnectionProvisioningState
- type PrivateEndpointConnectionRequest
- type PrivateEndpointConnectionRequestProperties
- type PrivateEndpointConnectionsClient
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdate(ctx context.Context, id PrivateEndpointConnectionId, ...) (result PrivateEndpointConnectionCreateOrUpdateOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, ...) error
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionDelete(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionDeleteOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionDeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionGetByName(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionGetByNameOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionGetPrivateLinkResource(ctx context.Context, id PrivateLinkResourceId) (result PrivateEndpointConnectionGetPrivateLinkResourceOperationResponse, ...)
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionListByService(ctx context.Context, id ServiceId) (result PrivateEndpointConnectionListByServiceOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionListPrivateLinkResources(ctx context.Context, id ServiceId) (result PrivateEndpointConnectionListPrivateLinkResourcesOperationResponse, ...)
- type PrivateEndpointServiceConnectionStatus
- type PrivateLinkResource
- type PrivateLinkResourceId
- type PrivateLinkResourceListResult
- type PrivateLinkResourceProperties
- type PrivateLinkServiceConnectionState
- type ServiceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPrivateEndpointConnectionProvisioningState ¶
func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string
func PossibleValuesForPrivateEndpointServiceConnectionStatus ¶
func PossibleValuesForPrivateEndpointServiceConnectionStatus() []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
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
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a 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"` Type *string `json:"type,omitempty"` }
type PrivateEndpointConnectionGetByNameOperationResponse ¶
type PrivateEndpointConnectionGetByNameOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateEndpointConnection }
type PrivateEndpointConnectionGetPrivateLinkResourceOperationResponse ¶
type PrivateEndpointConnectionGetPrivateLinkResourceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateLinkResource }
type PrivateEndpointConnectionId ¶
type PrivateEndpointConnectionId struct { SubscriptionId string ResourceGroupName string ServiceName string PrivateEndpointConnectionName string }
PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection
func NewPrivateEndpointConnectionID ¶
func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, serviceName 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 PrivateEndpointConnectionListByServiceOperationResponse ¶
type PrivateEndpointConnectionListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateEndpointConnectionListResult }
type PrivateEndpointConnectionListPrivateLinkResourcesOperationResponse ¶
type PrivateEndpointConnectionListPrivateLinkResourcesOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateLinkResourceListResult }
type PrivateEndpointConnectionListResult ¶
type PrivateEndpointConnectionListResult struct {
Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}
type PrivateEndpointConnectionProperties ¶
type PrivateEndpointConnectionProperties struct { 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 PrivateEndpointConnectionRequest ¶
type PrivateEndpointConnectionRequest struct { Id *string `json:"id,omitempty"` Properties *PrivateEndpointConnectionRequestProperties `json:"properties,omitempty"` }
type PrivateEndpointConnectionRequestProperties ¶
type PrivateEndpointConnectionRequestProperties struct {
PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}
type PrivateEndpointConnectionsClient ¶
type PrivateEndpointConnectionsClient struct {
Client *resourcemanager.Client
}
func NewPrivateEndpointConnectionsClientWithBaseURI ¶
func NewPrivateEndpointConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionsClient, error)
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdate ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdate(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnectionRequest) (result PrivateEndpointConnectionCreateOrUpdateOperationResponse, err error)
PrivateEndpointConnectionCreateOrUpdate ...
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdateThenPoll ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnectionRequest) error
PrivateEndpointConnectionCreateOrUpdateThenPoll performs PrivateEndpointConnectionCreateOrUpdate then polls until it's completed
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionDelete ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionDelete(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionDeleteOperationResponse, err error)
PrivateEndpointConnectionDelete ...
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionDeleteThenPoll ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionDeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
PrivateEndpointConnectionDeleteThenPoll performs PrivateEndpointConnectionDelete then polls until it's completed
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionGetByName ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionGetByName(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionGetByNameOperationResponse, err error)
PrivateEndpointConnectionGetByName ...
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionGetPrivateLinkResource ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionGetPrivateLinkResource(ctx context.Context, id PrivateLinkResourceId) (result PrivateEndpointConnectionGetPrivateLinkResourceOperationResponse, err error)
PrivateEndpointConnectionGetPrivateLinkResource ...
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionListByService ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionListByService(ctx context.Context, id ServiceId) (result PrivateEndpointConnectionListByServiceOperationResponse, err error)
PrivateEndpointConnectionListByService ...
func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionListPrivateLinkResources ¶
func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionListPrivateLinkResources(ctx context.Context, id ServiceId) (result PrivateEndpointConnectionListPrivateLinkResourcesOperationResponse, err error)
PrivateEndpointConnectionListPrivateLinkResources ...
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 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 ServiceName string PrivateLinkResourceName string }
PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource
func NewPrivateLinkResourceID ¶
func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, serviceName 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 PrivateLinkResourceListResult ¶
type PrivateLinkResourceListResult struct {
Value *[]PrivateLinkResource `json:"value,omitempty"`
}
type PrivateLinkServiceConnectionState ¶
type PrivateLinkServiceConnectionState struct { ActionsRequired *string `json:"actionsRequired,omitempty"` Description *string `json:"description,omitempty"` Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"` }
type ServiceId ¶
ServiceId is a struct representing the Resource ID for a Service
func NewServiceID ¶
NewServiceID returns a new ServiceId struct
func ParseServiceID ¶
ParseServiceID parses 'input' into a ServiceId
func ParseServiceIDInsensitively ¶
ParseServiceIDInsensitively parses 'input' case-insensitively into a ServiceId note: this method should only be used for API response data and not user input
func (*ServiceId) FromParseResult ¶
func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
func (ServiceId) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID
Source Files ¶
- client.go
- constants.go
- id_privateendpointconnection.go
- id_privatelinkresource.go
- id_service.go
- method_privateendpointconnectioncreateorupdate.go
- method_privateendpointconnectiondelete.go
- method_privateendpointconnectiongetbyname.go
- method_privateendpointconnectiongetprivatelinkresource.go
- method_privateendpointconnectionlistbyservice.go
- method_privateendpointconnectionlistprivatelinkresources.go
- model_privateendpoint.go
- model_privateendpointconnection.go
- model_privateendpointconnectionlistresult.go
- model_privateendpointconnectionproperties.go
- model_privateendpointconnectionrequest.go
- model_privateendpointconnectionrequestproperties.go
- model_privatelinkresource.go
- model_privatelinkresourcelistresult.go
- model_privatelinkresourceproperties.go
- model_privatelinkserviceconnectionstate.go
- version.go