expressrouteportauthorizations

package
v0.20240130.1054849 Latest Latest
Warning

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

 Go to latest Published: Jan 30, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-09-01/expressrouteportauthorizations Documentation

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

Client Initialization

client := expressrouteportauthorizations.NewExpressRoutePortAuthorizationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRoutePortAuthorizationsClient.CreateOrUpdate

ctx := context.TODO()
id := expressrouteportauthorizations.NewExpressRoutePortAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRoutePortValue", "authorizationValue")

payload := expressrouteportauthorizations.ExpressRoutePortAuthorization{
	// ...
}


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

Example Usage: ExpressRoutePortAuthorizationsClient.Delete

ctx := context.TODO()
id := expressrouteportauthorizations.NewExpressRoutePortAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRoutePortValue", "authorizationValue")

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

Example Usage: ExpressRoutePortAuthorizationsClient.Get

ctx := context.TODO()
id := expressrouteportauthorizations.NewExpressRoutePortAuthorizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRoutePortValue", "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: ExpressRoutePortAuthorizationsClient.List

ctx := context.TODO()
id := expressrouteportauthorizations.NewExpressRoutePortID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRoutePortValue")

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

func PossibleValuesForExpressRoutePortAuthorizationUseStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateExpressRoutePortAuthorizationID 

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

ValidateExpressRoutePortAuthorizationID checks that 'input' can be parsed as a Express Route Port Authorization ID

func ValidateExpressRoutePortID 

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

ValidateExpressRoutePortID checks that 'input' can be parsed as a Express Route Port ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type ExpressRoutePortAuthorization 

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

type ExpressRoutePortAuthorizationId 

type ExpressRoutePortAuthorizationId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ExpressRoutePortName string
	AuthorizationName    string
}

ExpressRoutePortAuthorizationId is a struct representing the Resource ID for a Express Route Port Authorization

func NewExpressRoutePortAuthorizationID 

func NewExpressRoutePortAuthorizationID(subscriptionId string, resourceGroupName string, expressRoutePortName string, authorizationName string) ExpressRoutePortAuthorizationId

NewExpressRoutePortAuthorizationID returns a new ExpressRoutePortAuthorizationId struct

func ParseExpressRoutePortAuthorizationID 

func ParseExpressRoutePortAuthorizationID(input string) (*ExpressRoutePortAuthorizationId, error)

ParseExpressRoutePortAuthorizationID parses 'input' into a ExpressRoutePortAuthorizationId

func ParseExpressRoutePortAuthorizationIDInsensitively 

func ParseExpressRoutePortAuthorizationIDInsensitively(input string) (*ExpressRoutePortAuthorizationId, error)

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

func (*ExpressRoutePortAuthorizationId) FromParseResult 

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

func (ExpressRoutePortAuthorizationId) ID 

func (id ExpressRoutePortAuthorizationId) ID() string

ID returns the formatted Express Route Port Authorization ID

func (ExpressRoutePortAuthorizationId) Segments 

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

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

func (ExpressRoutePortAuthorizationId) String 

func (id ExpressRoutePortAuthorizationId) String() string

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

type ExpressRoutePortAuthorizationOperationPredicate 

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

func (ExpressRoutePortAuthorizationOperationPredicate) Matches 

func (p ExpressRoutePortAuthorizationOperationPredicate) Matches(input ExpressRoutePortAuthorization) bool

type ExpressRoutePortAuthorizationPropertiesFormat 

type ExpressRoutePortAuthorizationPropertiesFormat struct {
	AuthorizationKey       *string                                 `json:"authorizationKey,omitempty"`
	AuthorizationUseStatus *ExpressRoutePortAuthorizationUseStatus `json:"authorizationUseStatus,omitempty"`
	CircuitResourceUri     *string                                 `json:"circuitResourceUri,omitempty"`
	ProvisioningState      *ProvisioningState                      `json:"provisioningState,omitempty"`
}

type ExpressRoutePortAuthorizationUseStatus 

type ExpressRoutePortAuthorizationUseStatus string
const (
	ExpressRoutePortAuthorizationUseStatusAvailable ExpressRoutePortAuthorizationUseStatus = "Available"
	ExpressRoutePortAuthorizationUseStatusInUse     ExpressRoutePortAuthorizationUseStatus = "InUse"
)

func (*ExpressRoutePortAuthorizationUseStatus) UnmarshalJSON 

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

type ExpressRoutePortAuthorizationsClient 

type ExpressRoutePortAuthorizationsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRoutePortAuthorizationsClientWithBaseURI 

func NewExpressRoutePortAuthorizationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRoutePortAuthorizationsClient, error)

func (ExpressRoutePortAuthorizationsClient) CreateOrUpdate 

func (c ExpressRoutePortAuthorizationsClient) CreateOrUpdate(ctx context.Context, id ExpressRoutePortAuthorizationId, input ExpressRoutePortAuthorization) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ExpressRoutePortAuthorizationsClient) CreateOrUpdateThenPoll 

func (c ExpressRoutePortAuthorizationsClient) CreateOrUpdateThenPoll(ctx context.Context, id ExpressRoutePortAuthorizationId, input ExpressRoutePortAuthorization) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ExpressRoutePortAuthorizationsClient) Delete 

func (c ExpressRoutePortAuthorizationsClient) Delete(ctx context.Context, id ExpressRoutePortAuthorizationId) (result DeleteOperationResponse, err error)

Delete ...

func (ExpressRoutePortAuthorizationsClient) DeleteThenPoll 

func (c ExpressRoutePortAuthorizationsClient) DeleteThenPoll(ctx context.Context, id ExpressRoutePortAuthorizationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ExpressRoutePortAuthorizationsClient) Get 

func (c ExpressRoutePortAuthorizationsClient) Get(ctx context.Context, id ExpressRoutePortAuthorizationId) (result GetOperationResponse, err error)

Get ...

func (ExpressRoutePortAuthorizationsClient) List 

func (c ExpressRoutePortAuthorizationsClient) List(ctx context.Context, id ExpressRoutePortId) (result ListOperationResponse, err error)

List ...

func (ExpressRoutePortAuthorizationsClient) ListComplete 

func (c ExpressRoutePortAuthorizationsClient) ListComplete(ctx context.Context, id ExpressRoutePortId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ExpressRoutePortAuthorizationsClient) ListCompleteMatchingPredicate 

func (c ExpressRoutePortAuthorizationsClient) ListCompleteMatchingPredicate(ctx context.Context, id ExpressRoutePortId, predicate ExpressRoutePortAuthorizationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ExpressRoutePortId 

type ExpressRoutePortId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ExpressRoutePortName string
}

ExpressRoutePortId is a struct representing the Resource ID for a Express Route Port

func NewExpressRoutePortID 

func NewExpressRoutePortID(subscriptionId string, resourceGroupName string, expressRoutePortName string) ExpressRoutePortId

NewExpressRoutePortID returns a new ExpressRoutePortId struct

func ParseExpressRoutePortID 

func ParseExpressRoutePortID(input string) (*ExpressRoutePortId, error)

ParseExpressRoutePortID parses 'input' into a ExpressRoutePortId

func ParseExpressRoutePortIDInsensitively 

func ParseExpressRoutePortIDInsensitively(input string) (*ExpressRoutePortId, error)

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

func (*ExpressRoutePortId) FromParseResult 

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

func (ExpressRoutePortId) ID 

func (id ExpressRoutePortId) ID() string

ID returns the formatted Express Route Port ID

func (ExpressRoutePortId) Segments 

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

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

func (ExpressRoutePortId) String 

func (id ExpressRoutePortId) String() string

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

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

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.