privatelinkhubs

package
v0.20240627.1145836 Latest Latest
Warning

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

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

README

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

The privatelinkhubs 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/privatelinkhubs"

Client Initialization

client := privatelinkhubs.NewPrivateLinkHubsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkHubsClient.CreateOrUpdate

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

payload := privatelinkhubs.PrivateLinkHub{
	// ...
}


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

Example Usage: PrivateLinkHubsClient.Delete

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

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PrivateLinkHubsClient.Get

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

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: PrivateLinkHubsClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// 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: PrivateLinkHubsClient.ListByResourceGroup

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

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

Example Usage: PrivateLinkHubsClient.PrivateEndpointConnectionsPrivateLinkHubGet

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

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

Example Usage: PrivateLinkHubsClient.PrivateEndpointConnectionsPrivateLinkHubList

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

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

Example Usage: PrivateLinkHubsClient.Update

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

payload := privatelinkhubs.PrivateLinkHubPatchInfo{
	// ...
}


read, err := client.Update(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 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

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkHub
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateLinkHub
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateLinkHub
}

type ListCompleteResult 

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

type ListOperationResponse 

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

type PrivateEndpoint 

type PrivateEndpoint struct {
	Id *string `json:"id,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 PrivateEndpointConnectionForPrivateLinkHubBasic 

type PrivateEndpointConnectionForPrivateLinkHubBasic struct {
	Id         *string                              `json:"id,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

type PrivateEndpointConnectionForPrivateLinkHubOperationPredicate 

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

func (PrivateEndpointConnectionForPrivateLinkHubOperationPredicate) Matches 

func (p PrivateEndpointConnectionForPrivateLinkHubOperationPredicate) Matches(input PrivateEndpointConnectionForPrivateLinkHub) bool

type PrivateEndpointConnectionProperties 

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

type PrivateEndpointConnectionsPrivateLinkHubGetOperationResponse 

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

type PrivateEndpointConnectionsPrivateLinkHubListCompleteResult 

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

type PrivateEndpointConnectionsPrivateLinkHubListOperationResponse 

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

type PrivateLinkHub 

type PrivateLinkHub struct {
	Id         *string                   `json:"id,omitempty"`
	Location   string                    `json:"location"`
	Name       *string                   `json:"name,omitempty"`
	Properties *PrivateLinkHubProperties `json:"properties,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

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 PrivateLinkHubOperationPredicate 

type PrivateLinkHubOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (PrivateLinkHubOperationPredicate) Matches 

func (p PrivateLinkHubOperationPredicate) Matches(input PrivateLinkHub) bool

type PrivateLinkHubPatchInfo 

type PrivateLinkHubPatchInfo struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

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 PrivateLinkHubProperties 

type PrivateLinkHubProperties struct {
	PrivateEndpointConnections *[]PrivateEndpointConnectionForPrivateLinkHubBasic `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *string                                            `json:"provisioningState,omitempty"`
}

type PrivateLinkHubsClient 

type PrivateLinkHubsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkHubsClientWithBaseURI 

func NewPrivateLinkHubsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkHubsClient, error)

func (PrivateLinkHubsClient) CreateOrUpdate 

func (c PrivateLinkHubsClient) CreateOrUpdate(ctx context.Context, id PrivateLinkHubId, input PrivateLinkHub) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PrivateLinkHubsClient) Delete 

func (c PrivateLinkHubsClient) Delete(ctx context.Context, id PrivateLinkHubId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateLinkHubsClient) DeleteThenPoll 

func (c PrivateLinkHubsClient) DeleteThenPoll(ctx context.Context, id PrivateLinkHubId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateLinkHubsClient) Get 

func (c PrivateLinkHubsClient) Get(ctx context.Context, id PrivateLinkHubId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkHubsClient) List 

func (c PrivateLinkHubsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (PrivateLinkHubsClient) ListByResourceGroup 

func (c PrivateLinkHubsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (PrivateLinkHubsClient) ListByResourceGroupComplete 

func (c PrivateLinkHubsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (PrivateLinkHubsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c PrivateLinkHubsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate PrivateLinkHubOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkHubsClient) ListComplete 

func (c PrivateLinkHubsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PrivateLinkHubsClient) ListCompleteMatchingPredicate 

func (c PrivateLinkHubsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate PrivateLinkHubOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubGet 

func (c PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubGet(ctx context.Context, id PrivateLinkHubPrivateEndpointConnectionId) (result PrivateEndpointConnectionsPrivateLinkHubGetOperationResponse, err error)

PrivateEndpointConnectionsPrivateLinkHubGet ...

func (PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubList 

func (c PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubList(ctx context.Context, id PrivateLinkHubId) (result PrivateEndpointConnectionsPrivateLinkHubListOperationResponse, err error)

PrivateEndpointConnectionsPrivateLinkHubList ...

func (PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubListComplete 

func (c PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubListComplete(ctx context.Context, id PrivateLinkHubId) (PrivateEndpointConnectionsPrivateLinkHubListCompleteResult, error)

PrivateEndpointConnectionsPrivateLinkHubListComplete retrieves all the results into a single object

func (PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubListCompleteMatchingPredicate 

func (c PrivateLinkHubsClient) PrivateEndpointConnectionsPrivateLinkHubListCompleteMatchingPredicate(ctx context.Context, id PrivateLinkHubId, predicate PrivateEndpointConnectionForPrivateLinkHubOperationPredicate) (result PrivateEndpointConnectionsPrivateLinkHubListCompleteResult, err error)

PrivateEndpointConnectionsPrivateLinkHubListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkHubsClient) Update 

func (c PrivateLinkHubsClient) Update(ctx context.Context, id PrivateLinkHubId, input PrivateLinkHubPatchInfo) (result UpdateOperationResponse, err error)

Update ...

type PrivateLinkServiceConnectionState 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkHub
}

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.