expressrouteproviderports

README

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

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

Client Initialization

client := expressrouteproviderports.NewExpressRouteProviderPortsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteProviderPortsClient.ExpressRouteProviderPort

ctx := context.TODO()
id := expressrouteproviderports.NewExpressRouteProviderPortID("12345678-1234-9876-4563-123456789012", "expressRouteProviderPortValue")

read, err := client.ExpressRouteProviderPort(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ExpressRouteProviderPortsClient.LocationList

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

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

Documentation

Index

• func ValidateExpressRouteProviderPortID(input interface{}, key string) (warnings []string, errors []error)
• type ExpressRouteProviderPort
• type ExpressRouteProviderPortId
  • func NewExpressRouteProviderPortID(subscriptionId string, expressRouteProviderPortName string) ExpressRouteProviderPortId
  • func ParseExpressRouteProviderPortID(input string) (*ExpressRouteProviderPortId, error)
  • func ParseExpressRouteProviderPortIDInsensitively(input string) (*ExpressRouteProviderPortId, error)
  • func (id *ExpressRouteProviderPortId) FromParseResult(input resourceids.ParseResult) error
  • func (id ExpressRouteProviderPortId) ID() string
  • func (id ExpressRouteProviderPortId) Segments() []resourceids.Segment
  • func (id ExpressRouteProviderPortId) String() string
• type ExpressRouteProviderPortOperationPredicate
  • func (p ExpressRouteProviderPortOperationPredicate) Matches(input ExpressRouteProviderPort) bool
• type ExpressRouteProviderPortOperationResponse
• type ExpressRouteProviderPortProperties
• type ExpressRouteProviderPortsClient
  • func NewExpressRouteProviderPortsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteProviderPortsClient, error)
  • func (c ExpressRouteProviderPortsClient) ExpressRouteProviderPort(ctx context.Context, id ExpressRouteProviderPortId) (result ExpressRouteProviderPortOperationResponse, err error)
  • func (c ExpressRouteProviderPortsClient) LocationList(ctx context.Context, id commonids.SubscriptionId, ...) (result LocationListOperationResponse, err error)
  • func (c ExpressRouteProviderPortsClient) LocationListComplete(ctx context.Context, id commonids.SubscriptionId, ...) (LocationListCompleteResult, error)
  • func (c ExpressRouteProviderPortsClient) LocationListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result LocationListCompleteResult, err error)
• type LocationListCompleteResult
• type LocationListOperationOptions
  • func DefaultLocationListOperationOptions() LocationListOperationOptions
  • func (o LocationListOperationOptions) ToHeaders() *client.Headers
  • func (o LocationListOperationOptions) ToOData() *odata.Query
  • func (o LocationListOperationOptions) ToQuery() *client.QueryParams
• type LocationListOperationResponse

Functions

func ValidateExpressRouteProviderPortID

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

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

Types

type ExpressRouteProviderPort

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

type ExpressRouteProviderPortId

type ExpressRouteProviderPortId struct {
	SubscriptionId               string
	ExpressRouteProviderPortName string
}

ExpressRouteProviderPortId is a struct representing the Resource ID for a Express Route Provider Port

func NewExpressRouteProviderPortID

func NewExpressRouteProviderPortID(subscriptionId string, expressRouteProviderPortName string) ExpressRouteProviderPortId

NewExpressRouteProviderPortID returns a new ExpressRouteProviderPortId struct

func ParseExpressRouteProviderPortID

func ParseExpressRouteProviderPortID(input string) (*ExpressRouteProviderPortId, error)

ParseExpressRouteProviderPortID parses 'input' into a ExpressRouteProviderPortId

func ParseExpressRouteProviderPortIDInsensitively

func ParseExpressRouteProviderPortIDInsensitively(input string) (*ExpressRouteProviderPortId, error)

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

func (*ExpressRouteProviderPortId) FromParseResult

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

func (ExpressRouteProviderPortId) ID

func (id ExpressRouteProviderPortId) ID() string

ID returns the formatted Express Route Provider Port ID

func (ExpressRouteProviderPortId) Segments

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

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

func (ExpressRouteProviderPortId) String

func (id ExpressRouteProviderPortId) String() string

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

type ExpressRouteProviderPortOperationPredicate

type ExpressRouteProviderPortOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ExpressRouteProviderPortOperationPredicate) Matches

func (p ExpressRouteProviderPortOperationPredicate) Matches(input ExpressRouteProviderPort) bool

type ExpressRouteProviderPortOperationResponse

type ExpressRouteProviderPortOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteProviderPort
}

type ExpressRouteProviderPortProperties

type ExpressRouteProviderPortProperties struct {
	OverprovisionFactor      *int64  `json:"overprovisionFactor,omitempty"`
	PeeringLocation          *string `json:"peeringLocation,omitempty"`
	PortBandwidthInMbps      *int64  `json:"portBandwidthInMbps,omitempty"`
	PortPairDescriptor       *string `json:"portPairDescriptor,omitempty"`
	PrimaryAzurePort         *string `json:"primaryAzurePort,omitempty"`
	RemainingBandwidthInMbps *int64  `json:"remainingBandwidthInMbps,omitempty"`
	SecondaryAzurePort       *string `json:"secondaryAzurePort,omitempty"`
	UsedBandwidthInMbps      *int64  `json:"usedBandwidthInMbps,omitempty"`
}

type ExpressRouteProviderPortsClient

type ExpressRouteProviderPortsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteProviderPortsClientWithBaseURI

func NewExpressRouteProviderPortsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteProviderPortsClient, error)

func (ExpressRouteProviderPortsClient) ExpressRouteProviderPort

func (c ExpressRouteProviderPortsClient) ExpressRouteProviderPort(ctx context.Context, id ExpressRouteProviderPortId) (result ExpressRouteProviderPortOperationResponse, err error)

ExpressRouteProviderPort ...

func (ExpressRouteProviderPortsClient) LocationList

func (c ExpressRouteProviderPortsClient) LocationList(ctx context.Context, id commonids.SubscriptionId, options LocationListOperationOptions) (result LocationListOperationResponse, err error)

LocationList ...

func (ExpressRouteProviderPortsClient) LocationListComplete

func (c ExpressRouteProviderPortsClient) LocationListComplete(ctx context.Context, id commonids.SubscriptionId, options LocationListOperationOptions) (LocationListCompleteResult, error)

LocationListComplete retrieves all the results into a single object

func (ExpressRouteProviderPortsClient) LocationListCompleteMatchingPredicate

func (c ExpressRouteProviderPortsClient) LocationListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options LocationListOperationOptions, predicate ExpressRouteProviderPortOperationPredicate) (result LocationListCompleteResult, err error)

LocationListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type LocationListCompleteResult

type LocationListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ExpressRouteProviderPort
}

type LocationListOperationOptions

type LocationListOperationOptions struct {
	Filter *string
}

func DefaultLocationListOperationOptions

func DefaultLocationListOperationOptions() LocationListOperationOptions

func (LocationListOperationOptions) ToHeaders

func (o LocationListOperationOptions) ToHeaders() *client.Headers

func (LocationListOperationOptions) ToOData

func (o LocationListOperationOptions) ToOData() *odata.Query

func (LocationListOperationOptions) ToQuery

func (o LocationListOperationOptions) ToQuery() *client.QueryParams

type LocationListOperationResponse

type LocationListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ExpressRouteProviderPort
}