namespacesprivatelinkresources

package
v0.20241009.1142232 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/relay/2021-11-01/namespacesprivatelinkresources Documentation

The namespacesprivatelinkresources SDK allows for interaction with Azure Resource Manager relay (API Version 2021-11-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/relay/2021-11-01/namespacesprivatelinkresources"

Client Initialization

client := namespacesprivatelinkresources.NewNamespacesPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NamespacesPrivateLinkResourcesClient.PrivateLinkResourcesGet

ctx := context.TODO()
id := namespacesprivatelinkresources.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "privateLinkResourceName")

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

Example Usage: NamespacesPrivateLinkResourcesClient.PrivateLinkResourcesList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateNamespaceID 

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

func ValidatePrivateLinkResourceID 

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

ValidatePrivateLinkResourceID checks that 'input' can be parsed as a Private Link Resource ID

Types

type NamespaceId 

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID 

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID 

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively 

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult 

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

func (NamespaceId) ID 

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments 

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

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

func (NamespaceId) String 

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type NamespacesPrivateLinkResourcesClient 

type NamespacesPrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewNamespacesPrivateLinkResourcesClientWithBaseURI 

func NewNamespacesPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*NamespacesPrivateLinkResourcesClient, error)

func (NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesGet 

func (c NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesGet(ctx context.Context, id PrivateLinkResourceId) (result PrivateLinkResourcesGetOperationResponse, err error)

PrivateLinkResourcesGet ...

func (NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesList 

func (c NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesList(ctx context.Context, id NamespaceId) (result PrivateLinkResourcesListOperationResponse, err error)

PrivateLinkResourcesList ...

func (NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesListComplete added in v0.20240226.1173038 

func (c NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesListComplete(ctx context.Context, id NamespaceId) (PrivateLinkResourcesListCompleteResult, error)

PrivateLinkResourcesListComplete retrieves all the results into a single object

func (NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesListCompleteMatchingPredicate added in v0.20240226.1173038 

func (c NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesListCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate PrivateLinkResourceOperationPredicate) (result PrivateLinkResourcesListCompleteResult, err error)

PrivateLinkResourcesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PrivateLinkResource 

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

type PrivateLinkResourceId 

type PrivateLinkResourceId struct {
	SubscriptionId          string
	ResourceGroupName       string
	NamespaceName           string
	PrivateLinkResourceName string
}

PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource

func NewPrivateLinkResourceID 

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, namespaceName string, privateLinkResourceName string) PrivateLinkResourceId

NewPrivateLinkResourceID returns a new PrivateLinkResourceId struct

func ParsePrivateLinkResourceID 

func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)

ParsePrivateLinkResourceID parses 'input' into a PrivateLinkResourceId

func ParsePrivateLinkResourceIDInsensitively 

func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)

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

func (*PrivateLinkResourceId) FromParseResult 

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

func (PrivateLinkResourceId) ID 

func (id PrivateLinkResourceId) ID() string

ID returns the formatted Private Link Resource ID

func (PrivateLinkResourceId) Segments 

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

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

func (PrivateLinkResourceId) String 

func (id PrivateLinkResourceId) String() string

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

type PrivateLinkResourceOperationPredicate added in v0.20240226.1173038 

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

func (PrivateLinkResourceOperationPredicate) Matches added in v0.20240226.1173038 

func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type PrivateLinkResourcesGetOperationResponse 

type PrivateLinkResourcesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResource
}

type PrivateLinkResourcesListCompleteResult added in v0.20240226.1173038 

type PrivateLinkResourcesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateLinkResource
}

type PrivateLinkResourcesListCustomPager added in v0.20240628.1153531 

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

type PrivateLinkResourcesListOperationResponse 

type PrivateLinkResourcesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateLinkResource
}

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.