README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/expressroutecrossconnectionpeerings
Documentation
The expressroutecrossconnectionpeerings
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-sdk/resource-manager/network/2023-06-01/expressroutecrossconnectionpeerings"
Client Initialization
client := expressroutecrossconnectionpeerings.NewExpressRouteCrossConnectionPeeringsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ExpressRouteCrossConnectionPeeringsClient.CreateOrUpdate
ctx := context.TODO()
id := expressroutecrossconnectionpeerings.NewPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCrossConnectionValue", "peeringValue")
payload := expressroutecrossconnectionpeerings.ExpressRouteCrossConnectionPeering{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ExpressRouteCrossConnectionPeeringsClient.Delete
ctx := context.TODO()
id := expressroutecrossconnectionpeerings.NewPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCrossConnectionValue", "peeringValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: ExpressRouteCrossConnectionPeeringsClient.Get
ctx := context.TODO()
id := expressroutecrossconnectionpeerings.NewPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCrossConnectionValue", "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: ExpressRouteCrossConnectionPeeringsClient.List
ctx := context.TODO()
id := expressroutecrossconnectionpeerings.NewExpressRouteCrossConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCrossConnectionValue")
// 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 PossibleValuesForExpressRouteCircuitPeeringAdvertisedPublicPrefixState() []string
- func PossibleValuesForExpressRouteCircuitPeeringState() []string
- func PossibleValuesForExpressRoutePeeringState() []string
- func PossibleValuesForExpressRoutePeeringType() []string
- func PossibleValuesForProvisioningState() []string
- func ValidateExpressRouteCrossConnectionID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePeeringID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState
- type ExpressRouteCircuitPeeringConfig
- type ExpressRouteCircuitPeeringState
- type ExpressRouteCrossConnectionId
- func NewExpressRouteCrossConnectionID(subscriptionId string, resourceGroupName string, ...) ExpressRouteCrossConnectionId
- func ParseExpressRouteCrossConnectionID(input string) (*ExpressRouteCrossConnectionId, error)
- func ParseExpressRouteCrossConnectionIDInsensitively(input string) (*ExpressRouteCrossConnectionId, error)
- type ExpressRouteCrossConnectionPeering
- type ExpressRouteCrossConnectionPeeringOperationPredicate
- type ExpressRouteCrossConnectionPeeringProperties
- type ExpressRouteCrossConnectionPeeringsClient
- func (c ExpressRouteCrossConnectionPeeringsClient) CreateOrUpdate(ctx context.Context, id PeeringId, input ExpressRouteCrossConnectionPeering) (result CreateOrUpdateOperationResponse, err error)
- func (c ExpressRouteCrossConnectionPeeringsClient) CreateOrUpdateThenPoll(ctx context.Context, id PeeringId, input ExpressRouteCrossConnectionPeering) error
- func (c ExpressRouteCrossConnectionPeeringsClient) Delete(ctx context.Context, id PeeringId) (result DeleteOperationResponse, err error)
- func (c ExpressRouteCrossConnectionPeeringsClient) DeleteThenPoll(ctx context.Context, id PeeringId) error
- func (c ExpressRouteCrossConnectionPeeringsClient) Get(ctx context.Context, id PeeringId) (result GetOperationResponse, err error)
- func (c ExpressRouteCrossConnectionPeeringsClient) List(ctx context.Context, id ExpressRouteCrossConnectionId) (result ListOperationResponse, err error)
- func (c ExpressRouteCrossConnectionPeeringsClient) ListComplete(ctx context.Context, id ExpressRouteCrossConnectionId) (ListCompleteResult, error)
- func (c ExpressRouteCrossConnectionPeeringsClient) ListCompleteMatchingPredicate(ctx context.Context, id ExpressRouteCrossConnectionId, ...) (result ListCompleteResult, err error)
- type ExpressRoutePeeringState
- type ExpressRoutePeeringType
- type GetOperationResponse
- type IPv6ExpressRouteCircuitPeeringConfig
- type ListCompleteResult
- type ListOperationResponse
- type PeeringId
- type ProvisioningState
- type SubResource
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 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
func ValidatePeeringID ¶
ValidatePeeringID checks that 'input' can be parsed as a Peering ID
Types ¶
type DeleteOperationResponse ¶
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 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 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 ExpressRouteCrossConnectionPeeringOperationPredicate ¶
type ExpressRouteCrossConnectionPeeringOperationPredicate struct { Etag *string Id *string Name *string }
func (ExpressRouteCrossConnectionPeeringOperationPredicate) Matches ¶
func (p ExpressRouteCrossConnectionPeeringOperationPredicate) Matches(input ExpressRouteCrossConnectionPeering) bool
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"` State *ExpressRoutePeeringState `json:"state,omitempty"` VlanId *int64 `json:"vlanId,omitempty"` }
type ExpressRouteCrossConnectionPeeringsClient ¶
type ExpressRouteCrossConnectionPeeringsClient struct {
Client *resourcemanager.Client
}
func NewExpressRouteCrossConnectionPeeringsClientWithBaseURI ¶
func NewExpressRouteCrossConnectionPeeringsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteCrossConnectionPeeringsClient, error)
func (ExpressRouteCrossConnectionPeeringsClient) CreateOrUpdate ¶
func (c ExpressRouteCrossConnectionPeeringsClient) CreateOrUpdate(ctx context.Context, id PeeringId, input ExpressRouteCrossConnectionPeering) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (ExpressRouteCrossConnectionPeeringsClient) CreateOrUpdateThenPoll ¶
func (c ExpressRouteCrossConnectionPeeringsClient) CreateOrUpdateThenPoll(ctx context.Context, id PeeringId, input ExpressRouteCrossConnectionPeering) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (ExpressRouteCrossConnectionPeeringsClient) Delete ¶
func (c ExpressRouteCrossConnectionPeeringsClient) Delete(ctx context.Context, id PeeringId) (result DeleteOperationResponse, err error)
Delete ...
func (ExpressRouteCrossConnectionPeeringsClient) DeleteThenPoll ¶
func (c ExpressRouteCrossConnectionPeeringsClient) DeleteThenPoll(ctx context.Context, id PeeringId) error
DeleteThenPoll performs Delete then polls until it's completed
func (ExpressRouteCrossConnectionPeeringsClient) Get ¶
func (c ExpressRouteCrossConnectionPeeringsClient) Get(ctx context.Context, id PeeringId) (result GetOperationResponse, err error)
Get ...
func (ExpressRouteCrossConnectionPeeringsClient) List ¶
func (c ExpressRouteCrossConnectionPeeringsClient) List(ctx context.Context, id ExpressRouteCrossConnectionId) (result ListOperationResponse, err error)
List ...
func (ExpressRouteCrossConnectionPeeringsClient) ListComplete ¶
func (c ExpressRouteCrossConnectionPeeringsClient) ListComplete(ctx context.Context, id ExpressRouteCrossConnectionId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (ExpressRouteCrossConnectionPeeringsClient) ListCompleteMatchingPredicate ¶
func (c ExpressRouteCrossConnectionPeeringsClient) ListCompleteMatchingPredicate(ctx context.Context, id ExpressRouteCrossConnectionId, predicate ExpressRouteCrossConnectionPeeringOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
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 *ExpressRouteCrossConnectionPeering }
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 []ExpressRouteCrossConnectionPeering }
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]ExpressRouteCrossConnectionPeering }
type PeeringId ¶
type PeeringId struct { SubscriptionId string ResourceGroupName string ExpressRouteCrossConnectionName string PeeringName string }
PeeringId is a struct representing the Resource ID for a Peering
func NewPeeringID ¶
func NewPeeringID(subscriptionId string, resourceGroupName string, expressRouteCrossConnectionName string, peeringName string) PeeringId
NewPeeringID returns a new PeeringId struct
func ParsePeeringID ¶
ParsePeeringID parses 'input' into a PeeringId
func ParsePeeringIDInsensitively ¶
ParsePeeringIDInsensitively parses 'input' case-insensitively into a PeeringId note: this method should only be used for API response data and not user input
func (*PeeringId) FromParseResult ¶
func (id *PeeringId) FromParseResult(input resourceids.ParseResult) error
func (PeeringId) Segments ¶
func (id PeeringId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Peering ID
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"`
}
Source Files ¶
- client.go
- constants.go
- id_expressroutecrossconnection.go
- id_peering.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- model_expressroutecircuitpeeringconfig.go
- model_expressroutecrossconnectionpeering.go
- model_expressroutecrossconnectionpeeringproperties.go
- model_ipv6expressroutecircuitpeeringconfig.go
- model_subresource.go
- predicates.go
- version.go