expressrouteportslocations

README

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

The expressrouteportslocations 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-05-01/expressrouteportslocations"

Client Initialization

client := expressrouteportslocations.NewExpressRoutePortsLocationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRoutePortsLocationsClient.Get

ctx := context.TODO()
id := expressrouteportslocations.NewExpressRoutePortsLocationID("12345678-1234-9876-4563-123456789012", "expressRoutePortsLocationValue")

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

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

• func PossibleValuesForProvisioningState() []string
• func ValidateExpressRoutePortsLocationID(input interface{}, key string) (warnings []string, errors []error)
• type ExpressRoutePortsLocation
• type ExpressRoutePortsLocationBandwidths
• type ExpressRoutePortsLocationId
  • func NewExpressRoutePortsLocationID(subscriptionId string, expressRoutePortsLocationName string) ExpressRoutePortsLocationId
  • func ParseExpressRoutePortsLocationID(input string) (*ExpressRoutePortsLocationId, error)
  • func ParseExpressRoutePortsLocationIDInsensitively(input string) (*ExpressRoutePortsLocationId, error)
  • func (id *ExpressRoutePortsLocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id ExpressRoutePortsLocationId) ID() string
  • func (id ExpressRoutePortsLocationId) Segments() []resourceids.Segment
  • func (id ExpressRoutePortsLocationId) String() string
• type ExpressRoutePortsLocationOperationPredicate
  • func (p ExpressRoutePortsLocationOperationPredicate) Matches(input ExpressRoutePortsLocation) bool
• type ExpressRoutePortsLocationPropertiesFormat
• type ExpressRoutePortsLocationsClient
  • func NewExpressRoutePortsLocationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRoutePortsLocationsClient, error)
  • func (c ExpressRoutePortsLocationsClient) Get(ctx context.Context, id ExpressRoutePortsLocationId) (result GetOperationResponse, err error)
  • func (c ExpressRoutePortsLocationsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c ExpressRoutePortsLocationsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c ExpressRoutePortsLocationsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateExpressRoutePortsLocationID

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

ValidateExpressRoutePortsLocationID checks that 'input' can be parsed as a Express Route Ports Location ID

Types

type ExpressRoutePortsLocation

type ExpressRoutePortsLocation struct {
	Id         *string                                    `json:"id,omitempty"`
	Location   *string                                    `json:"location,omitempty"`
	Name       *string                                    `json:"name,omitempty"`
	Properties *ExpressRoutePortsLocationPropertiesFormat `json:"properties,omitempty"`
	Tags       *map[string]string                         `json:"tags,omitempty"`
	Type       *string                                    `json:"type,omitempty"`
}

type ExpressRoutePortsLocationBandwidths

type ExpressRoutePortsLocationBandwidths struct {
	OfferName   *string `json:"offerName,omitempty"`
	ValueInGbps *int64  `json:"valueInGbps,omitempty"`
}

type ExpressRoutePortsLocationId

type ExpressRoutePortsLocationId struct {
	SubscriptionId                string
	ExpressRoutePortsLocationName string
}

ExpressRoutePortsLocationId is a struct representing the Resource ID for a Express Route Ports Location

func NewExpressRoutePortsLocationID

func NewExpressRoutePortsLocationID(subscriptionId string, expressRoutePortsLocationName string) ExpressRoutePortsLocationId

NewExpressRoutePortsLocationID returns a new ExpressRoutePortsLocationId struct

func ParseExpressRoutePortsLocationID

func ParseExpressRoutePortsLocationID(input string) (*ExpressRoutePortsLocationId, error)

ParseExpressRoutePortsLocationID parses 'input' into a ExpressRoutePortsLocationId

func ParseExpressRoutePortsLocationIDInsensitively

func ParseExpressRoutePortsLocationIDInsensitively(input string) (*ExpressRoutePortsLocationId, error)

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

func (*ExpressRoutePortsLocationId) FromParseResult

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

func (ExpressRoutePortsLocationId) ID

func (id ExpressRoutePortsLocationId) ID() string

ID returns the formatted Express Route Ports Location ID

func (ExpressRoutePortsLocationId) Segments

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

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

func (ExpressRoutePortsLocationId) String

func (id ExpressRoutePortsLocationId) String() string

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

type ExpressRoutePortsLocationOperationPredicate

type ExpressRoutePortsLocationOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ExpressRoutePortsLocationOperationPredicate) Matches

func (p ExpressRoutePortsLocationOperationPredicate) Matches(input ExpressRoutePortsLocation) bool

type ExpressRoutePortsLocationPropertiesFormat

type ExpressRoutePortsLocationPropertiesFormat struct {
	Address             *string                                `json:"address,omitempty"`
	AvailableBandwidths *[]ExpressRoutePortsLocationBandwidths `json:"availableBandwidths,omitempty"`
	Contact             *string                                `json:"contact,omitempty"`
	ProvisioningState   *ProvisioningState                     `json:"provisioningState,omitempty"`
}

type ExpressRoutePortsLocationsClient

type ExpressRoutePortsLocationsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRoutePortsLocationsClientWithBaseURI

func NewExpressRoutePortsLocationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRoutePortsLocationsClient, error)

func (ExpressRoutePortsLocationsClient) Get

func (c ExpressRoutePortsLocationsClient) Get(ctx context.Context, id ExpressRoutePortsLocationId) (result GetOperationResponse, err error)

Get ...

func (ExpressRoutePortsLocationsClient) List

func (c ExpressRoutePortsLocationsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (ExpressRoutePortsLocationsClient) ListComplete

func (c ExpressRoutePortsLocationsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ExpressRoutePortsLocationsClient) ListCompleteMatchingPredicate

func (c ExpressRoutePortsLocationsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ExpressRoutePortsLocationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

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