privatelinkresource

package
v0.20240125.1111756 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/batch/2023-11-01/privatelinkresource Documentation

The privatelinkresource SDK allows for interaction with the Azure Resource Manager Service batch (API Version 2023-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/batch/2023-11-01/privatelinkresource"

Client Initialization

client := privatelinkresource.NewPrivateLinkResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourceClient.Get

ctx := context.TODO()
id := privatelinkresource.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountValue", "privateLinkResourceValue")

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: PrivateLinkResourceClient.ListByBatchAccount

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

// alternatively `client.ListByBatchAccount(ctx, id, privatelinkresource.DefaultListByBatchAccountOperationOptions())` can be used to do batched pagination
items, err := client.ListByBatchAccountComplete(ctx, id, privatelinkresource.DefaultListByBatchAccountOperationOptions())
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 ValidateBatchAccountID 

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

ValidateBatchAccountID checks that 'input' can be parsed as a Batch Account 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 BatchAccountId 

type BatchAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	BatchAccountName  string
}

BatchAccountId is a struct representing the Resource ID for a Batch Account

func NewBatchAccountID 

func NewBatchAccountID(subscriptionId string, resourceGroupName string, batchAccountName string) BatchAccountId

NewBatchAccountID returns a new BatchAccountId struct

func ParseBatchAccountID 

func ParseBatchAccountID(input string) (*BatchAccountId, error)

ParseBatchAccountID parses 'input' into a BatchAccountId

func ParseBatchAccountIDInsensitively 

func ParseBatchAccountIDInsensitively(input string) (*BatchAccountId, error)

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

func (*BatchAccountId) FromParseResult 

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

func (BatchAccountId) ID 

func (id BatchAccountId) ID() string

ID returns the formatted Batch Account ID

func (BatchAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Batch Account ID

func (BatchAccountId) String 

func (id BatchAccountId) String() string

String returns a human-readable description of this Batch Account ID

type GetOperationResponse 

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

type ListByBatchAccountCompleteResult 

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

type ListByBatchAccountOperationOptions 

type ListByBatchAccountOperationOptions struct {
	Maxresults *int64
}

func DefaultListByBatchAccountOperationOptions 

func DefaultListByBatchAccountOperationOptions() ListByBatchAccountOperationOptions

func (ListByBatchAccountOperationOptions) ToHeaders 

func (o ListByBatchAccountOperationOptions) ToHeaders() *client.Headers

func (ListByBatchAccountOperationOptions) ToOData 

func (o ListByBatchAccountOperationOptions) ToOData() *odata.Query

func (ListByBatchAccountOperationOptions) ToQuery 

func (o ListByBatchAccountOperationOptions) ToQuery() *client.QueryParams

type ListByBatchAccountOperationResponse 

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

type PrivateLinkResource 

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

type PrivateLinkResourceClient 

type PrivateLinkResourceClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourceClientWithBaseURI 

func NewPrivateLinkResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourceClient, error)

func (PrivateLinkResourceClient) Get 

func (c PrivateLinkResourceClient) Get(ctx context.Context, id PrivateLinkResourceId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkResourceClient) ListByBatchAccount 

func (c PrivateLinkResourceClient) ListByBatchAccount(ctx context.Context, id BatchAccountId, options ListByBatchAccountOperationOptions) (result ListByBatchAccountOperationResponse, err error)

ListByBatchAccount ...

func (PrivateLinkResourceClient) ListByBatchAccountComplete 

func (c PrivateLinkResourceClient) ListByBatchAccountComplete(ctx context.Context, id BatchAccountId, options ListByBatchAccountOperationOptions) (ListByBatchAccountCompleteResult, error)

ListByBatchAccountComplete retrieves all the results into a single object

func (PrivateLinkResourceClient) ListByBatchAccountCompleteMatchingPredicate 

func (c PrivateLinkResourceClient) ListByBatchAccountCompleteMatchingPredicate(ctx context.Context, id BatchAccountId, options ListByBatchAccountOperationOptions, predicate PrivateLinkResourceOperationPredicate) (result ListByBatchAccountCompleteResult, err error)

ListByBatchAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PrivateLinkResourceId 

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

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

func NewPrivateLinkResourceID 

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, batchAccountName 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 

type PrivateLinkResourceOperationPredicate struct {
	Etag *string
	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"`
}

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.