expressroutecrossconnections

package
v0.20241004.1180715 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The expressroutecrossconnections SDK allows for interaction with Azure Resource Manager 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/expressroutecrossconnections"

Client Initialization

client := expressroutecrossconnections.NewExpressRouteCrossConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteCrossConnectionsClient.CreateOrUpdate

ctx := context.TODO()
id := expressroutecrossconnections.NewExpressRouteCrossConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "crossConnectionName")

payload := expressroutecrossconnections.ExpressRouteCrossConnection{
	// ...
}


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

Example Usage: ExpressRouteCrossConnectionsClient.Get

ctx := context.TODO()
id := expressroutecrossconnections.NewExpressRouteCrossConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "crossConnectionName")

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: ExpressRouteCrossConnectionsClient.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
}

Example Usage: ExpressRouteCrossConnectionsClient.ListByResourceGroup

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

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

Example Usage: ExpressRouteCrossConnectionsClient.UpdateTags

ctx := context.TODO()
id := expressroutecrossconnections.NewExpressRouteCrossConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "crossConnectionName")

payload := expressroutecrossconnections.TagsObject{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForExpressRouteCircuitPeeringAdvertisedPublicPrefixState 

func PossibleValuesForExpressRouteCircuitPeeringAdvertisedPublicPrefixState() []string

func PossibleValuesForExpressRouteCircuitPeeringState 

func PossibleValuesForExpressRouteCircuitPeeringState() []string

func PossibleValuesForExpressRoutePeeringState 

func PossibleValuesForExpressRoutePeeringState() []string

func PossibleValuesForExpressRoutePeeringType 

func PossibleValuesForExpressRoutePeeringType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForServiceProviderProvisioningState 

func PossibleValuesForServiceProviderProvisioningState() []string

func ValidateExpressRouteCrossConnectionID 

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

ValidateExpressRouteCrossConnectionID checks that 'input' can be parsed as a Express Route Cross Connection ID

Types

type CreateOrUpdateOperationResponse 

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

type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState 

type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState string
const (
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateConfigured       ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configured"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateConfiguring      ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configuring"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateNotConfigured    ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "NotConfigured"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValidationNeeded ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "ValidationNeeded"
)

func (*ExpressRouteCircuitPeeringAdvertisedPublicPrefixState) UnmarshalJSON 

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

type ExpressRouteCircuitPeeringConfig 

type ExpressRouteCircuitPeeringConfig struct {
	AdvertisedCommunities         *[]string                                              `json:"advertisedCommunities,omitempty"`
	AdvertisedPublicPrefixes      *[]string                                              `json:"advertisedPublicPrefixes,omitempty"`
	AdvertisedPublicPrefixesState *ExpressRouteCircuitPeeringAdvertisedPublicPrefixState `json:"advertisedPublicPrefixesState,omitempty"`
	CustomerASN                   *int64                                                 `json:"customerASN,omitempty"`
	LegacyMode                    *int64                                                 `json:"legacyMode,omitempty"`
	RoutingRegistryName           *string                                                `json:"routingRegistryName,omitempty"`
}

type ExpressRouteCircuitPeeringState 

type ExpressRouteCircuitPeeringState string
const (
	ExpressRouteCircuitPeeringStateDisabled ExpressRouteCircuitPeeringState = "Disabled"
	ExpressRouteCircuitPeeringStateEnabled  ExpressRouteCircuitPeeringState = "Enabled"
)

func (*ExpressRouteCircuitPeeringState) UnmarshalJSON 

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

type ExpressRouteCircuitReference 

type ExpressRouteCircuitReference struct {
	Id *string `json:"id,omitempty"`
}

type ExpressRouteCrossConnection 

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

type ExpressRouteCrossConnectionId 

type ExpressRouteCrossConnectionId struct {
	SubscriptionId                  string
	ResourceGroupName               string
	ExpressRouteCrossConnectionName string
}

ExpressRouteCrossConnectionId is a struct representing the Resource ID for a Express Route Cross Connection

func NewExpressRouteCrossConnectionID 

func NewExpressRouteCrossConnectionID(subscriptionId string, resourceGroupName string, expressRouteCrossConnectionName string) ExpressRouteCrossConnectionId

NewExpressRouteCrossConnectionID returns a new ExpressRouteCrossConnectionId struct

func ParseExpressRouteCrossConnectionID 

func ParseExpressRouteCrossConnectionID(input string) (*ExpressRouteCrossConnectionId, error)

ParseExpressRouteCrossConnectionID parses 'input' into a ExpressRouteCrossConnectionId

func ParseExpressRouteCrossConnectionIDInsensitively 

func ParseExpressRouteCrossConnectionIDInsensitively(input string) (*ExpressRouteCrossConnectionId, error)

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

func (*ExpressRouteCrossConnectionId) FromParseResult 

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

func (ExpressRouteCrossConnectionId) ID 

func (id ExpressRouteCrossConnectionId) ID() string

ID returns the formatted Express Route Cross Connection ID

func (ExpressRouteCrossConnectionId) Segments 

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

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

func (ExpressRouteCrossConnectionId) String 

func (id ExpressRouteCrossConnectionId) String() string

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

type ExpressRouteCrossConnectionOperationPredicate 

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

func (ExpressRouteCrossConnectionOperationPredicate) Matches 

func (p ExpressRouteCrossConnectionOperationPredicate) Matches(input ExpressRouteCrossConnection) bool

type ExpressRouteCrossConnectionPeering 

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

type ExpressRouteCrossConnectionPeeringProperties 

type ExpressRouteCrossConnectionPeeringProperties struct {
	AzureASN                   *int64                                `json:"azureASN,omitempty"`
	GatewayManagerEtag         *string                               `json:"gatewayManagerEtag,omitempty"`
	IPv6PeeringConfig          *IPv6ExpressRouteCircuitPeeringConfig `json:"ipv6PeeringConfig,omitempty"`
	LastModifiedBy             *string                               `json:"lastModifiedBy,omitempty"`
	MicrosoftPeeringConfig     *ExpressRouteCircuitPeeringConfig     `json:"microsoftPeeringConfig,omitempty"`
	PeerASN                    *int64                                `json:"peerASN,omitempty"`
	PeeringType                *ExpressRoutePeeringType              `json:"peeringType,omitempty"`
	PrimaryAzurePort           *string                               `json:"primaryAzurePort,omitempty"`
	PrimaryPeerAddressPrefix   *string                               `json:"primaryPeerAddressPrefix,omitempty"`
	ProvisioningState          *ProvisioningState                    `json:"provisioningState,omitempty"`
	SecondaryAzurePort         *string                               `json:"secondaryAzurePort,omitempty"`
	SecondaryPeerAddressPrefix *string                               `json:"secondaryPeerAddressPrefix,omitempty"`
	SharedKey                  *string                               `json:"sharedKey,omitempty"`
	State                      *ExpressRoutePeeringState             `json:"state,omitempty"`
	VlanId                     *int64                                `json:"vlanId,omitempty"`
}

type ExpressRouteCrossConnectionProperties 

type ExpressRouteCrossConnectionProperties struct {
	BandwidthInMbps                  *int64                                `json:"bandwidthInMbps,omitempty"`
	ExpressRouteCircuit              *ExpressRouteCircuitReference         `json:"expressRouteCircuit,omitempty"`
	PeeringLocation                  *string                               `json:"peeringLocation,omitempty"`
	Peerings                         *[]ExpressRouteCrossConnectionPeering `json:"peerings,omitempty"`
	PrimaryAzurePort                 *string                               `json:"primaryAzurePort,omitempty"`
	ProvisioningState                *ProvisioningState                    `json:"provisioningState,omitempty"`
	STag                             *int64                                `json:"sTag,omitempty"`
	SecondaryAzurePort               *string                               `json:"secondaryAzurePort,omitempty"`
	ServiceProviderNotes             *string                               `json:"serviceProviderNotes,omitempty"`
	ServiceProviderProvisioningState *ServiceProviderProvisioningState     `json:"serviceProviderProvisioningState,omitempty"`
}

type ExpressRouteCrossConnectionsClient 

type ExpressRouteCrossConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteCrossConnectionsClientWithBaseURI 

func NewExpressRouteCrossConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteCrossConnectionsClient, error)

func (ExpressRouteCrossConnectionsClient) CreateOrUpdate 

func (c ExpressRouteCrossConnectionsClient) CreateOrUpdate(ctx context.Context, id ExpressRouteCrossConnectionId, input ExpressRouteCrossConnection) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ExpressRouteCrossConnectionsClient) CreateOrUpdateThenPoll 

func (c ExpressRouteCrossConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ExpressRouteCrossConnectionId, input ExpressRouteCrossConnection) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ExpressRouteCrossConnectionsClient) Get 

func (c ExpressRouteCrossConnectionsClient) Get(ctx context.Context, id ExpressRouteCrossConnectionId) (result GetOperationResponse, err error)

Get ...

func (ExpressRouteCrossConnectionsClient) List 

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

List ...

func (ExpressRouteCrossConnectionsClient) ListByResourceGroup 

func (c ExpressRouteCrossConnectionsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ExpressRouteCrossConnectionsClient) ListByResourceGroupComplete 

func (c ExpressRouteCrossConnectionsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (ExpressRouteCrossConnectionsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ExpressRouteCrossConnectionsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ExpressRouteCrossConnectionOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ExpressRouteCrossConnectionsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ExpressRouteCrossConnectionsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ExpressRouteCrossConnectionsClient) UpdateTags 

func (c ExpressRouteCrossConnectionsClient) UpdateTags(ctx context.Context, id ExpressRouteCrossConnectionId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

type ExpressRoutePeeringState 

type ExpressRoutePeeringState string
const (
	ExpressRoutePeeringStateDisabled ExpressRoutePeeringState = "Disabled"
	ExpressRoutePeeringStateEnabled  ExpressRoutePeeringState = "Enabled"
)

func (*ExpressRoutePeeringState) UnmarshalJSON 

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

type ExpressRoutePeeringType 

type ExpressRoutePeeringType string
const (
	ExpressRoutePeeringTypeAzurePrivatePeering ExpressRoutePeeringType = "AzurePrivatePeering"
	ExpressRoutePeeringTypeAzurePublicPeering  ExpressRoutePeeringType = "AzurePublicPeering"
	ExpressRoutePeeringTypeMicrosoftPeering    ExpressRoutePeeringType = "MicrosoftPeering"
)

func (*ExpressRoutePeeringType) UnmarshalJSON 

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

type GetOperationResponse 

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

type IPv6ExpressRouteCircuitPeeringConfig 

type IPv6ExpressRouteCircuitPeeringConfig struct {
	MicrosoftPeeringConfig     *ExpressRouteCircuitPeeringConfig `json:"microsoftPeeringConfig,omitempty"`
	PrimaryPeerAddressPrefix   *string                           `json:"primaryPeerAddressPrefix,omitempty"`
	RouteFilter                *SubResource                      `json:"routeFilter,omitempty"`
	SecondaryPeerAddressPrefix *string                           `json:"secondaryPeerAddressPrefix,omitempty"`
	State                      *ExpressRouteCircuitPeeringState  `json:"state,omitempty"`
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ExpressRouteCrossConnection
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ExpressRouteCrossConnection
}

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

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

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

type ServiceProviderProvisioningState 

type ServiceProviderProvisioningState string
const (
	ServiceProviderProvisioningStateDeprovisioning ServiceProviderProvisioningState = "Deprovisioning"
	ServiceProviderProvisioningStateNotProvisioned ServiceProviderProvisioningState = "NotProvisioned"
	ServiceProviderProvisioningStateProvisioned    ServiceProviderProvisioningState = "Provisioned"
	ServiceProviderProvisioningStateProvisioning   ServiceProviderProvisioningState = "Provisioning"
)

func (*ServiceProviderProvisioningState) UnmarshalJSON 

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

type SubResource 

type SubResource struct {
	Id *string `json:"id,omitempty"`
}

type TagsObject 

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse 

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteCrossConnection
}

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.