authorizations

package
v0.20241209.1115630 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-03-01/authorizations Documentation

The authorizations SDK allows for interaction with Azure Resource Manager vmware (API Version 2023-03-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/vmware/2023-03-01/authorizations"

Client Initialization

client := authorizations.NewAuthorizationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AuthorizationsClient.CreateOrUpdate

ctx := context.TODO()
id := authorizations.NewAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "authorizationName")

payload := authorizations.ExpressRouteAuthorization{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: AuthorizationsClient.Delete

ctx := context.TODO()
id := authorizations.NewAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "authorizationName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: AuthorizationsClient.Get

ctx := context.TODO()
id := authorizations.NewAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "authorizationName")

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: AuthorizationsClient.List

ctx := context.TODO()
id := authorizations.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName")

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

func PossibleValuesForExpressRouteAuthorizationProvisioningState() []string

func ValidateAuthorizationID 

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

ValidateAuthorizationID checks that 'input' can be parsed as a Authorization ID

func ValidatePrivateCloudID 

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

ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID

Types

type AuthorizationId 

type AuthorizationId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
	AuthorizationName string
}

AuthorizationId is a struct representing the Resource ID for a Authorization

func NewAuthorizationID 

func NewAuthorizationID(subscriptionId string, resourceGroupName string, privateCloudName string, authorizationName string) AuthorizationId

NewAuthorizationID returns a new AuthorizationId struct

func ParseAuthorizationID 

func ParseAuthorizationID(input string) (*AuthorizationId, error)

ParseAuthorizationID parses 'input' into a AuthorizationId

func ParseAuthorizationIDInsensitively 

func ParseAuthorizationIDInsensitively(input string) (*AuthorizationId, error)

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

func (*AuthorizationId) FromParseResult 

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

func (AuthorizationId) ID 

func (id AuthorizationId) ID() string

ID returns the formatted Authorization ID

func (AuthorizationId) Segments 

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

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

func (AuthorizationId) String 

func (id AuthorizationId) String() string

String returns a human-readable description of this Authorization ID

type AuthorizationsClient 

type AuthorizationsClient struct {
	Client *resourcemanager.Client
}

func NewAuthorizationsClientWithBaseURI 

func NewAuthorizationsClientWithBaseURI(sdkApi sdkEnv.Api) (*AuthorizationsClient, error)

func (AuthorizationsClient) CreateOrUpdate 

func (c AuthorizationsClient) CreateOrUpdate(ctx context.Context, id AuthorizationId, input ExpressRouteAuthorization) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AuthorizationsClient) CreateOrUpdateThenPoll 

func (c AuthorizationsClient) CreateOrUpdateThenPoll(ctx context.Context, id AuthorizationId, input ExpressRouteAuthorization) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AuthorizationsClient) Delete 

func (c AuthorizationsClient) Delete(ctx context.Context, id AuthorizationId) (result DeleteOperationResponse, err error)

Delete ...

func (AuthorizationsClient) DeleteThenPoll 

func (c AuthorizationsClient) DeleteThenPoll(ctx context.Context, id AuthorizationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AuthorizationsClient) Get 

func (c AuthorizationsClient) Get(ctx context.Context, id AuthorizationId) (result GetOperationResponse, err error)

Get ...

func (AuthorizationsClient) List 

func (c AuthorizationsClient) List(ctx context.Context, id PrivateCloudId) (result ListOperationResponse, err error)

List ...

func (AuthorizationsClient) ListComplete 

func (c AuthorizationsClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (AuthorizationsClient) ListCompleteMatchingPredicate 

func (c AuthorizationsClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate ExpressRouteAuthorizationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteAuthorization
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ExpressRouteAuthorization 

type ExpressRouteAuthorization struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *ExpressRouteAuthorizationProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type ExpressRouteAuthorizationOperationPredicate 

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

func (ExpressRouteAuthorizationOperationPredicate) Matches 

func (p ExpressRouteAuthorizationOperationPredicate) Matches(input ExpressRouteAuthorization) bool

type ExpressRouteAuthorizationProperties 

type ExpressRouteAuthorizationProperties struct {
	ExpressRouteAuthorizationId  *string                                     `json:"expressRouteAuthorizationId,omitempty"`
	ExpressRouteAuthorizationKey *string                                     `json:"expressRouteAuthorizationKey,omitempty"`
	ExpressRouteId               *string                                     `json:"expressRouteId,omitempty"`
	ProvisioningState            *ExpressRouteAuthorizationProvisioningState `json:"provisioningState,omitempty"`
}

type ExpressRouteAuthorizationProvisioningState 

type ExpressRouteAuthorizationProvisioningState string
const (
	ExpressRouteAuthorizationProvisioningStateCanceled  ExpressRouteAuthorizationProvisioningState = "Canceled"
	ExpressRouteAuthorizationProvisioningStateFailed    ExpressRouteAuthorizationProvisioningState = "Failed"
	ExpressRouteAuthorizationProvisioningStateSucceeded ExpressRouteAuthorizationProvisioningState = "Succeeded"
	ExpressRouteAuthorizationProvisioningStateUpdating  ExpressRouteAuthorizationProvisioningState = "Updating"
)

func (*ExpressRouteAuthorizationProvisioningState) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ExpressRouteAuthorization
}

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ExpressRouteAuthorization
}

type PrivateCloudId 

type PrivateCloudId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
}

PrivateCloudId is a struct representing the Resource ID for a Private Cloud

func NewPrivateCloudID 

func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId

NewPrivateCloudID returns a new PrivateCloudId struct

func ParsePrivateCloudID 

func ParsePrivateCloudID(input string) (*PrivateCloudId, error)

ParsePrivateCloudID parses 'input' into a PrivateCloudId

func ParsePrivateCloudIDInsensitively 

func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)

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

func (*PrivateCloudId) FromParseResult 

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

func (PrivateCloudId) ID 

func (id PrivateCloudId) ID() string

ID returns the formatted Private Cloud ID

func (PrivateCloudId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Cloud ID

func (PrivateCloudId) String 

func (id PrivateCloudId) String() string

String returns a human-readable description of this Private Cloud 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.