README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/keyvault/2021-10-01/privateendpointconnections
Documentation
The privateendpointconnections
SDK allows for interaction with the Azure Resource Manager Service keyvault
(API Version 2021-10-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/keyvault/2021-10-01/privateendpointconnections"
Client Initialization
client := privateendpointconnections.NewPrivateEndpointConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateEndpointConnectionsClient.Delete
ctx := context.TODO()
id := privateendpointconnections.NewKeyVaultPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "privateEndpointConnectionValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionsClient.Get
ctx := context.TODO()
id := privateendpointconnections.NewKeyVaultPrivateEndpointConnectionID("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: PrivateEndpointConnectionsClient.ListByResource
ctx := context.TODO()
id := privateendpointconnections.NewKeyVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")
// alternatively `client.ListByResource(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: PrivateEndpointConnectionsClient.Put
ctx := context.TODO()
id := privateendpointconnections.NewKeyVaultPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "privateEndpointConnectionValue")
payload := privateendpointconnections.PrivateEndpointConnection{
// ...
}
read, err := client.Put(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForActionsRequired() []string
- func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string
- func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string
- type ActionsRequired
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByResourceCompleteResult
- type ListByResourceOperationResponse
- type PrivateEndpoint
- type PrivateEndpointConnection
- type PrivateEndpointConnectionOperationPredicate
- type PrivateEndpointConnectionProperties
- type PrivateEndpointConnectionProvisioningState
- type PrivateEndpointConnectionsClient
- func (c PrivateEndpointConnectionsClient) Delete(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) DeleteThenPoll(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId) error
- func (c PrivateEndpointConnectionsClient) Get(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId) (result GetOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) ListByResource(ctx context.Context, id commonids.KeyVaultId) (resp ListByResourceOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) ListByResourceComplete(ctx context.Context, id commonids.KeyVaultId) (ListByResourceCompleteResult, error)
- func (c PrivateEndpointConnectionsClient) ListByResourceCompleteMatchingPredicate(ctx context.Context, id commonids.KeyVaultId, ...) (resp ListByResourceCompleteResult, err error)
- func (c PrivateEndpointConnectionsClient) Put(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId, ...) (result PutOperationResponse, err error)
- type PrivateEndpointServiceConnectionStatus
- type PrivateLinkServiceConnectionState
- type PutOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForActionsRequired ¶
func PossibleValuesForActionsRequired() []string
func PossibleValuesForPrivateEndpointConnectionProvisioningState ¶
func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string
func PossibleValuesForPrivateEndpointServiceConnectionStatus ¶
func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string
Types ¶
type ActionsRequired ¶
type ActionsRequired string
const (
ActionsRequiredNone ActionsRequired = "None"
)
type DeleteOperationResponse ¶
type DeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *PrivateEndpointConnection }
type ListByResourceCompleteResult ¶
type ListByResourceCompleteResult struct {
Items []PrivateEndpointConnection
}
type ListByResourceOperationResponse ¶
type ListByResourceOperationResponse struct { HttpResponse *http.Response Model *[]PrivateEndpointConnection // contains filtered or unexported fields }
func (ListByResourceOperationResponse) HasMore ¶
func (r ListByResourceOperationResponse) HasMore() bool
func (ListByResourceOperationResponse) LoadMore ¶
func (r ListByResourceOperationResponse) LoadMore(ctx context.Context) (resp ListByResourceOperationResponse, err error)
type PrivateEndpoint ¶
type PrivateEndpoint struct {
Id *string `json:"id,omitempty"`
}
type PrivateEndpointConnection ¶
type PrivateEndpointConnection struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type PrivateEndpointConnectionOperationPredicate ¶
type PrivateEndpointConnectionOperationPredicate struct { Etag *string Id *string Location *string Name *string Type *string }
func (PrivateEndpointConnectionOperationPredicate) Matches ¶
func (p PrivateEndpointConnectionOperationPredicate) Matches(input PrivateEndpointConnection) bool
type PrivateEndpointConnectionProperties ¶
type PrivateEndpointConnectionProperties struct { PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"` PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"` ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"` }
type PrivateEndpointConnectionProvisioningState ¶
type PrivateEndpointConnectionProvisioningState string
const ( PrivateEndpointConnectionProvisioningStateCreating PrivateEndpointConnectionProvisioningState = "Creating" PrivateEndpointConnectionProvisioningStateDeleting PrivateEndpointConnectionProvisioningState = "Deleting" PrivateEndpointConnectionProvisioningStateDisconnected PrivateEndpointConnectionProvisioningState = "Disconnected" PrivateEndpointConnectionProvisioningStateFailed PrivateEndpointConnectionProvisioningState = "Failed" PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded" PrivateEndpointConnectionProvisioningStateUpdating PrivateEndpointConnectionProvisioningState = "Updating" )
type PrivateEndpointConnectionsClient ¶
type PrivateEndpointConnectionsClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewPrivateEndpointConnectionsClientWithBaseURI ¶
func NewPrivateEndpointConnectionsClientWithBaseURI(endpoint string) PrivateEndpointConnectionsClient
func (PrivateEndpointConnectionsClient) Delete ¶
func (c PrivateEndpointConnectionsClient) Delete(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
Delete ...
func (PrivateEndpointConnectionsClient) DeleteThenPoll ¶
func (c PrivateEndpointConnectionsClient) DeleteThenPoll(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId) error
DeleteThenPoll performs Delete then polls until it's completed
func (PrivateEndpointConnectionsClient) Get ¶
func (c PrivateEndpointConnectionsClient) Get(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId) (result GetOperationResponse, err error)
Get ...
func (PrivateEndpointConnectionsClient) ListByResource ¶
func (c PrivateEndpointConnectionsClient) ListByResource(ctx context.Context, id commonids.KeyVaultId) (resp ListByResourceOperationResponse, err error)
ListByResource ...
func (PrivateEndpointConnectionsClient) ListByResourceComplete ¶
func (c PrivateEndpointConnectionsClient) ListByResourceComplete(ctx context.Context, id commonids.KeyVaultId) (ListByResourceCompleteResult, error)
ListByResourceComplete retrieves all of the results into a single object
func (PrivateEndpointConnectionsClient) ListByResourceCompleteMatchingPredicate ¶
func (c PrivateEndpointConnectionsClient) ListByResourceCompleteMatchingPredicate(ctx context.Context, id commonids.KeyVaultId, predicate PrivateEndpointConnectionOperationPredicate) (resp ListByResourceCompleteResult, err error)
ListByResourceCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (PrivateEndpointConnectionsClient) Put ¶
func (c PrivateEndpointConnectionsClient) Put(ctx context.Context, id commonids.KeyVaultPrivateEndpointConnectionId, input PrivateEndpointConnection) (result PutOperationResponse, err error)
Put ...
type PrivateEndpointServiceConnectionStatus ¶
type PrivateEndpointServiceConnectionStatus string
const ( PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved" PrivateEndpointServiceConnectionStatusDisconnected PrivateEndpointServiceConnectionStatus = "Disconnected" PrivateEndpointServiceConnectionStatusPending PrivateEndpointServiceConnectionStatus = "Pending" PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected" )
type PrivateLinkServiceConnectionState ¶
type PrivateLinkServiceConnectionState struct { ActionsRequired *ActionsRequired `json:"actionsRequired,omitempty"` Description *string `json:"description,omitempty"` Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"` }
type PutOperationResponse ¶
type PutOperationResponse struct { HttpResponse *http.Response Model *PrivateEndpointConnection }
Source Files ¶
- client.go
- constants.go
- method_delete_autorest.go
- method_get_autorest.go
- method_listbyresource_autorest.go
- method_put_autorest.go
- model_privateendpoint.go
- model_privateendpointconnection.go
- model_privateendpointconnectionproperties.go
- model_privatelinkserviceconnectionstate.go
- predicates.go
- version.go
Click to show internal directories.
Click to hide internal directories.