README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/hybridcompute/2022-12-27/privateendpointconnections
Documentation
The privateendpointconnections
SDK allows for interaction with the Azure Resource Manager Service hybridcompute
(API Version 2022-12-27
).
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/hybridcompute/2022-12-27/privateendpointconnections"
Client Initialization
client := privateendpointconnections.NewPrivateEndpointConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateEndpointConnectionsClient.CreateOrUpdate
ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue", "privateEndpointConnectionValue")
payload := privateendpointconnections.PrivateEndpointConnection{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionsClient.Delete
ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue", "privateEndpointConnectionValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionsClient.Get
ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue", "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: PrivateEndpointConnectionsClient.ListByPrivateLinkScope
ctx := context.TODO()
id := privateendpointconnections.NewProviderPrivateLinkScopeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue")
// alternatively `client.ListByPrivateLinkScope(ctx, id)` can be used to do batched pagination
items, err := client.ListByPrivateLinkScopeComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func ValidatePrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateProviderPrivateLinkScopeID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByPrivateLinkScopeCompleteResult
- type ListByPrivateLinkScopeOperationResponse
- type PrivateEndpointConnection
- type PrivateEndpointConnectionId
- func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, privateLinkScopeName string, ...) PrivateEndpointConnectionId
- func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)
- func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)
- type PrivateEndpointConnectionOperationPredicate
- type PrivateEndpointConnectionProperties
- type PrivateEndpointConnectionsClient
- func (c PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, id PrivateEndpointConnectionId, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, ...) error
- func (c PrivateEndpointConnectionsClient) Delete(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
- func (c PrivateEndpointConnectionsClient) Get(ctx context.Context, id PrivateEndpointConnectionId) (result GetOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScope(ctx context.Context, id ProviderPrivateLinkScopeId) (result ListByPrivateLinkScopeOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScopeComplete(ctx context.Context, id ProviderPrivateLinkScopeId) (ListByPrivateLinkScopeCompleteResult, error)
- func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScopeCompleteMatchingPredicate(ctx context.Context, id ProviderPrivateLinkScopeId, ...) (result ListByPrivateLinkScopeCompleteResult, err error)
- type PrivateEndpointProperty
- type PrivateLinkServiceConnectionStateProperty
- type ProviderPrivateLinkScopeId
- func NewProviderPrivateLinkScopeID(subscriptionId string, resourceGroupName string, privateLinkScopeName string) ProviderPrivateLinkScopeId
- func ParseProviderPrivateLinkScopeID(input string) (*ProviderPrivateLinkScopeId, error)
- func ParseProviderPrivateLinkScopeIDInsensitively(input string) (*ProviderPrivateLinkScopeId, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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 ValidateProviderPrivateLinkScopeID ¶
func ValidateProviderPrivateLinkScopeID(input interface{}, key string) (warnings []string, errors []error)
ValidateProviderPrivateLinkScopeID checks that 'input' can be parsed as a Provider Private Link Scope ID
Types ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateEndpointConnection }
type ListByPrivateLinkScopeCompleteResult ¶
type ListByPrivateLinkScopeCompleteResult struct {
Items []PrivateEndpointConnection
}
type ListByPrivateLinkScopeOperationResponse ¶
type ListByPrivateLinkScopeOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]PrivateEndpointConnection }
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 PrivateEndpointConnectionId ¶
type PrivateEndpointConnectionId struct { SubscriptionId string ResourceGroupName string PrivateLinkScopeName string PrivateEndpointConnectionName string }
PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection
func NewPrivateEndpointConnectionID ¶
func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, privateLinkScopeName 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 PrivateEndpointConnectionOperationPredicate ¶
func (PrivateEndpointConnectionOperationPredicate) Matches ¶
func (p PrivateEndpointConnectionOperationPredicate) Matches(input PrivateEndpointConnection) bool
type PrivateEndpointConnectionProperties ¶
type PrivateEndpointConnectionProperties struct { GroupIds *[]string `json:"groupIds,omitempty"` PrivateEndpoint *PrivateEndpointProperty `json:"privateEndpoint,omitempty"` PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionStateProperty `json:"privateLinkServiceConnectionState,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` }
type PrivateEndpointConnectionsClient ¶
type PrivateEndpointConnectionsClient struct {
Client *resourcemanager.Client
}
func NewPrivateEndpointConnectionsClientWithBaseURI ¶
func NewPrivateEndpointConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionsClient, error)
func (PrivateEndpointConnectionsClient) CreateOrUpdate ¶
func (c PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (PrivateEndpointConnectionsClient) CreateOrUpdateThenPoll ¶
func (c PrivateEndpointConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (PrivateEndpointConnectionsClient) Delete ¶
func (c PrivateEndpointConnectionsClient) Delete(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
Delete ...
func (PrivateEndpointConnectionsClient) DeleteThenPoll ¶
func (c PrivateEndpointConnectionsClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
DeleteThenPoll performs Delete then polls until it's completed
func (PrivateEndpointConnectionsClient) Get ¶
func (c PrivateEndpointConnectionsClient) Get(ctx context.Context, id PrivateEndpointConnectionId) (result GetOperationResponse, err error)
Get ...
func (PrivateEndpointConnectionsClient) ListByPrivateLinkScope ¶
func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScope(ctx context.Context, id ProviderPrivateLinkScopeId) (result ListByPrivateLinkScopeOperationResponse, err error)
ListByPrivateLinkScope ...
func (PrivateEndpointConnectionsClient) ListByPrivateLinkScopeComplete ¶
func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScopeComplete(ctx context.Context, id ProviderPrivateLinkScopeId) (ListByPrivateLinkScopeCompleteResult, error)
ListByPrivateLinkScopeComplete retrieves all the results into a single object
func (PrivateEndpointConnectionsClient) ListByPrivateLinkScopeCompleteMatchingPredicate ¶
func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScopeCompleteMatchingPredicate(ctx context.Context, id ProviderPrivateLinkScopeId, predicate PrivateEndpointConnectionOperationPredicate) (result ListByPrivateLinkScopeCompleteResult, err error)
ListByPrivateLinkScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate
type PrivateEndpointProperty ¶
type PrivateEndpointProperty struct {
Id *string `json:"id,omitempty"`
}
type ProviderPrivateLinkScopeId ¶
type ProviderPrivateLinkScopeId struct { SubscriptionId string ResourceGroupName string PrivateLinkScopeName string }
ProviderPrivateLinkScopeId is a struct representing the Resource ID for a Provider Private Link Scope
func NewProviderPrivateLinkScopeID ¶
func NewProviderPrivateLinkScopeID(subscriptionId string, resourceGroupName string, privateLinkScopeName string) ProviderPrivateLinkScopeId
NewProviderPrivateLinkScopeID returns a new ProviderPrivateLinkScopeId struct
func ParseProviderPrivateLinkScopeID ¶
func ParseProviderPrivateLinkScopeID(input string) (*ProviderPrivateLinkScopeId, error)
ParseProviderPrivateLinkScopeID parses 'input' into a ProviderPrivateLinkScopeId
func ParseProviderPrivateLinkScopeIDInsensitively ¶
func ParseProviderPrivateLinkScopeIDInsensitively(input string) (*ProviderPrivateLinkScopeId, error)
ParseProviderPrivateLinkScopeIDInsensitively parses 'input' case-insensitively into a ProviderPrivateLinkScopeId note: this method should only be used for API response data and not user input
func (ProviderPrivateLinkScopeId) ID ¶
func (id ProviderPrivateLinkScopeId) ID() string
ID returns the formatted Provider Private Link Scope ID
func (ProviderPrivateLinkScopeId) Segments ¶
func (id ProviderPrivateLinkScopeId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Provider Private Link Scope ID
func (ProviderPrivateLinkScopeId) String ¶
func (id ProviderPrivateLinkScopeId) String() string
String returns a human-readable description of this Provider Private Link Scope ID
Source Files ¶
- client.go
- id_privateendpointconnection.go
- id_providerprivatelinkscope.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_listbyprivatelinkscope.go
- model_privateendpointconnection.go
- model_privateendpointconnectionproperties.go
- model_privateendpointproperty.go
- model_privatelinkserviceconnectionstateproperty.go
- predicates.go
- version.go