expressroutecircuitauthorizations

package
v0.20231002.1065327 Latest Latest
Warning

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

 Go to latest Published: Oct 2, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-05-01/expressroutecircuitauthorizations Documentation

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

Client Initialization

client := expressroutecircuitauthorizations.NewExpressRouteCircuitAuthorizationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteCircuitAuthorizationsClient.CreateOrUpdate

ctx := context.TODO()
id := expressroutecircuitauthorizations.NewAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue", "authorizationValue")

payload := expressroutecircuitauthorizations.ExpressRouteCircuitAuthorization{
	// ...
}


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

Example Usage: ExpressRouteCircuitAuthorizationsClient.Delete

ctx := context.TODO()
id := expressroutecircuitauthorizations.NewAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue", "authorizationValue")

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

Example Usage: ExpressRouteCircuitAuthorizationsClient.Get

ctx := context.TODO()
id := expressroutecircuitauthorizations.NewAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue", "authorizationValue")

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

ctx := context.TODO()
id := expressroutecircuitauthorizations.NewExpressRouteCircuitID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue")

// 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 PossibleValuesForAuthorizationUseStatus 

func PossibleValuesForAuthorizationUseStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []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 ValidateExpressRouteCircuitID 

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

ValidateExpressRouteCircuitID checks that 'input' can be parsed as a Express Route Circuit ID

Types

type AuthorizationId 

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

AuthorizationId is a struct representing the Resource ID for a Authorization

func NewAuthorizationID 

func NewAuthorizationID(subscriptionId string, resourceGroupName string, expressRouteCircuitName 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) 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 AuthorizationPropertiesFormat 

type AuthorizationPropertiesFormat struct {
	AuthorizationKey       *string                 `json:"authorizationKey,omitempty"`
	AuthorizationUseStatus *AuthorizationUseStatus `json:"authorizationUseStatus,omitempty"`
	ProvisioningState      *ProvisioningState      `json:"provisioningState,omitempty"`
}

type AuthorizationUseStatus 

type AuthorizationUseStatus string
const (
	AuthorizationUseStatusAvailable AuthorizationUseStatus = "Available"
	AuthorizationUseStatusInUse     AuthorizationUseStatus = "InUse"
)

func (*AuthorizationUseStatus) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type ExpressRouteCircuitAuthorization 

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

type ExpressRouteCircuitAuthorizationOperationPredicate 

type ExpressRouteCircuitAuthorizationOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (ExpressRouteCircuitAuthorizationOperationPredicate) Matches 

func (p ExpressRouteCircuitAuthorizationOperationPredicate) Matches(input ExpressRouteCircuitAuthorization) bool

type ExpressRouteCircuitAuthorizationsClient 

type ExpressRouteCircuitAuthorizationsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteCircuitAuthorizationsClientWithBaseURI 

func NewExpressRouteCircuitAuthorizationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteCircuitAuthorizationsClient, error)

func (ExpressRouteCircuitAuthorizationsClient) CreateOrUpdate 

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

CreateOrUpdate ...

func (ExpressRouteCircuitAuthorizationsClient) CreateOrUpdateThenPoll 

func (c ExpressRouteCircuitAuthorizationsClient) CreateOrUpdateThenPoll(ctx context.Context, id AuthorizationId, input ExpressRouteCircuitAuthorization) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ExpressRouteCircuitAuthorizationsClient) Delete 

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

Delete ...

func (ExpressRouteCircuitAuthorizationsClient) DeleteThenPoll 

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

DeleteThenPoll performs Delete then polls until it's completed

func (ExpressRouteCircuitAuthorizationsClient) Get 

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

Get ...

func (ExpressRouteCircuitAuthorizationsClient) List 

func (c ExpressRouteCircuitAuthorizationsClient) List(ctx context.Context, id ExpressRouteCircuitId) (result ListOperationResponse, err error)

List ...

func (ExpressRouteCircuitAuthorizationsClient) ListComplete 

func (c ExpressRouteCircuitAuthorizationsClient) ListComplete(ctx context.Context, id ExpressRouteCircuitId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ExpressRouteCircuitAuthorizationsClient) ListCompleteMatchingPredicate 

func (c ExpressRouteCircuitAuthorizationsClient) ListCompleteMatchingPredicate(ctx context.Context, id ExpressRouteCircuitId, predicate ExpressRouteCircuitAuthorizationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ExpressRouteCircuitId 

type ExpressRouteCircuitId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ExpressRouteCircuitName string
}

ExpressRouteCircuitId is a struct representing the Resource ID for a Express Route Circuit

func NewExpressRouteCircuitID 

func NewExpressRouteCircuitID(subscriptionId string, resourceGroupName string, expressRouteCircuitName string) ExpressRouteCircuitId

NewExpressRouteCircuitID returns a new ExpressRouteCircuitId struct

func ParseExpressRouteCircuitID 

func ParseExpressRouteCircuitID(input string) (*ExpressRouteCircuitId, error)

ParseExpressRouteCircuitID parses 'input' into a ExpressRouteCircuitId

func ParseExpressRouteCircuitIDInsensitively 

func ParseExpressRouteCircuitIDInsensitively(input string) (*ExpressRouteCircuitId, error)

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

func (ExpressRouteCircuitId) ID 

func (id ExpressRouteCircuitId) ID() string

ID returns the formatted Express Route Circuit ID

func (ExpressRouteCircuitId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Express Route Circuit ID

func (ExpressRouteCircuitId) String 

func (id ExpressRouteCircuitId) String() string

String returns a human-readable description of this Express Route Circuit ID

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []ExpressRouteCircuitAuthorization
}

type ListOperationResponse 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

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.