README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-05-01/expressroutecircuitconnections
Documentation
The expressroutecircuitconnections
SDK allows for interaction with the Azure Resource Manager Service network
(API Version 2023-05-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-05-01/expressroutecircuitconnections"
Client Initialization
client := expressroutecircuitconnections.NewExpressRouteCircuitConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ExpressRouteCircuitConnectionsClient.CreateOrUpdate
ctx := context.TODO()
id := expressroutecircuitconnections.NewPeeringConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue", "peeringValue", "connectionValue")
payload := expressroutecircuitconnections.ExpressRouteCircuitConnection{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ExpressRouteCircuitConnectionsClient.Delete
ctx := context.TODO()
id := expressroutecircuitconnections.NewPeeringConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue", "peeringValue", "connectionValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: ExpressRouteCircuitConnectionsClient.Get
ctx := context.TODO()
id := expressroutecircuitconnections.NewPeeringConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue", "peeringValue", "connectionValue")
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: ExpressRouteCircuitConnectionsClient.List
ctx := context.TODO()
id := expressroutecircuitconnections.NewExpressRouteCircuitPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitValue", "peeringValue")
// 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 PossibleValuesForCircuitConnectionStatus() []string
- func PossibleValuesForProvisioningState() []string
- func ValidatePeeringConnectionID(input interface{}, key string) (warnings []string, errors []error)
- type CircuitConnectionStatus
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type ExpressRouteCircuitConnection
- type ExpressRouteCircuitConnectionOperationPredicate
- type ExpressRouteCircuitConnectionPropertiesFormat
- type ExpressRouteCircuitConnectionsClient
- func (c ExpressRouteCircuitConnectionsClient) CreateOrUpdate(ctx context.Context, id PeeringConnectionId, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c ExpressRouteCircuitConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id PeeringConnectionId, ...) error
- func (c ExpressRouteCircuitConnectionsClient) Delete(ctx context.Context, id PeeringConnectionId) (result DeleteOperationResponse, err error)
- func (c ExpressRouteCircuitConnectionsClient) DeleteThenPoll(ctx context.Context, id PeeringConnectionId) error
- func (c ExpressRouteCircuitConnectionsClient) Get(ctx context.Context, id PeeringConnectionId) (result GetOperationResponse, err error)
- func (c ExpressRouteCircuitConnectionsClient) List(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId) (result ListOperationResponse, err error)
- func (c ExpressRouteCircuitConnectionsClient) ListComplete(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId) (ListCompleteResult, error)
- func (c ExpressRouteCircuitConnectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId, ...) (result ListCompleteResult, err error)
- type GetOperationResponse
- type IPv6CircuitConnectionConfig
- type ListCompleteResult
- type ListOperationResponse
- type PeeringConnectionId
- type ProvisioningState
- type SubResource
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForCircuitConnectionStatus ¶
func PossibleValuesForCircuitConnectionStatus() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidatePeeringConnectionID ¶
ValidatePeeringConnectionID checks that 'input' can be parsed as a Peering Connection 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 DeleteOperationResponse ¶
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 ExpressRouteCircuitConnectionOperationPredicate ¶
type ExpressRouteCircuitConnectionOperationPredicate struct { Etag *string Id *string Name *string Type *string }
func (ExpressRouteCircuitConnectionOperationPredicate) Matches ¶
func (p ExpressRouteCircuitConnectionOperationPredicate) Matches(input ExpressRouteCircuitConnection) bool
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 ExpressRouteCircuitConnectionsClient ¶
type ExpressRouteCircuitConnectionsClient struct {
Client *resourcemanager.Client
}
func NewExpressRouteCircuitConnectionsClientWithBaseURI ¶
func NewExpressRouteCircuitConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteCircuitConnectionsClient, error)
func (ExpressRouteCircuitConnectionsClient) CreateOrUpdate ¶
func (c ExpressRouteCircuitConnectionsClient) CreateOrUpdate(ctx context.Context, id PeeringConnectionId, input ExpressRouteCircuitConnection) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (ExpressRouteCircuitConnectionsClient) CreateOrUpdateThenPoll ¶
func (c ExpressRouteCircuitConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id PeeringConnectionId, input ExpressRouteCircuitConnection) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (ExpressRouteCircuitConnectionsClient) Delete ¶
func (c ExpressRouteCircuitConnectionsClient) Delete(ctx context.Context, id PeeringConnectionId) (result DeleteOperationResponse, err error)
Delete ...
func (ExpressRouteCircuitConnectionsClient) DeleteThenPoll ¶
func (c ExpressRouteCircuitConnectionsClient) DeleteThenPoll(ctx context.Context, id PeeringConnectionId) error
DeleteThenPoll performs Delete then polls until it's completed
func (ExpressRouteCircuitConnectionsClient) Get ¶
func (c ExpressRouteCircuitConnectionsClient) Get(ctx context.Context, id PeeringConnectionId) (result GetOperationResponse, err error)
Get ...
func (ExpressRouteCircuitConnectionsClient) List ¶
func (c ExpressRouteCircuitConnectionsClient) List(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId) (result ListOperationResponse, err error)
List ...
func (ExpressRouteCircuitConnectionsClient) ListComplete ¶
func (c ExpressRouteCircuitConnectionsClient) ListComplete(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (ExpressRouteCircuitConnectionsClient) ListCompleteMatchingPredicate ¶
func (c ExpressRouteCircuitConnectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId, predicate ExpressRouteCircuitConnectionOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ExpressRouteCircuitConnection }
type IPv6CircuitConnectionConfig ¶
type IPv6CircuitConnectionConfig struct { AddressPrefix *string `json:"addressPrefix,omitempty"` CircuitConnectionStatus *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty"` }
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []ExpressRouteCircuitConnection
}
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]ExpressRouteCircuitConnection }
type PeeringConnectionId ¶
type PeeringConnectionId struct { SubscriptionId string ResourceGroupName string ExpressRouteCircuitName string PeeringName string ConnectionName string }
PeeringConnectionId is a struct representing the Resource ID for a Peering Connection
func NewPeeringConnectionID ¶
func NewPeeringConnectionID(subscriptionId string, resourceGroupName string, expressRouteCircuitName string, peeringName string, connectionName string) PeeringConnectionId
NewPeeringConnectionID returns a new PeeringConnectionId struct
func ParsePeeringConnectionID ¶
func ParsePeeringConnectionID(input string) (*PeeringConnectionId, error)
ParsePeeringConnectionID parses 'input' into a PeeringConnectionId
func ParsePeeringConnectionIDInsensitively ¶
func ParsePeeringConnectionIDInsensitively(input string) (*PeeringConnectionId, error)
ParsePeeringConnectionIDInsensitively parses 'input' case-insensitively into a PeeringConnectionId note: this method should only be used for API response data and not user input
func (*PeeringConnectionId) FromParseResult ¶ added in v0.20231127.1171502
func (id *PeeringConnectionId) FromParseResult(input resourceids.ParseResult) error
func (PeeringConnectionId) ID ¶
func (id PeeringConnectionId) ID() string
ID returns the formatted Peering Connection ID
func (PeeringConnectionId) Segments ¶
func (id PeeringConnectionId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Peering Connection ID
func (PeeringConnectionId) String ¶
func (id PeeringConnectionId) String() string
String returns a human-readable description of this Peering Connection 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"`
}