availabledelegations

package
v0.20240927.1005214 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/availabledelegations Documentation

The availabledelegations SDK allows for interaction with Azure Resource Manager network (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/network/2023-11-01/availabledelegations"

Client Initialization

client := availabledelegations.NewAvailableDelegationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AvailableDelegationsClient.AvailableDelegationsList

ctx := context.TODO()
id := availabledelegations.NewLocationID("12345678-1234-9876-4563-123456789012", "location")

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

Example Usage: AvailableDelegationsClient.AvailableResourceGroupDelegationsList

ctx := context.TODO()
id := availabledelegations.NewProviderLocationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "location")

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

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

func ValidateProviderLocationID 

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

ValidateProviderLocationID checks that 'input' can be parsed as a Provider Location ID

Types

type AvailableDelegation 

type AvailableDelegation struct {
	Actions     *[]string `json:"actions,omitempty"`
	Id          *string   `json:"id,omitempty"`
	Name        *string   `json:"name,omitempty"`
	ServiceName *string   `json:"serviceName,omitempty"`
	Type        *string   `json:"type,omitempty"`
}

type AvailableDelegationOperationPredicate 

type AvailableDelegationOperationPredicate struct {
	Id          *string
	Name        *string
	ServiceName *string
	Type        *string
}

func (AvailableDelegationOperationPredicate) Matches 

func (p AvailableDelegationOperationPredicate) Matches(input AvailableDelegation) bool

type AvailableDelegationsClient 

type AvailableDelegationsClient struct {
	Client *resourcemanager.Client
}

func NewAvailableDelegationsClientWithBaseURI 

func NewAvailableDelegationsClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailableDelegationsClient, error)

func (AvailableDelegationsClient) AvailableDelegationsList 

func (c AvailableDelegationsClient) AvailableDelegationsList(ctx context.Context, id LocationId) (result AvailableDelegationsListOperationResponse, err error)

AvailableDelegationsList ...

func (AvailableDelegationsClient) AvailableDelegationsListComplete 

func (c AvailableDelegationsClient) AvailableDelegationsListComplete(ctx context.Context, id LocationId) (AvailableDelegationsListCompleteResult, error)

AvailableDelegationsListComplete retrieves all the results into a single object

func (AvailableDelegationsClient) AvailableDelegationsListCompleteMatchingPredicate 

func (c AvailableDelegationsClient) AvailableDelegationsListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate AvailableDelegationOperationPredicate) (result AvailableDelegationsListCompleteResult, err error)

AvailableDelegationsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AvailableDelegationsClient) AvailableResourceGroupDelegationsList 

func (c AvailableDelegationsClient) AvailableResourceGroupDelegationsList(ctx context.Context, id ProviderLocationId) (result AvailableResourceGroupDelegationsListOperationResponse, err error)

AvailableResourceGroupDelegationsList ...

func (AvailableDelegationsClient) AvailableResourceGroupDelegationsListComplete 

func (c AvailableDelegationsClient) AvailableResourceGroupDelegationsListComplete(ctx context.Context, id ProviderLocationId) (AvailableResourceGroupDelegationsListCompleteResult, error)

AvailableResourceGroupDelegationsListComplete retrieves all the results into a single object

func (AvailableDelegationsClient) AvailableResourceGroupDelegationsListCompleteMatchingPredicate 

func (c AvailableDelegationsClient) AvailableResourceGroupDelegationsListCompleteMatchingPredicate(ctx context.Context, id ProviderLocationId, predicate AvailableDelegationOperationPredicate) (result AvailableResourceGroupDelegationsListCompleteResult, err error)

AvailableResourceGroupDelegationsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type AvailableDelegationsListCompleteResult 

type AvailableDelegationsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AvailableDelegation
}

type AvailableDelegationsListCustomPager added in v0.20240628.1153531 

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

type AvailableDelegationsListOperationResponse 

type AvailableDelegationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AvailableDelegation
}

type AvailableResourceGroupDelegationsListCompleteResult 

type AvailableResourceGroupDelegationsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AvailableDelegation
}

type AvailableResourceGroupDelegationsListCustomPager added in v0.20240628.1153531 

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

type AvailableResourceGroupDelegationsListOperationResponse 

type AvailableResourceGroupDelegationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AvailableDelegation
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ProviderLocationId 

type ProviderLocationId struct {
	SubscriptionId    string
	ResourceGroupName string
	LocationName      string
}

ProviderLocationId is a struct representing the Resource ID for a Provider Location

func NewProviderLocationID 

func NewProviderLocationID(subscriptionId string, resourceGroupName string, locationName string) ProviderLocationId

NewProviderLocationID returns a new ProviderLocationId struct

func ParseProviderLocationID 

func ParseProviderLocationID(input string) (*ProviderLocationId, error)

ParseProviderLocationID parses 'input' into a ProviderLocationId

func ParseProviderLocationIDInsensitively 

func ParseProviderLocationIDInsensitively(input string) (*ProviderLocationId, error)

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

func (*ProviderLocationId) FromParseResult 

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

func (ProviderLocationId) ID 

func (id ProviderLocationId) ID() string

ID returns the formatted Provider Location ID

func (ProviderLocationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Provider Location ID

func (ProviderLocationId) String 

func (id ProviderLocationId) String() string

String returns a human-readable description of this Provider Location ID

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.