privateendpointconnections

package
v0.20231101.1150602 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datafactory/2018-06-01/privateendpointconnections Documentation

The privateendpointconnections SDK allows for interaction with the Azure Resource Manager Service datafactory (API Version 2018-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/datafactory/2018-06-01/privateendpointconnections"

Client Initialization

client := privateendpointconnections.NewPrivateEndpointConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateEndpointConnectionsClient.ListByFactory

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

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

Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionCreateOrUpdate

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

payload := privateendpointconnections.PrivateLinkConnectionApprovalRequestResource{
	// ...
}


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

Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionDelete

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

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

Example Usage: PrivateEndpointConnectionsClient.PrivateEndpointConnectionGet

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

read, err := client.PrivateEndpointConnectionGet(ctx, id, privateendpointconnections.DefaultPrivateEndpointConnectionGetOperationOptions())
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 ValidateFactoryID 

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

ValidateFactoryID checks that 'input' can be parsed as a Factory 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 ArmIdWrapper 

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

type FactoryId 

type FactoryId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
}

FactoryId is a struct representing the Resource ID for a Factory

func NewFactoryID 

func NewFactoryID(subscriptionId string, resourceGroupName string, factoryName string) FactoryId

NewFactoryID returns a new FactoryId struct

func ParseFactoryID 

func ParseFactoryID(input string) (*FactoryId, error)

ParseFactoryID parses 'input' into a FactoryId

func ParseFactoryIDInsensitively 

func ParseFactoryIDInsensitively(input string) (*FactoryId, error)

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

func (FactoryId) ID 

func (id FactoryId) ID() string

ID returns the formatted Factory ID

func (FactoryId) Segments 

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

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

func (FactoryId) String 

func (id FactoryId) String() string

String returns a human-readable description of this Factory ID

type ListByFactoryCompleteResult 

type ListByFactoryCompleteResult struct {
	Items []PrivateEndpointConnectionResource
}

type ListByFactoryOperationResponse 

type ListByFactoryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnectionResource
}

type PrivateEndpoint 

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

type PrivateEndpointConnectionCreateOrUpdateOperationOptions 

type PrivateEndpointConnectionCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultPrivateEndpointConnectionCreateOrUpdateOperationOptions 

func DefaultPrivateEndpointConnectionCreateOrUpdateOperationOptions() PrivateEndpointConnectionCreateOrUpdateOperationOptions

func (PrivateEndpointConnectionCreateOrUpdateOperationOptions) ToHeaders added in v0.20230516.1215417 

func (o PrivateEndpointConnectionCreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (PrivateEndpointConnectionCreateOrUpdateOperationOptions) ToOData added in v0.20230516.1215417 

func (o PrivateEndpointConnectionCreateOrUpdateOperationOptions) ToOData() *odata.Query

func (PrivateEndpointConnectionCreateOrUpdateOperationOptions) ToQuery added in v0.20230516.1215417 

func (o PrivateEndpointConnectionCreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type PrivateEndpointConnectionCreateOrUpdateOperationResponse 

type PrivateEndpointConnectionCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnectionResource
}

type PrivateEndpointConnectionDeleteOperationResponse 

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

type PrivateEndpointConnectionGetOperationOptions 

type PrivateEndpointConnectionGetOperationOptions struct {
	IfNoneMatch *string
}

func DefaultPrivateEndpointConnectionGetOperationOptions 

func DefaultPrivateEndpointConnectionGetOperationOptions() PrivateEndpointConnectionGetOperationOptions

func (PrivateEndpointConnectionGetOperationOptions) ToHeaders added in v0.20230516.1215417 

func (o PrivateEndpointConnectionGetOperationOptions) ToHeaders() *client.Headers

func (PrivateEndpointConnectionGetOperationOptions) ToOData added in v0.20230516.1215417 

func (o PrivateEndpointConnectionGetOperationOptions) ToOData() *odata.Query

func (PrivateEndpointConnectionGetOperationOptions) ToQuery added in v0.20230516.1215417 

func (o PrivateEndpointConnectionGetOperationOptions) ToQuery() *client.QueryParams

type PrivateEndpointConnectionGetOperationResponse 

type PrivateEndpointConnectionGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnectionResource
}

type PrivateEndpointConnectionId 

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

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

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, factoryName 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) 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 PrivateEndpointConnectionResource 

type PrivateEndpointConnectionResource struct {
	Etag       *string                          `json:"etag,omitempty"`
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *RemotePrivateEndpointConnection `json:"properties,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type PrivateEndpointConnectionResourceOperationPredicate 

type PrivateEndpointConnectionResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (PrivateEndpointConnectionResourceOperationPredicate) Matches 

func (p PrivateEndpointConnectionResourceOperationPredicate) Matches(input PrivateEndpointConnectionResource) bool

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateEndpointConnectionsClientWithBaseURI 

func NewPrivateEndpointConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionsClient, error)

func (PrivateEndpointConnectionsClient) ListByFactory 

func (c PrivateEndpointConnectionsClient) ListByFactory(ctx context.Context, id FactoryId) (result ListByFactoryOperationResponse, err error)

ListByFactory ...

func (PrivateEndpointConnectionsClient) ListByFactoryComplete 

func (c PrivateEndpointConnectionsClient) ListByFactoryComplete(ctx context.Context, id FactoryId) (ListByFactoryCompleteResult, error)

ListByFactoryComplete retrieves all the results into a single object

func (PrivateEndpointConnectionsClient) ListByFactoryCompleteMatchingPredicate 

func (c PrivateEndpointConnectionsClient) ListByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, predicate PrivateEndpointConnectionResourceOperationPredicate) (result ListByFactoryCompleteResult, err error)

ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdate 

func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionCreateOrUpdate(ctx context.Context, id PrivateEndpointConnectionId, input PrivateLinkConnectionApprovalRequestResource, options PrivateEndpointConnectionCreateOrUpdateOperationOptions) (result PrivateEndpointConnectionCreateOrUpdateOperationResponse, err error)

PrivateEndpointConnectionCreateOrUpdate ...

func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionDelete 

func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionDelete(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionDeleteOperationResponse, err error)

PrivateEndpointConnectionDelete ...

func (PrivateEndpointConnectionsClient) PrivateEndpointConnectionGet 

func (c PrivateEndpointConnectionsClient) PrivateEndpointConnectionGet(ctx context.Context, id PrivateEndpointConnectionId, options PrivateEndpointConnectionGetOperationOptions) (result PrivateEndpointConnectionGetOperationResponse, err error)

PrivateEndpointConnectionGet ...

type PrivateLinkConnectionApprovalRequest 

type PrivateLinkConnectionApprovalRequest struct {
	PrivateEndpoint                   *PrivateEndpoint            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}

type PrivateLinkConnectionApprovalRequestResource 

type PrivateLinkConnectionApprovalRequestResource struct {
	Etag       *string                               `json:"etag,omitempty"`
	Id         *string                               `json:"id,omitempty"`
	Name       *string                               `json:"name,omitempty"`
	Properties *PrivateLinkConnectionApprovalRequest `json:"properties,omitempty"`
	Type       *string                               `json:"type,omitempty"`
}

type PrivateLinkConnectionState 

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

type RemotePrivateEndpointConnection 

type RemotePrivateEndpointConnection struct {
	PrivateEndpoint                   *ArmIdWrapper               `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *string                     `json:"provisioningState,omitempty"`
}

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.