privatelinkresources

package
v0.20240521.1173452 Latest Latest
Warning

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

Go to latest
Published: May 21, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/deviceupdate/2022-10-01/privatelinkresources Documentation

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

Client Initialization

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

Example Usage: PrivateLinkResourcesClient.Get

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

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: PrivateLinkResourcesClient.ListByAccount

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

// alternatively `client.ListByAccount(ctx, id)` can be used to do batched pagination
items, err := client.ListByAccountComplete(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 PossibleValuesForGroupIdProvisioningState

func PossibleValuesForGroupIdProvisioningState() []string

func ValidateAccountID

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

ValidateAccountID checks that 'input' can be parsed as a 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 AccountId

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult

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

func (AccountId) ID

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments

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

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

func (AccountId) String

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type GetOperationResponse

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

type GroupIdProvisioningState

type GroupIdProvisioningState string
const (
	GroupIdProvisioningStateCanceled  GroupIdProvisioningState = "Canceled"
	GroupIdProvisioningStateFailed    GroupIdProvisioningState = "Failed"
	GroupIdProvisioningStateSucceeded GroupIdProvisioningState = "Succeeded"
)

func (*GroupIdProvisioningState) UnmarshalJSON

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

type GroupInformation

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

type GroupInformationOperationPredicate added in v0.20240226.1173038

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

func (GroupInformationOperationPredicate) Matches added in v0.20240226.1173038

type GroupInformationProperties

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

type ListByAccountCompleteResult added in v0.20240226.1173038

type ListByAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GroupInformation
}

type ListByAccountOperationResponse

type ListByAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GroupInformation
}

type PrivateLinkResourceId

type PrivateLinkResourceId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	GroupId           string
}

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

func NewPrivateLinkResourceID

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, accountName string, groupId 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 PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

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

func (PrivateLinkResourcesClient) Get

Get ...

func (PrivateLinkResourcesClient) ListByAccount

ListByAccount ...

func (PrivateLinkResourcesClient) ListByAccountComplete added in v0.20240226.1173038

ListByAccountComplete retrieves all the results into a single object

func (PrivateLinkResourcesClient) ListByAccountCompleteMatchingPredicate added in v0.20240226.1173038

func (c PrivateLinkResourcesClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate GroupInformationOperationPredicate) (result ListByAccountCompleteResult, err error)

ListByAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL