README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/azureactivedirectory/2020-03-01/privateendpointconnections
Documentation
The privateendpointconnections
SDK allows for interaction with the Azure Resource Manager Service azureactivedirectory
(API Version 2020-03-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/azureactivedirectory/2020-03-01/privateendpointconnections"
Client Initialization
client := privateendpointconnections.NewPrivateEndpointConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateEndpointConnectionsClient.Create
ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkForAzureAdValue", "privateEndpointConnectionValue")
payload := privateendpointconnections.PrivateEndpointConnection{
// ...
}
if err := client.CreateThenPoll(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", "privateLinkForAzureAdValue", "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", "privateLinkForAzureAdValue", "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.ListByPolicyName
ctx := context.TODO()
id := privateendpointconnections.NewPrivateLinkForAzureAdID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkForAzureAdValue")
// alternatively `client.ListByPolicyName(ctx, id)` can be used to do batched pagination
items, err := client.ListByPolicyNameComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string
- func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string
- func ValidatePrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePrivateLinkForAzureAdID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByPolicyNameCompleteResult
- type ListByPolicyNameOperationResponse
- type PrivateEndpoint
- type PrivateEndpointConnection
- type PrivateEndpointConnectionId
- func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, ...) PrivateEndpointConnectionId
- func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)
- func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)
- type PrivateEndpointConnectionOperationPredicate
- type PrivateEndpointConnectionProperties
- type PrivateEndpointConnectionProvisioningState
- type PrivateEndpointConnectionsClient
- func (c PrivateEndpointConnectionsClient) Create(ctx context.Context, id PrivateEndpointConnectionId, ...) (result CreateOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) CreateThenPoll(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) ListByPolicyName(ctx context.Context, id PrivateLinkForAzureAdId) (result ListByPolicyNameOperationResponse, err error)
- func (c PrivateEndpointConnectionsClient) ListByPolicyNameComplete(ctx context.Context, id PrivateLinkForAzureAdId) (ListByPolicyNameCompleteResult, error)
- func (c PrivateEndpointConnectionsClient) ListByPolicyNameCompleteMatchingPredicate(ctx context.Context, id PrivateLinkForAzureAdId, ...) (result ListByPolicyNameCompleteResult, err error)
- type PrivateEndpointServiceConnectionStatus
- type PrivateLinkForAzureAdId
- type PrivateLinkServiceConnectionState
- type TagsResource
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 ValidatePrivateLinkForAzureAdID ¶
func ValidatePrivateLinkForAzureAdID(input interface{}, key string) (warnings []string, errors []error)
ValidatePrivateLinkForAzureAdID checks that 'input' can be parsed as a Private Link For Azure Ad ID
Types ¶
type CreateOperationResponse ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateEndpointConnection }
type ListByPolicyNameCompleteResult ¶
type ListByPolicyNameCompleteResult struct { LatestHttpResponse *http.Response Items []PrivateEndpointConnection }
type ListByPolicyNameOperationResponse ¶
type ListByPolicyNameOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]PrivateEndpointConnection }
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 PrivateEndpointConnectionId ¶
type PrivateEndpointConnectionId struct { SubscriptionId string ResourceGroupName string PrivateLinkForAzureAdName string PrivateEndpointConnectionName string }
PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection
func NewPrivateEndpointConnectionID ¶
func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, privateLinkForAzureAdName 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 PrivateEndpointConnectionOperationPredicate ¶
func (PrivateEndpointConnectionOperationPredicate) Matches ¶
func (p PrivateEndpointConnectionOperationPredicate) Matches(input PrivateEndpointConnection) bool
type PrivateEndpointConnectionProperties ¶
type PrivateEndpointConnectionProperties struct { PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"` PrivateLinkConnectionTags *TagsResource `json:"privateLinkConnectionTags,omitempty"` PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"` ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"` }
type PrivateEndpointConnectionProvisioningState ¶
type PrivateEndpointConnectionProvisioningState string
const ( PrivateEndpointConnectionProvisioningStateFailed PrivateEndpointConnectionProvisioningState = "Failed" PrivateEndpointConnectionProvisioningStateProvisioning PrivateEndpointConnectionProvisioningState = "Provisioning" PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded" )
func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON ¶
func (s *PrivateEndpointConnectionProvisioningState) UnmarshalJSON(bytes []byte) error
type PrivateEndpointConnectionsClient ¶
type PrivateEndpointConnectionsClient struct {
Client *resourcemanager.Client
}
func NewPrivateEndpointConnectionsClientWithBaseURI ¶
func NewPrivateEndpointConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionsClient, error)
func (PrivateEndpointConnectionsClient) Create ¶
func (c PrivateEndpointConnectionsClient) Create(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result CreateOperationResponse, err error)
Create ...
func (PrivateEndpointConnectionsClient) CreateThenPoll ¶
func (c PrivateEndpointConnectionsClient) CreateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error
CreateThenPoll performs Create 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) ListByPolicyName ¶
func (c PrivateEndpointConnectionsClient) ListByPolicyName(ctx context.Context, id PrivateLinkForAzureAdId) (result ListByPolicyNameOperationResponse, err error)
ListByPolicyName ...
func (PrivateEndpointConnectionsClient) ListByPolicyNameComplete ¶
func (c PrivateEndpointConnectionsClient) ListByPolicyNameComplete(ctx context.Context, id PrivateLinkForAzureAdId) (ListByPolicyNameCompleteResult, error)
ListByPolicyNameComplete retrieves all the results into a single object
func (PrivateEndpointConnectionsClient) ListByPolicyNameCompleteMatchingPredicate ¶
func (c PrivateEndpointConnectionsClient) ListByPolicyNameCompleteMatchingPredicate(ctx context.Context, id PrivateLinkForAzureAdId, predicate PrivateEndpointConnectionOperationPredicate) (result ListByPolicyNameCompleteResult, err error)
ListByPolicyNameCompleteMatchingPredicate retrieves all the results and then applies the predicate
type PrivateEndpointServiceConnectionStatus ¶
type PrivateEndpointServiceConnectionStatus string
const ( PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved" PrivateEndpointServiceConnectionStatusDisconnected PrivateEndpointServiceConnectionStatus = "Disconnected" PrivateEndpointServiceConnectionStatusPending PrivateEndpointServiceConnectionStatus = "Pending" PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected" )
func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON ¶
func (s *PrivateEndpointServiceConnectionStatus) UnmarshalJSON(bytes []byte) error
type PrivateLinkForAzureAdId ¶
type PrivateLinkForAzureAdId struct { SubscriptionId string ResourceGroupName string PrivateLinkForAzureAdName string }
PrivateLinkForAzureAdId is a struct representing the Resource ID for a Private Link For Azure Ad
func NewPrivateLinkForAzureAdID ¶
func NewPrivateLinkForAzureAdID(subscriptionId string, resourceGroupName string, privateLinkForAzureAdName string) PrivateLinkForAzureAdId
NewPrivateLinkForAzureAdID returns a new PrivateLinkForAzureAdId struct
func ParsePrivateLinkForAzureAdID ¶
func ParsePrivateLinkForAzureAdID(input string) (*PrivateLinkForAzureAdId, error)
ParsePrivateLinkForAzureAdID parses 'input' into a PrivateLinkForAzureAdId
func ParsePrivateLinkForAzureAdIDInsensitively ¶
func ParsePrivateLinkForAzureAdIDInsensitively(input string) (*PrivateLinkForAzureAdId, error)
ParsePrivateLinkForAzureAdIDInsensitively parses 'input' case-insensitively into a PrivateLinkForAzureAdId note: this method should only be used for API response data and not user input
func (*PrivateLinkForAzureAdId) FromParseResult ¶
func (id *PrivateLinkForAzureAdId) FromParseResult(input resourceids.ParseResult) error
func (PrivateLinkForAzureAdId) ID ¶
func (id PrivateLinkForAzureAdId) ID() string
ID returns the formatted Private Link For Azure Ad ID
func (PrivateLinkForAzureAdId) Segments ¶
func (id PrivateLinkForAzureAdId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Private Link For Azure Ad ID
func (PrivateLinkForAzureAdId) String ¶
func (id PrivateLinkForAzureAdId) String() string
String returns a human-readable description of this Private Link For Azure Ad ID
type PrivateLinkServiceConnectionState ¶
type PrivateLinkServiceConnectionState struct { ActionsRequired *string `json:"actionsRequired,omitempty"` Description *string `json:"description,omitempty"` Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"` }
type TagsResource ¶
Source Files ¶
- client.go
- constants.go
- id_privateendpointconnection.go
- id_privatelinkforazuread.go
- method_create.go
- method_delete.go
- method_get.go
- method_listbypolicyname.go
- model_privateendpoint.go
- model_privateendpointconnection.go
- model_privateendpointconnectionproperties.go
- model_privatelinkserviceconnectionstate.go
- model_tagsresource.go
- predicates.go
- version.go