expressrouteserviceproviders

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/expressrouteserviceproviders Documentation

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

Client Initialization

client := expressrouteserviceproviders.NewExpressRouteServiceProvidersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteServiceProvidersClient.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
• type ExpressRouteServiceProvider
• type ExpressRouteServiceProviderBandwidthsOffered
• type ExpressRouteServiceProviderOperationPredicate
  • func (p ExpressRouteServiceProviderOperationPredicate) Matches(input ExpressRouteServiceProvider) bool
• type ExpressRouteServiceProviderPropertiesFormat
• type ExpressRouteServiceProvidersClient
  • func NewExpressRouteServiceProvidersClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteServiceProvidersClient, error)
  • func (c ExpressRouteServiceProvidersClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c ExpressRouteServiceProvidersClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c ExpressRouteServiceProvidersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
• type ListCompleteResult
• type ListOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

Types

type ExpressRouteServiceProvider

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

type ExpressRouteServiceProviderBandwidthsOffered

type ExpressRouteServiceProviderBandwidthsOffered struct {
	OfferName   *string `json:"offerName,omitempty"`
	ValueInMbps *int64  `json:"valueInMbps,omitempty"`
}

type ExpressRouteServiceProviderOperationPredicate

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

func (ExpressRouteServiceProviderOperationPredicate) Matches

func (p ExpressRouteServiceProviderOperationPredicate) Matches(input ExpressRouteServiceProvider) bool

type ExpressRouteServiceProviderPropertiesFormat

type ExpressRouteServiceProviderPropertiesFormat struct {
	BandwidthsOffered *[]ExpressRouteServiceProviderBandwidthsOffered `json:"bandwidthsOffered,omitempty"`
	PeeringLocations  *[]string                                       `json:"peeringLocations,omitempty"`
	ProvisioningState *ProvisioningState                              `json:"provisioningState,omitempty"`
}

type ExpressRouteServiceProvidersClient

type ExpressRouteServiceProvidersClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteServiceProvidersClientWithBaseURI

func NewExpressRouteServiceProvidersClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteServiceProvidersClient, error)

func (ExpressRouteServiceProvidersClient) List

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

List ...

func (ExpressRouteServiceProvidersClient) ListComplete

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

ListComplete retrieves all the results into a single object

func (ExpressRouteServiceProvidersClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListCompleteResult

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

type ListOperationResponse

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

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