privatelinkscopes

package
v0.20231212.1221926 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2023 License: MPL-2.0 Imports: 13 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.CreateOrUpdate

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

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


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: PrivateLinkScopesClient.Delete

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

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

Example Usage: PrivateLinkScopesClient.Get

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

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: PrivateLinkScopesClient.GetValidationDetails

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

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

Example Usage: PrivateLinkScopesClient.GetValidationDetailsForMachine

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

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

Example Usage: PrivateLinkScopesClient.List

ctx := context.TODO()
id := privatelinkscopes.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: PrivateLinkScopesClient.ListByResourceGroup

ctx := context.TODO()
id := privatelinkscopes.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: PrivateLinkScopesClient.UpdateTags

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

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


read, err := client.UpdateTags(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 CreateOrUpdateOperationResponse added in v0.20230906.1160501 

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

type DeleteOperationResponse added in v0.20230906.1160501 

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

type GetOperationResponse added in v0.20230906.1160501 

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

type GetValidationDetailsForMachineOperationResponse added in v0.20230906.1160501 

type GetValidationDetailsForMachineOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkScopeValidationDetails
}

type GetValidationDetailsOperationResponse added in v0.20230906.1160501 

type GetValidationDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkScopeValidationDetails
}

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 ListByResourceGroupCompleteResult added in v0.20230906.1160501 

type ListByResourceGroupCompleteResult struct {
	Items []HybridComputePrivateLinkScope
}

type ListByResourceGroupOperationResponse added in v0.20230906.1160501 

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

type ListCompleteResult added in v0.20230906.1160501 

type ListCompleteResult struct {
	Items []HybridComputePrivateLinkScope
}

type ListOperationResponse added in v0.20230906.1160501 

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

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) FromParseResult added in v0.20231127.1171502 

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

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) FromParseResult added in v0.20231127.1171502 

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

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 *resourcemanager.Client
}

func NewPrivateLinkScopesClientWithBaseURI 

func NewPrivateLinkScopesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkScopesClient, error)

func (PrivateLinkScopesClient) CreateOrUpdate added in v0.20230906.1160501 

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

CreateOrUpdate ...

func (PrivateLinkScopesClient) Delete added in v0.20230906.1160501 

func (c PrivateLinkScopesClient) Delete(ctx context.Context, id ProviderPrivateLinkScopeId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateLinkScopesClient) DeleteThenPoll added in v0.20230906.1160501 

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

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateLinkScopesClient) Get added in v0.20230906.1160501 

func (c PrivateLinkScopesClient) Get(ctx context.Context, id ProviderPrivateLinkScopeId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkScopesClient) GetValidationDetails added in v0.20230906.1160501 

func (c PrivateLinkScopesClient) GetValidationDetails(ctx context.Context, id PrivateLinkScopeId) (result GetValidationDetailsOperationResponse, err error)

GetValidationDetails ...

func (PrivateLinkScopesClient) GetValidationDetailsForMachine added in v0.20230906.1160501 

func (c PrivateLinkScopesClient) GetValidationDetailsForMachine(ctx context.Context, id MachineId) (result GetValidationDetailsForMachineOperationResponse, err error)

GetValidationDetailsForMachine ...

func (PrivateLinkScopesClient) List added in v0.20230906.1160501 

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

List ...

func (PrivateLinkScopesClient) ListByResourceGroup added in v0.20230906.1160501 

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

ListByResourceGroup ...

func (PrivateLinkScopesClient) ListByResourceGroupComplete added in v0.20230906.1160501 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (PrivateLinkScopesClient) ListByResourceGroupCompleteMatchingPredicate added in v0.20230906.1160501 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkScopesClient) ListComplete added in v0.20230906.1160501 

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

ListComplete retrieves all the results into a single object

func (PrivateLinkScopesClient) ListCompleteMatchingPredicate added in v0.20230906.1160501 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkScopesClient) UpdateTags added in v0.20230906.1160501 

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

UpdateTags ...

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) FromParseResult added in v0.20231127.1171502 

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

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

func (*PublicNetworkAccessType) UnmarshalJSON added in v0.20230804.1074947 

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

type TagsResource 

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

type UpdateTagsOperationResponse added in v0.20230906.1160501 

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HybridComputePrivateLinkScope
}

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.