privateendpointconnections

package
v0.20240731.1170959 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/privateendpointconnections Documentation

The privateendpointconnections SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-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/synapse/2021-06-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", "workspaceValue", "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", "workspaceValue", "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", "workspaceValue", "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.List

ctx := context.TODO()
id := privateendpointconnections.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")

// 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
}

Example Usage: PrivateEndpointConnectionsClient.PrivateLinkHubGet

ctx := context.TODO()
id := privateendpointconnections.NewPrivateLinkHubPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkHubValue", "privateEndpointConnectionValue")

read, err := client.PrivateLinkHubGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PrivateEndpointConnectionsClient.PrivateLinkHubList

ctx := context.TODO()
id := privateendpointconnections.NewPrivateLinkHubID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkHubValue")

// alternatively `client.PrivateLinkHubList(ctx, id)` can be used to do batched pagination
items, err := client.PrivateLinkHubListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForOperationStatus 

func PossibleValuesForOperationStatus() []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 ValidatePrivateLinkHubID 

func ValidatePrivateLinkHubID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateLinkHubID checks that 'input' can be parsed as a Private Link Hub ID

func ValidatePrivateLinkHubPrivateEndpointConnectionID 

func ValidatePrivateLinkHubPrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateLinkHubPrivateEndpointConnectionID checks that 'input' can be parsed as a Private Link Hub Private Endpoint Connection ID

func ValidateWorkspaceID 

func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationResource
}

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDetail 

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateEndpointConnection
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnection
}

type OperationResource 

type OperationResource struct {
	EndTime         *string          `json:"endTime,omitempty"`
	Error           *ErrorDetail     `json:"error,omitempty"`
	Id              *string          `json:"id,omitempty"`
	Name            *string          `json:"name,omitempty"`
	PercentComplete *float64         `json:"percentComplete,omitempty"`
	Properties      *interface{}     `json:"properties,omitempty"`
	StartTime       *string          `json:"startTime,omitempty"`
	Status          *OperationStatus `json:"status,omitempty"`
}

func (*OperationResource) GetEndTimeAsTime 

func (o *OperationResource) GetEndTimeAsTime() (*time.Time, error)

func (*OperationResource) GetStartTimeAsTime 

func (o *OperationResource) GetStartTimeAsTime() (*time.Time, error)

func (*OperationResource) SetEndTimeAsTime 

func (o *OperationResource) SetEndTimeAsTime(input time.Time)

func (*OperationResource) SetStartTimeAsTime 

func (o *OperationResource) SetStartTimeAsTime(input time.Time)

type OperationStatus 

type OperationStatus string
const (
	OperationStatusCanceled   OperationStatus = "Canceled"
	OperationStatusFailed     OperationStatus = "Failed"
	OperationStatusInProgress OperationStatus = "InProgress"
	OperationStatusSucceeded  OperationStatus = "Succeeded"
)

func (*OperationStatus) UnmarshalJSON 

func (s *OperationStatus) UnmarshalJSON(bytes []byte) error

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 PrivateEndpointConnectionForPrivateLinkHub 

type PrivateEndpointConnectionForPrivateLinkHub struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionForPrivateLinkHubOperationPredicate 

type PrivateEndpointConnectionForPrivateLinkHubOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PrivateEndpointConnectionForPrivateLinkHubOperationPredicate) Matches 

func (p PrivateEndpointConnectionForPrivateLinkHubOperationPredicate) Matches(input PrivateEndpointConnectionForPrivateLinkHub) bool

type PrivateEndpointConnectionId 

type PrivateEndpointConnectionId struct {
	SubscriptionId                string
	ResourceGroupName             string
	WorkspaceName                 string
	PrivateEndpointConnectionName string
}

PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, workspaceName 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 

type PrivateEndpointConnectionOperationPredicate struct {
	Id   *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                 *string                            `json:"provisioningState,omitempty"`
}

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) List 

func (c PrivateEndpointConnectionsClient) List(ctx context.Context, id WorkspaceId) (result ListOperationResponse, err error)

List ...

func (PrivateEndpointConnectionsClient) ListComplete 

func (c PrivateEndpointConnectionsClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PrivateEndpointConnectionsClient) ListCompleteMatchingPredicate 

func (c PrivateEndpointConnectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate PrivateEndpointConnectionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateEndpointConnectionsClient) PrivateLinkHubGet 

func (c PrivateEndpointConnectionsClient) PrivateLinkHubGet(ctx context.Context, id PrivateLinkHubPrivateEndpointConnectionId) (result PrivateLinkHubGetOperationResponse, err error)

PrivateLinkHubGet ...

func (PrivateEndpointConnectionsClient) PrivateLinkHubList 

func (c PrivateEndpointConnectionsClient) PrivateLinkHubList(ctx context.Context, id PrivateLinkHubId) (result PrivateLinkHubListOperationResponse, err error)

PrivateLinkHubList ...

func (PrivateEndpointConnectionsClient) PrivateLinkHubListComplete 

func (c PrivateEndpointConnectionsClient) PrivateLinkHubListComplete(ctx context.Context, id PrivateLinkHubId) (PrivateLinkHubListCompleteResult, error)

PrivateLinkHubListComplete retrieves all the results into a single object

func (PrivateEndpointConnectionsClient) PrivateLinkHubListCompleteMatchingPredicate 

func (c PrivateEndpointConnectionsClient) PrivateLinkHubListCompleteMatchingPredicate(ctx context.Context, id PrivateLinkHubId, predicate PrivateEndpointConnectionForPrivateLinkHubOperationPredicate) (result PrivateLinkHubListCompleteResult, err error)

PrivateLinkHubListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PrivateLinkHubGetOperationResponse 

type PrivateLinkHubGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnectionForPrivateLinkHub
}

type PrivateLinkHubId 

type PrivateLinkHubId struct {
	SubscriptionId     string
	ResourceGroupName  string
	PrivateLinkHubName string
}

PrivateLinkHubId is a struct representing the Resource ID for a Private Link Hub

func NewPrivateLinkHubID 

func NewPrivateLinkHubID(subscriptionId string, resourceGroupName string, privateLinkHubName string) PrivateLinkHubId

NewPrivateLinkHubID returns a new PrivateLinkHubId struct

func ParsePrivateLinkHubID 

func ParsePrivateLinkHubID(input string) (*PrivateLinkHubId, error)

ParsePrivateLinkHubID parses 'input' into a PrivateLinkHubId

func ParsePrivateLinkHubIDInsensitively 

func ParsePrivateLinkHubIDInsensitively(input string) (*PrivateLinkHubId, error)

ParsePrivateLinkHubIDInsensitively parses 'input' case-insensitively into a PrivateLinkHubId note: this method should only be used for API response data and not user input

func (*PrivateLinkHubId) FromParseResult 

func (id *PrivateLinkHubId) FromParseResult(input resourceids.ParseResult) error

func (PrivateLinkHubId) ID 

func (id PrivateLinkHubId) ID() string

ID returns the formatted Private Link Hub ID

func (PrivateLinkHubId) Segments 

func (id PrivateLinkHubId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Link Hub ID

func (PrivateLinkHubId) String 

func (id PrivateLinkHubId) String() string

String returns a human-readable description of this Private Link Hub ID

type PrivateLinkHubListCompleteResult 

type PrivateLinkHubListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateEndpointConnectionForPrivateLinkHub
}

type PrivateLinkHubListCustomPager added in v0.20240628.1153531 

type PrivateLinkHubListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *PrivateLinkHubListCustomPager) NextPageLink() *odata.Link

type PrivateLinkHubListOperationResponse 

type PrivateLinkHubListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnectionForPrivateLinkHub
}

type PrivateLinkHubPrivateEndpointConnectionId 

type PrivateLinkHubPrivateEndpointConnectionId struct {
	SubscriptionId                string
	ResourceGroupName             string
	PrivateLinkHubName            string
	PrivateEndpointConnectionName string
}

PrivateLinkHubPrivateEndpointConnectionId is a struct representing the Resource ID for a Private Link Hub Private Endpoint Connection

func NewPrivateLinkHubPrivateEndpointConnectionID 

func NewPrivateLinkHubPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, privateLinkHubName string, privateEndpointConnectionName string) PrivateLinkHubPrivateEndpointConnectionId

NewPrivateLinkHubPrivateEndpointConnectionID returns a new PrivateLinkHubPrivateEndpointConnectionId struct

func ParsePrivateLinkHubPrivateEndpointConnectionID 

func ParsePrivateLinkHubPrivateEndpointConnectionID(input string) (*PrivateLinkHubPrivateEndpointConnectionId, error)

ParsePrivateLinkHubPrivateEndpointConnectionID parses 'input' into a PrivateLinkHubPrivateEndpointConnectionId

func ParsePrivateLinkHubPrivateEndpointConnectionIDInsensitively 

func ParsePrivateLinkHubPrivateEndpointConnectionIDInsensitively(input string) (*PrivateLinkHubPrivateEndpointConnectionId, error)

ParsePrivateLinkHubPrivateEndpointConnectionIDInsensitively parses 'input' case-insensitively into a PrivateLinkHubPrivateEndpointConnectionId note: this method should only be used for API response data and not user input

func (*PrivateLinkHubPrivateEndpointConnectionId) FromParseResult 

func (id *PrivateLinkHubPrivateEndpointConnectionId) FromParseResult(input resourceids.ParseResult) error

func (PrivateLinkHubPrivateEndpointConnectionId) ID 

func (id PrivateLinkHubPrivateEndpointConnectionId) ID() string

ID returns the formatted Private Link Hub Private Endpoint Connection ID

func (PrivateLinkHubPrivateEndpointConnectionId) Segments 

func (id PrivateLinkHubPrivateEndpointConnectionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Link Hub Private Endpoint Connection ID

func (PrivateLinkHubPrivateEndpointConnectionId) String 

func (id PrivateLinkHubPrivateEndpointConnectionId) String() string

String returns a human-readable description of this Private Link Hub Private Endpoint Connection ID

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string `json:"actionsRequired,omitempty"`
	Description     *string `json:"description,omitempty"`
	Status          *string `json:"status,omitempty"`
}

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input

func (*WorkspaceId) FromParseResult 

func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

func (id WorkspaceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.