privateendpointconnection

package
v0.20241128.1112539 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/migrate/2020-07-07/privateendpointconnection Documentation

The privateendpointconnection SDK allows for interaction with Azure Resource Manager migrate (API Version 2020-07-07).

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/migrate/2020-07-07/privateendpointconnection"

Client Initialization

client := privateendpointconnection.NewPrivateEndpointConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateEndpointConnectionClient.DeletePrivateEndpointConnection

ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "masterSiteName", "privateEndpointConnectionName")

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

Example Usage: PrivateEndpointConnectionClient.GetPrivateEndpointConnection

ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "masterSiteName", "privateEndpointConnectionName")

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

Example Usage: PrivateEndpointConnectionClient.GetPrivateEndpointConnections

ctx := context.TODO()
id := privateendpointconnection.NewMasterSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "masterSiteName")

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

Example Usage: PrivateEndpointConnectionClient.PutPrivateEndpointConnection

ctx := context.TODO()
id := privateendpointconnection.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "masterSiteName", "privateEndpointConnectionName")

payload := privateendpointconnection.PrivateEndpointConnection{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func ValidateMasterSiteID 

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

ValidateMasterSiteID checks that 'input' can be parsed as a Master Site 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 DeletePrivateEndpointConnectionOperationResponse 

type DeletePrivateEndpointConnectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetPrivateEndpointConnectionOperationResponse 

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

type GetPrivateEndpointConnectionsCompleteResult added in v0.20240226.1173038 

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

type GetPrivateEndpointConnectionsCustomPager added in v0.20240628.1153531 

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

type GetPrivateEndpointConnectionsOperationResponse 

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

type MasterSiteId 

type MasterSiteId struct {
	SubscriptionId    string
	ResourceGroupName string
	MasterSiteName    string
}

MasterSiteId is a struct representing the Resource ID for a Master Site

func NewMasterSiteID 

func NewMasterSiteID(subscriptionId string, resourceGroupName string, masterSiteName string) MasterSiteId

NewMasterSiteID returns a new MasterSiteId struct

func ParseMasterSiteID 

func ParseMasterSiteID(input string) (*MasterSiteId, error)

ParseMasterSiteID parses 'input' into a MasterSiteId

func ParseMasterSiteIDInsensitively 

func ParseMasterSiteIDInsensitively(input string) (*MasterSiteId, error)

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

func (*MasterSiteId) FromParseResult 

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

func (MasterSiteId) ID 

func (id MasterSiteId) ID() string

ID returns the formatted Master Site ID

func (MasterSiteId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Master Site ID

func (MasterSiteId) String 

func (id MasterSiteId) String() string

String returns a human-readable description of this Master Site ID

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	ETag       *string                              `json:"eTag,omitempty"`
	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) DeletePrivateEndpointConnection 

func (c PrivateEndpointConnectionClient) DeletePrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId) (result DeletePrivateEndpointConnectionOperationResponse, err error)

DeletePrivateEndpointConnection ...

func (PrivateEndpointConnectionClient) GetPrivateEndpointConnection 

func (c PrivateEndpointConnectionClient) GetPrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId) (result GetPrivateEndpointConnectionOperationResponse, err error)

GetPrivateEndpointConnection ...

func (PrivateEndpointConnectionClient) GetPrivateEndpointConnections 

func (c PrivateEndpointConnectionClient) GetPrivateEndpointConnections(ctx context.Context, id MasterSiteId) (result GetPrivateEndpointConnectionsOperationResponse, err error)

GetPrivateEndpointConnections ...

func (PrivateEndpointConnectionClient) GetPrivateEndpointConnectionsComplete added in v0.20240226.1173038 

func (c PrivateEndpointConnectionClient) GetPrivateEndpointConnectionsComplete(ctx context.Context, id MasterSiteId) (GetPrivateEndpointConnectionsCompleteResult, error)

GetPrivateEndpointConnectionsComplete retrieves all the results into a single object

func (PrivateEndpointConnectionClient) GetPrivateEndpointConnectionsCompleteMatchingPredicate added in v0.20240226.1173038 

func (c PrivateEndpointConnectionClient) GetPrivateEndpointConnectionsCompleteMatchingPredicate(ctx context.Context, id MasterSiteId, predicate PrivateEndpointConnectionOperationPredicate) (result GetPrivateEndpointConnectionsCompleteResult, err error)

GetPrivateEndpointConnectionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateEndpointConnectionClient) PutPrivateEndpointConnection 

func (c PrivateEndpointConnectionClient) PutPrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result PutPrivateEndpointConnectionOperationResponse, err error)

PutPrivateEndpointConnection ...

type PrivateEndpointConnectionId 

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

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

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, masterSiteName 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 added in v0.20240226.1173038 

type PrivateEndpointConnectionOperationPredicate struct {
	ETag *string
	Id   *string
	Name *string
	Type *string
}

func (PrivateEndpointConnectionOperationPredicate) Matches added in v0.20240226.1173038 

func (p PrivateEndpointConnectionOperationPredicate) Matches(input PrivateEndpointConnection) bool

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *ResourceId                        `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *ProvisioningState                 `json:"provisioningState,omitempty"`
}

type PrivateLinkServiceConnectionState 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted   ProvisioningState = "Accepted"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type PutPrivateEndpointConnectionOperationResponse 

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

type ResourceId 

type ResourceId struct {
	Id *string `json:"id,omitempty"`
}

type Status 

type Status string
const (
	StatusApproved     Status = "Approved"
	StatusDisconnected Status = "Disconnected"
	StatusPending      Status = "Pending"
	StatusRejected     Status = "Rejected"
)

func (*Status) UnmarshalJSON 

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

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.