README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/dashboard/2023-09-01/privateendpointconnection
Documentation
The privateendpointconnection
SDK allows for interaction with the Azure Resource Manager Service dashboard
(API Version 2023-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/dashboard/2023-09-01/privateendpointconnection"
Client Initialization
client := privateendpointconnection.NewPrivateEndpointConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateEndpointConnectionClient.Approve
ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue", "privateEndpointConnectionValue")
payload := privateendpointconnection.PrivateEndpointConnection{
// ...
}
if err := client.ApproveThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionClient.Delete
ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue", "privateEndpointConnectionValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PrivateEndpointConnectionClient.Get
ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue", "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: PrivateEndpointConnectionClient.List
ctx := context.TODO()
id := privateendpointconnection.NewGrafanaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string
- func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string
- func ValidateGrafanaID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)
- type ApproveOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type GrafanaId
- type ListCompleteResult
- type ListCustomPager
- type ListOperationResponse
- type PrivateEndpoint
- type PrivateEndpointConnection
- type PrivateEndpointConnectionClient
- func (c PrivateEndpointConnectionClient) Approve(ctx context.Context, id PrivateEndpointConnectionId, ...) (result ApproveOperationResponse, err error)
- func (c PrivateEndpointConnectionClient) ApproveThenPoll(ctx context.Context, id PrivateEndpointConnectionId, ...) error
- func (c PrivateEndpointConnectionClient) Delete(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
- func (c PrivateEndpointConnectionClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
- func (c PrivateEndpointConnectionClient) Get(ctx context.Context, id PrivateEndpointConnectionId) (result GetOperationResponse, err error)
- func (c PrivateEndpointConnectionClient) List(ctx context.Context, id GrafanaId) (result ListOperationResponse, err error)
- func (c PrivateEndpointConnectionClient) ListComplete(ctx context.Context, id GrafanaId) (ListCompleteResult, error)
- func (c PrivateEndpointConnectionClient) ListCompleteMatchingPredicate(ctx context.Context, id GrafanaId, ...) (result ListCompleteResult, err error)
- type PrivateEndpointConnectionId
- func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, grafanaName string, ...) PrivateEndpointConnectionId
- func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)
- func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)
- type PrivateEndpointConnectionOperationPredicate
- type PrivateEndpointConnectionProperties
- type PrivateEndpointConnectionProvisioningState
- type PrivateEndpointServiceConnectionStatus
- type PrivateLinkServiceConnectionState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPrivateEndpointConnectionProvisioningState ¶
func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string
func PossibleValuesForPrivateEndpointServiceConnectionStatus ¶
func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string
func ValidateGrafanaID ¶
ValidateGrafanaID checks that 'input' can be parsed as a Grafana ID
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
Types ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateEndpointConnection }
type GrafanaId ¶
GrafanaId is a struct representing the Resource ID for a Grafana
func NewGrafanaID ¶
NewGrafanaID returns a new GrafanaId struct
func ParseGrafanaID ¶
ParseGrafanaID parses 'input' into a GrafanaId
func ParseGrafanaIDInsensitively ¶
ParseGrafanaIDInsensitively parses 'input' case-insensitively into a GrafanaId note: this method should only be used for API response data and not user input
func (*GrafanaId) FromParseResult ¶
func (id *GrafanaId) FromParseResult(input resourceids.ParseResult) error
func (GrafanaId) Segments ¶
func (id GrafanaId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Grafana ID
type ListCompleteResult ¶
type ListCompleteResult struct { LatestHttpResponse *http.Response Items []PrivateEndpointConnection }
type ListCustomPager ¶ added in v0.20240628.1153531
func (*ListCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListCustomPager) NextPageLink() *odata.Link
type ListOperationResponse ¶
type ListOperationResponse 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"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type PrivateEndpointConnectionClient ¶
type PrivateEndpointConnectionClient struct {
Client *resourcemanager.Client
}
func NewPrivateEndpointConnectionClientWithBaseURI ¶
func NewPrivateEndpointConnectionClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionClient, error)
func (PrivateEndpointConnectionClient) Approve ¶
func (c PrivateEndpointConnectionClient) Approve(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result ApproveOperationResponse, err error)
Approve ...
func (PrivateEndpointConnectionClient) ApproveThenPoll ¶
func (c PrivateEndpointConnectionClient) ApproveThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error
ApproveThenPoll performs Approve then polls until it's completed
func (PrivateEndpointConnectionClient) Delete ¶
func (c PrivateEndpointConnectionClient) Delete(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteOperationResponse, err error)
Delete ...
func (PrivateEndpointConnectionClient) DeleteThenPoll ¶
func (c PrivateEndpointConnectionClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error
DeleteThenPoll performs Delete then polls until it's completed
func (PrivateEndpointConnectionClient) Get ¶
func (c PrivateEndpointConnectionClient) Get(ctx context.Context, id PrivateEndpointConnectionId) (result GetOperationResponse, err error)
Get ...
func (PrivateEndpointConnectionClient) List ¶
func (c PrivateEndpointConnectionClient) List(ctx context.Context, id GrafanaId) (result ListOperationResponse, err error)
List ...
func (PrivateEndpointConnectionClient) ListComplete ¶
func (c PrivateEndpointConnectionClient) ListComplete(ctx context.Context, id GrafanaId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (PrivateEndpointConnectionClient) ListCompleteMatchingPredicate ¶
func (c PrivateEndpointConnectionClient) ListCompleteMatchingPredicate(ctx context.Context, id GrafanaId, predicate PrivateEndpointConnectionOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
type PrivateEndpointConnectionId ¶
type PrivateEndpointConnectionId struct { SubscriptionId string ResourceGroupName string GrafanaName string PrivateEndpointConnectionName string }
PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection
func NewPrivateEndpointConnectionID ¶
func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, grafanaName 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 { 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 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"` }
Source Files ¶
- client.go
- constants.go
- id_grafana.go
- id_privateendpointconnection.go
- method_approve.go
- method_delete.go
- method_get.go
- method_list.go
- model_privateendpoint.go
- model_privateendpointconnection.go
- model_privateendpointconnectionproperties.go
- model_privatelinkserviceconnectionstate.go
- predicates.go
- version.go