namespacesprivatelinkresources

README

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

The namespacesprivatelinkresources SDK allows for interaction with the Azure Resource Manager Service 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", "namespaceValue", "privateLinkResourceValue")

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

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

Documentation

Index

• func ValidateNamespaceID(input interface{}, key string) (warnings []string, errors []error)
• func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
• type NamespaceId
  • func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId
  • func ParseNamespaceID(input string) (*NamespaceId, error)
  • func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)
  • func (id NamespaceId) ID() string
  • func (id NamespaceId) Segments() []resourceids.Segment
  • func (id NamespaceId) String() string
• type NamespacesPrivateLinkResourcesClient
  • func NewNamespacesPrivateLinkResourcesClientWithBaseURI(api environments.Api) (*NamespacesPrivateLinkResourcesClient, error)
  • func (c NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesGet(ctx context.Context, id PrivateLinkResourceId) (result PrivateLinkResourcesGetOperationResponse, err error)
  • func (c NamespacesPrivateLinkResourcesClient) PrivateLinkResourcesList(ctx context.Context, id NamespaceId) (result PrivateLinkResourcesListOperationResponse, err error)
• type PrivateLinkResource
• type PrivateLinkResourceId
  • func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, namespaceName string, ...) PrivateLinkResourceId
  • func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)
  • func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)
  • func (id PrivateLinkResourceId) ID() string
  • func (id PrivateLinkResourceId) Segments() []resourceids.Segment
  • func (id PrivateLinkResourceId) String() string
• type PrivateLinkResourceProperties
• type PrivateLinkResourcesGetOperationResponse
• type PrivateLinkResourcesListOperationResponse
• type PrivateLinkResourcesListResult

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) 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(api environments.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 ...

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

type PrivateLinkResourcesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResourcesListResult
}

type PrivateLinkResourcesListResult

type PrivateLinkResourcesListResult struct {
	NextLink *string                `json:"nextLink,omitempty"`
	Value    *[]PrivateLinkResource `json:"value,omitempty"`
}