privatelinkscopes

package
v0.20230622.1085613 Latest Latest
Warning

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

 Go to latest Published: Jun 22, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/hybridcompute/2022-11-10/privatelinkscopes Documentation

The privatelinkscopes SDK allows for interaction with the Azure Resource Manager Service hybridcompute (API Version 2022-11-10).

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/hybridcompute/2022-11-10/privatelinkscopes"

Client Initialization

client := privatelinkscopes.NewPrivateLinkScopesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesCreateOrUpdate

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

payload := privatelinkscopes.HybridComputePrivateLinkScope{
	// ...
}


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

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesDelete

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

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

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesGet

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

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

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesGetValidationDetails

ctx := context.TODO()
id := privatelinkscopes.NewPrivateLinkScopeID("12345678-1234-9876-4563-123456789012", "locationValue", "privateLinkScopeIdValue")

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

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesGetValidationDetailsForMachine

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

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

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesList

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

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

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesListByResourceGroup

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

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

Example Usage: PrivateLinkScopesClient.PrivateLinkScopesUpdateTags

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

payload := privatelinkscopes.TagsResource{
	// ...
}


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

func PossibleValuesForPublicNetworkAccessType() []string

func ValidateMachineID 

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

ValidateMachineID checks that 'input' can be parsed as a Machine ID

func ValidatePrivateLinkScopeID 

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

ValidatePrivateLinkScopeID checks that 'input' can be parsed as a Private Link Scope ID

func ValidateProviderPrivateLinkScopeID 

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

ValidateProviderPrivateLinkScopeID checks that 'input' can be parsed as a Provider Private Link Scope ID

Types

type ConnectionDetail 

type ConnectionDetail struct {
	GroupId          *string `json:"groupId,omitempty"`
	Id               *string `json:"id,omitempty"`
	LinkIdentifier   *string `json:"linkIdentifier,omitempty"`
	MemberName       *string `json:"memberName,omitempty"`
	PrivateIPAddress *string `json:"privateIpAddress,omitempty"`
}

type HybridComputePrivateLinkScope 

type HybridComputePrivateLinkScope struct {
	Id         *string                                  `json:"id,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *HybridComputePrivateLinkScopeProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                   `json:"systemData,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type HybridComputePrivateLinkScopeOperationPredicate 

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

func (HybridComputePrivateLinkScopeOperationPredicate) Matches 

func (p HybridComputePrivateLinkScopeOperationPredicate) Matches(input HybridComputePrivateLinkScope) bool

type HybridComputePrivateLinkScopeProperties 

type HybridComputePrivateLinkScopeProperties struct {
	PrivateEndpointConnections *[]PrivateEndpointConnectionDataModel `json:"privateEndpointConnections,omitempty"`
	PrivateLinkScopeId         *string                               `json:"privateLinkScopeId,omitempty"`
	ProvisioningState          *string                               `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccessType              `json:"publicNetworkAccess,omitempty"`
}

type MachineId 

type MachineId struct {
	SubscriptionId    string
	ResourceGroupName string
	MachineName       string
}

MachineId is a struct representing the Resource ID for a Machine

func NewMachineID 

func NewMachineID(subscriptionId string, resourceGroupName string, machineName string) MachineId

NewMachineID returns a new MachineId struct

func ParseMachineID 

func ParseMachineID(input string) (*MachineId, error)

ParseMachineID parses 'input' into a MachineId

func ParseMachineIDInsensitively 

func ParseMachineIDInsensitively(input string) (*MachineId, error)

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

func (MachineId) ID 

func (id MachineId) ID() string

ID returns the formatted Machine ID

func (MachineId) Segments 

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

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

func (MachineId) String 

func (id MachineId) String() string

String returns a human-readable description of this Machine ID

type PrivateEndpointConnectionDataModel 

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

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                  `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpointProperty                   `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionStateProperty `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *string                                    `json:"provisioningState,omitempty"`
}

type PrivateEndpointProperty 

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

type PrivateLinkScopeId 

type PrivateLinkScopeId struct {
	SubscriptionId     string
	LocationName       string
	PrivateLinkScopeId string
}

PrivateLinkScopeId is a struct representing the Resource ID for a Private Link Scope

func NewPrivateLinkScopeID 

func NewPrivateLinkScopeID(subscriptionId string, locationName string, privateLinkScopeId string) PrivateLinkScopeId

NewPrivateLinkScopeID returns a new PrivateLinkScopeId struct

func ParsePrivateLinkScopeID 

func ParsePrivateLinkScopeID(input string) (*PrivateLinkScopeId, error)

ParsePrivateLinkScopeID parses 'input' into a PrivateLinkScopeId

func ParsePrivateLinkScopeIDInsensitively 

func ParsePrivateLinkScopeIDInsensitively(input string) (*PrivateLinkScopeId, error)

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

func (PrivateLinkScopeId) ID 

func (id PrivateLinkScopeId) ID() string

ID returns the formatted Private Link Scope ID

func (PrivateLinkScopeId) Segments 

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

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

func (PrivateLinkScopeId) String 

func (id PrivateLinkScopeId) String() string

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

type PrivateLinkScopeValidationDetails 

type PrivateLinkScopeValidationDetails struct {
	ConnectionDetails   *[]ConnectionDetail      `json:"connectionDetails,omitempty"`
	Id                  *string                  `json:"id,omitempty"`
	PublicNetworkAccess *PublicNetworkAccessType `json:"publicNetworkAccess,omitempty"`
}

type PrivateLinkScopesClient 

type PrivateLinkScopesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewPrivateLinkScopesClientWithBaseURI 

func NewPrivateLinkScopesClientWithBaseURI(endpoint string) PrivateLinkScopesClient

func (PrivateLinkScopesClient) PrivateLinkScopesCreateOrUpdate 

func (c PrivateLinkScopesClient) PrivateLinkScopesCreateOrUpdate(ctx context.Context, id ProviderPrivateLinkScopeId, input HybridComputePrivateLinkScope) (result PrivateLinkScopesCreateOrUpdateOperationResponse, err error)

PrivateLinkScopesCreateOrUpdate ...

func (PrivateLinkScopesClient) PrivateLinkScopesDelete 

func (c PrivateLinkScopesClient) PrivateLinkScopesDelete(ctx context.Context, id ProviderPrivateLinkScopeId) (result PrivateLinkScopesDeleteOperationResponse, err error)

PrivateLinkScopesDelete ...

func (PrivateLinkScopesClient) PrivateLinkScopesDeleteThenPoll 

func (c PrivateLinkScopesClient) PrivateLinkScopesDeleteThenPoll(ctx context.Context, id ProviderPrivateLinkScopeId) error

PrivateLinkScopesDeleteThenPoll performs PrivateLinkScopesDelete then polls until it's completed

func (PrivateLinkScopesClient) PrivateLinkScopesGet 

func (c PrivateLinkScopesClient) PrivateLinkScopesGet(ctx context.Context, id ProviderPrivateLinkScopeId) (result PrivateLinkScopesGetOperationResponse, err error)

PrivateLinkScopesGet ...

func (PrivateLinkScopesClient) PrivateLinkScopesGetValidationDetails 

func (c PrivateLinkScopesClient) PrivateLinkScopesGetValidationDetails(ctx context.Context, id PrivateLinkScopeId) (result PrivateLinkScopesGetValidationDetailsOperationResponse, err error)

PrivateLinkScopesGetValidationDetails ...

func (PrivateLinkScopesClient) PrivateLinkScopesGetValidationDetailsForMachine 

func (c PrivateLinkScopesClient) PrivateLinkScopesGetValidationDetailsForMachine(ctx context.Context, id MachineId) (result PrivateLinkScopesGetValidationDetailsForMachineOperationResponse, err error)

PrivateLinkScopesGetValidationDetailsForMachine ...

func (PrivateLinkScopesClient) PrivateLinkScopesList 

func (c PrivateLinkScopesClient) PrivateLinkScopesList(ctx context.Context, id commonids.SubscriptionId) (resp PrivateLinkScopesListOperationResponse, err error)

PrivateLinkScopesList ...

func (PrivateLinkScopesClient) PrivateLinkScopesListByResourceGroup 

func (c PrivateLinkScopesClient) PrivateLinkScopesListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (resp PrivateLinkScopesListByResourceGroupOperationResponse, err error)

PrivateLinkScopesListByResourceGroup ...

func (PrivateLinkScopesClient) PrivateLinkScopesListByResourceGroupComplete 

func (c PrivateLinkScopesClient) PrivateLinkScopesListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (PrivateLinkScopesListByResourceGroupCompleteResult, error)

PrivateLinkScopesListByResourceGroupComplete retrieves all of the results into a single object

func (PrivateLinkScopesClient) PrivateLinkScopesListByResourceGroupCompleteMatchingPredicate 

func (c PrivateLinkScopesClient) PrivateLinkScopesListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate HybridComputePrivateLinkScopeOperationPredicate) (resp PrivateLinkScopesListByResourceGroupCompleteResult, err error)

PrivateLinkScopesListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (PrivateLinkScopesClient) PrivateLinkScopesListComplete 

func (c PrivateLinkScopesClient) PrivateLinkScopesListComplete(ctx context.Context, id commonids.SubscriptionId) (PrivateLinkScopesListCompleteResult, error)

PrivateLinkScopesListComplete retrieves all of the results into a single object

func (PrivateLinkScopesClient) PrivateLinkScopesListCompleteMatchingPredicate 

func (c PrivateLinkScopesClient) PrivateLinkScopesListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate HybridComputePrivateLinkScopeOperationPredicate) (resp PrivateLinkScopesListCompleteResult, err error)

PrivateLinkScopesListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (PrivateLinkScopesClient) PrivateLinkScopesUpdateTags 

func (c PrivateLinkScopesClient) PrivateLinkScopesUpdateTags(ctx context.Context, id ProviderPrivateLinkScopeId, input TagsResource) (result PrivateLinkScopesUpdateTagsOperationResponse, err error)

PrivateLinkScopesUpdateTags ...

type PrivateLinkScopesCreateOrUpdateOperationResponse 

type PrivateLinkScopesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *HybridComputePrivateLinkScope
}

type PrivateLinkScopesDeleteOperationResponse 

type PrivateLinkScopesDeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type PrivateLinkScopesGetOperationResponse 

type PrivateLinkScopesGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *HybridComputePrivateLinkScope
}

type PrivateLinkScopesGetValidationDetailsForMachineOperationResponse 

type PrivateLinkScopesGetValidationDetailsForMachineOperationResponse struct {
	HttpResponse *http.Response
	Model        *PrivateLinkScopeValidationDetails
}

type PrivateLinkScopesGetValidationDetailsOperationResponse 

type PrivateLinkScopesGetValidationDetailsOperationResponse struct {
	HttpResponse *http.Response
	Model        *PrivateLinkScopeValidationDetails
}

type PrivateLinkScopesListByResourceGroupCompleteResult 

type PrivateLinkScopesListByResourceGroupCompleteResult struct {
	Items []HybridComputePrivateLinkScope
}

type PrivateLinkScopesListByResourceGroupOperationResponse 

type PrivateLinkScopesListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]HybridComputePrivateLinkScope
	// contains filtered or unexported fields
}

func (PrivateLinkScopesListByResourceGroupOperationResponse) HasMore 

func (r PrivateLinkScopesListByResourceGroupOperationResponse) HasMore() bool

func (PrivateLinkScopesListByResourceGroupOperationResponse) LoadMore 

func (r PrivateLinkScopesListByResourceGroupOperationResponse) LoadMore(ctx context.Context) (resp PrivateLinkScopesListByResourceGroupOperationResponse, err error)

type PrivateLinkScopesListCompleteResult 

type PrivateLinkScopesListCompleteResult struct {
	Items []HybridComputePrivateLinkScope
}

type PrivateLinkScopesListOperationResponse 

type PrivateLinkScopesListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]HybridComputePrivateLinkScope
	// contains filtered or unexported fields
}

func (PrivateLinkScopesListOperationResponse) HasMore 

func (r PrivateLinkScopesListOperationResponse) HasMore() bool

func (PrivateLinkScopesListOperationResponse) LoadMore 

func (r PrivateLinkScopesListOperationResponse) LoadMore(ctx context.Context) (resp PrivateLinkScopesListOperationResponse, err error)

type PrivateLinkScopesUpdateTagsOperationResponse 

type PrivateLinkScopesUpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	Model        *HybridComputePrivateLinkScope
}

type PrivateLinkServiceConnectionStateProperty 

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

type ProviderPrivateLinkScopeId 

type ProviderPrivateLinkScopeId struct {
	SubscriptionId       string
	ResourceGroupName    string
	PrivateLinkScopeName string
}

ProviderPrivateLinkScopeId is a struct representing the Resource ID for a Provider Private Link Scope

func NewProviderPrivateLinkScopeID 

func NewProviderPrivateLinkScopeID(subscriptionId string, resourceGroupName string, privateLinkScopeName string) ProviderPrivateLinkScopeId

NewProviderPrivateLinkScopeID returns a new ProviderPrivateLinkScopeId struct

func ParseProviderPrivateLinkScopeID 

func ParseProviderPrivateLinkScopeID(input string) (*ProviderPrivateLinkScopeId, error)

ParseProviderPrivateLinkScopeID parses 'input' into a ProviderPrivateLinkScopeId

func ParseProviderPrivateLinkScopeIDInsensitively 

func ParseProviderPrivateLinkScopeIDInsensitively(input string) (*ProviderPrivateLinkScopeId, error)

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

func (ProviderPrivateLinkScopeId) ID 

func (id ProviderPrivateLinkScopeId) ID() string

ID returns the formatted Provider Private Link Scope ID

func (ProviderPrivateLinkScopeId) Segments 

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

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

func (ProviderPrivateLinkScopeId) String 

func (id ProviderPrivateLinkScopeId) String() string

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

type PublicNetworkAccessType 

type PublicNetworkAccessType string
const (
	PublicNetworkAccessTypeDisabled PublicNetworkAccessType = "Disabled"
	PublicNetworkAccessTypeEnabled  PublicNetworkAccessType = "Enabled"
)

type TagsResource 

type TagsResource struct {
	Tags *map[string]string `json:"tags,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.