privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/elasticsan/2024-05-01/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service elasticsan (API Version 2024-05-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/elasticsan/2024-05-01/privatelinkresources"

Client Initialization

client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourcesClient.ListByElasticSan

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

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

Documentation

Index

• func ValidateElasticSanID(input interface{}, key string) (warnings []string, errors []error)
• type ElasticSanId
  • func NewElasticSanID(subscriptionId string, resourceGroupName string, elasticSanName string) ElasticSanId
  • func ParseElasticSanID(input string) (*ElasticSanId, error)
  • func ParseElasticSanIDInsensitively(input string) (*ElasticSanId, error)
  • func (id *ElasticSanId) FromParseResult(input resourceids.ParseResult) error
  • func (id ElasticSanId) ID() string
  • func (id ElasticSanId) Segments() []resourceids.Segment
  • func (id ElasticSanId) String() string
• type ListByElasticSanCompleteResult
• type ListByElasticSanOperationResponse
• type PrivateLinkResource
• type PrivateLinkResourceOperationPredicate
  • func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool
• type PrivateLinkResourceProperties
• type PrivateLinkResourcesClient
  • func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)
  • func (c PrivateLinkResourcesClient) ListByElasticSan(ctx context.Context, id ElasticSanId) (result ListByElasticSanOperationResponse, err error)
  • func (c PrivateLinkResourcesClient) ListByElasticSanComplete(ctx context.Context, id ElasticSanId) (ListByElasticSanCompleteResult, error)
  • func (c PrivateLinkResourcesClient) ListByElasticSanCompleteMatchingPredicate(ctx context.Context, id ElasticSanId, ...) (result ListByElasticSanCompleteResult, err error)

Functions

func ValidateElasticSanID

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

ValidateElasticSanID checks that 'input' can be parsed as a Elastic San ID

Types

type ElasticSanId

type ElasticSanId struct {
	SubscriptionId    string
	ResourceGroupName string
	ElasticSanName    string
}

ElasticSanId is a struct representing the Resource ID for a Elastic San

func NewElasticSanID

func NewElasticSanID(subscriptionId string, resourceGroupName string, elasticSanName string) ElasticSanId

NewElasticSanID returns a new ElasticSanId struct

func ParseElasticSanID

func ParseElasticSanID(input string) (*ElasticSanId, error)

ParseElasticSanID parses 'input' into a ElasticSanId

func ParseElasticSanIDInsensitively

func ParseElasticSanIDInsensitively(input string) (*ElasticSanId, error)

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

func (*ElasticSanId) FromParseResult

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

func (ElasticSanId) ID

func (id ElasticSanId) ID() string

ID returns the formatted Elastic San ID

func (ElasticSanId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Elastic San ID

func (ElasticSanId) String

func (id ElasticSanId) String() string

String returns a human-readable description of this Elastic San ID

type ListByElasticSanCompleteResult

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

type ListByElasticSanOperationResponse

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

type PrivateLinkResource

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

type PrivateLinkResourceOperationPredicate

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

func (PrivateLinkResourceOperationPredicate) Matches

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 PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)

func (PrivateLinkResourcesClient) ListByElasticSan

func (c PrivateLinkResourcesClient) ListByElasticSan(ctx context.Context, id ElasticSanId) (result ListByElasticSanOperationResponse, err error)

ListByElasticSan ...

func (PrivateLinkResourcesClient) ListByElasticSanComplete

func (c PrivateLinkResourcesClient) ListByElasticSanComplete(ctx context.Context, id ElasticSanId) (ListByElasticSanCompleteResult, error)

ListByElasticSanComplete retrieves all the results into a single object

func (PrivateLinkResourcesClient) ListByElasticSanCompleteMatchingPredicate

func (c PrivateLinkResourcesClient) ListByElasticSanCompleteMatchingPredicate(ctx context.Context, id ElasticSanId, predicate PrivateLinkResourceOperationPredicate) (result ListByElasticSanCompleteResult, err error)

ListByElasticSanCompleteMatchingPredicate retrieves all the results and then applies the predicate