expressroutecircuitpeerings

package
v0.20240321.1111417 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The expressroutecircuitpeerings 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/expressroutecircuitpeerings"

Client Initialization

client := expressroutecircuitpeerings.NewExpressRouteCircuitPeeringsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteCircuitPeeringsClient.CreateOrUpdate

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

payload := expressroutecircuitpeerings.ExpressRouteCircuitPeering{
	// ...
}


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

Example Usage: ExpressRouteCircuitPeeringsClient.Delete

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

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

Example Usage: ExpressRouteCircuitPeeringsClient.Get

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

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

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

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

func PossibleValuesForCircuitConnectionStatus() []string

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 ValidateExpressRouteCircuitID

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

ValidateExpressRouteCircuitID checks that 'input' can be parsed as a Express Route Circuit ID

Types

type CircuitConnectionStatus

type CircuitConnectionStatus string
const (
	CircuitConnectionStatusConnected    CircuitConnectionStatus = "Connected"
	CircuitConnectionStatusConnecting   CircuitConnectionStatus = "Connecting"
	CircuitConnectionStatusDisconnected CircuitConnectionStatus = "Disconnected"
)

func (*CircuitConnectionStatus) UnmarshalJSON

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

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type ExpressRouteCircuitConnection

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

type ExpressRouteCircuitConnectionPropertiesFormat

type ExpressRouteCircuitConnectionPropertiesFormat struct {
	AddressPrefix                  *string                      `json:"addressPrefix,omitempty"`
	AuthorizationKey               *string                      `json:"authorizationKey,omitempty"`
	CircuitConnectionStatus        *CircuitConnectionStatus     `json:"circuitConnectionStatus,omitempty"`
	ExpressRouteCircuitPeering     *SubResource                 `json:"expressRouteCircuitPeering,omitempty"`
	IPv6CircuitConnectionConfig    *IPv6CircuitConnectionConfig `json:"ipv6CircuitConnectionConfig,omitempty"`
	PeerExpressRouteCircuitPeering *SubResource                 `json:"peerExpressRouteCircuitPeering,omitempty"`
	ProvisioningState              *ProvisioningState           `json:"provisioningState,omitempty"`
}

type ExpressRouteCircuitId

type ExpressRouteCircuitId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ExpressRouteCircuitName string
}

ExpressRouteCircuitId is a struct representing the Resource ID for a Express Route Circuit

func NewExpressRouteCircuitID

func NewExpressRouteCircuitID(subscriptionId string, resourceGroupName string, expressRouteCircuitName string) ExpressRouteCircuitId

NewExpressRouteCircuitID returns a new ExpressRouteCircuitId struct

func ParseExpressRouteCircuitID

func ParseExpressRouteCircuitID(input string) (*ExpressRouteCircuitId, error)

ParseExpressRouteCircuitID parses 'input' into a ExpressRouteCircuitId

func ParseExpressRouteCircuitIDInsensitively

func ParseExpressRouteCircuitIDInsensitively(input string) (*ExpressRouteCircuitId, error)

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

func (*ExpressRouteCircuitId) FromParseResult

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

func (ExpressRouteCircuitId) ID

func (id ExpressRouteCircuitId) ID() string

ID returns the formatted Express Route Circuit ID

func (ExpressRouteCircuitId) Segments

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

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

func (ExpressRouteCircuitId) String

func (id ExpressRouteCircuitId) String() string

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

type ExpressRouteCircuitPeering

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

type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

func (*ExpressRouteCircuitPeeringAdvertisedPublicPrefixState) UnmarshalJSON

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 ExpressRouteCircuitPeeringOperationPredicate

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

func (ExpressRouteCircuitPeeringOperationPredicate) Matches

type ExpressRouteCircuitPeeringPropertiesFormat

type ExpressRouteCircuitPeeringPropertiesFormat struct {
	AzureASN                   *int64                                `json:"azureASN,omitempty"`
	Connections                *[]ExpressRouteCircuitConnection      `json:"connections,omitempty"`
	ExpressRouteConnection     *ExpressRouteConnectionId             `json:"expressRouteConnection,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"`
	PeeredConnections          *[]PeerExpressRouteCircuitConnection  `json:"peeredConnections,omitempty"`
	PeeringType                *ExpressRoutePeeringType              `json:"peeringType,omitempty"`
	PrimaryAzurePort           *string                               `json:"primaryAzurePort,omitempty"`
	PrimaryPeerAddressPrefix   *string                               `json:"primaryPeerAddressPrefix,omitempty"`
	ProvisioningState          *ProvisioningState                    `json:"provisioningState,omitempty"`
	RouteFilter                *SubResource                          `json:"routeFilter,omitempty"`
	SecondaryAzurePort         *string                               `json:"secondaryAzurePort,omitempty"`
	SecondaryPeerAddressPrefix *string                               `json:"secondaryPeerAddressPrefix,omitempty"`
	SharedKey                  *string                               `json:"sharedKey,omitempty"`
	State                      *ExpressRoutePeeringState             `json:"state,omitempty"`
	Stats                      *ExpressRouteCircuitStats             `json:"stats,omitempty"`
	VlanId                     *int64                                `json:"vlanId,omitempty"`
}

type ExpressRouteCircuitPeeringState

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

func (*ExpressRouteCircuitPeeringState) UnmarshalJSON

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

type ExpressRouteCircuitPeeringsClient

type ExpressRouteCircuitPeeringsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteCircuitPeeringsClientWithBaseURI

func NewExpressRouteCircuitPeeringsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteCircuitPeeringsClient, error)

func (ExpressRouteCircuitPeeringsClient) CreateOrUpdate

CreateOrUpdate ...

func (ExpressRouteCircuitPeeringsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ExpressRouteCircuitPeeringsClient) Delete

Delete ...

func (ExpressRouteCircuitPeeringsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ExpressRouteCircuitPeeringsClient) Get

Get ...

func (ExpressRouteCircuitPeeringsClient) List

List ...

func (ExpressRouteCircuitPeeringsClient) ListComplete

ListComplete retrieves all the results into a single object

func (ExpressRouteCircuitPeeringsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ExpressRouteCircuitStats

type ExpressRouteCircuitStats struct {
	PrimarybytesIn    *int64 `json:"primarybytesIn,omitempty"`
	PrimarybytesOut   *int64 `json:"primarybytesOut,omitempty"`
	SecondarybytesIn  *int64 `json:"secondarybytesIn,omitempty"`
	SecondarybytesOut *int64 `json:"secondarybytesOut,omitempty"`
}

type ExpressRouteConnectionId

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

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        *ExpressRouteCircuitPeering
}

type IPv6CircuitConnectionConfig

type IPv6CircuitConnectionConfig struct {
	AddressPrefix           *string                  `json:"addressPrefix,omitempty"`
	CircuitConnectionStatus *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty"`
}

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 ListCompleteResult

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

type ListOperationResponse

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

type PeerExpressRouteCircuitConnection

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

type PeerExpressRouteCircuitConnectionPropertiesFormat

type PeerExpressRouteCircuitConnectionPropertiesFormat struct {
	AddressPrefix                  *string                  `json:"addressPrefix,omitempty"`
	AuthResourceGuid               *string                  `json:"authResourceGuid,omitempty"`
	CircuitConnectionStatus        *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty"`
	ConnectionName                 *string                  `json:"connectionName,omitempty"`
	ExpressRouteCircuitPeering     *SubResource             `json:"expressRouteCircuitPeering,omitempty"`
	PeerExpressRouteCircuitPeering *SubResource             `json:"peerExpressRouteCircuitPeering,omitempty"`
	ProvisioningState              *ProvisioningState       `json:"provisioningState,omitempty"`
}

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 SubResource

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL