peerexpressroutecircuitconnections

package
v0.20241118.1115603 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-03-01/peerexpressroutecircuitconnections Documentation

The peerexpressroutecircuitconnections SDK allows for interaction with Azure Resource Manager network (API Version 2024-03-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/2024-03-01/peerexpressroutecircuitconnections"

Client Initialization

client := peerexpressroutecircuitconnections.NewPeerExpressRouteCircuitConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PeerExpressRouteCircuitConnectionsClient.Get

ctx := context.TODO()
id := peerexpressroutecircuitconnections.NewPeerConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteCircuitName", "peeringName", "peerConnectionName")

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

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

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

func PossibleValuesForProvisioningState() []string

func ValidatePeerConnectionID 

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

ValidatePeerConnectionID checks that 'input' can be parsed as a Peer 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 GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

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        *[]PeerExpressRouteCircuitConnection
}

type PeerConnectionId 

type PeerConnectionId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ExpressRouteCircuitName string
	PeeringName             string
	PeerConnectionName      string
}

PeerConnectionId is a struct representing the Resource ID for a Peer Connection

func NewPeerConnectionID 

func NewPeerConnectionID(subscriptionId string, resourceGroupName string, expressRouteCircuitName string, peeringName string, peerConnectionName string) PeerConnectionId

NewPeerConnectionID returns a new PeerConnectionId struct

func ParsePeerConnectionID 

func ParsePeerConnectionID(input string) (*PeerConnectionId, error)

ParsePeerConnectionID parses 'input' into a PeerConnectionId

func ParsePeerConnectionIDInsensitively 

func ParsePeerConnectionIDInsensitively(input string) (*PeerConnectionId, error)

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

func (*PeerConnectionId) FromParseResult 

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

func (PeerConnectionId) ID 

func (id PeerConnectionId) ID() string

ID returns the formatted Peer Connection ID

func (PeerConnectionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Peer Connection ID

func (PeerConnectionId) String 

func (id PeerConnectionId) String() string

String returns a human-readable description of this Peer Connection ID

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 PeerExpressRouteCircuitConnectionOperationPredicate 

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

func (PeerExpressRouteCircuitConnectionOperationPredicate) Matches 

func (p PeerExpressRouteCircuitConnectionOperationPredicate) Matches(input PeerExpressRouteCircuitConnection) bool

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 PeerExpressRouteCircuitConnectionsClient 

type PeerExpressRouteCircuitConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewPeerExpressRouteCircuitConnectionsClientWithBaseURI 

func NewPeerExpressRouteCircuitConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PeerExpressRouteCircuitConnectionsClient, error)

func (PeerExpressRouteCircuitConnectionsClient) Get 

func (c PeerExpressRouteCircuitConnectionsClient) Get(ctx context.Context, id PeerConnectionId) (result GetOperationResponse, err error)

Get ...

func (PeerExpressRouteCircuitConnectionsClient) List 

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

List ...

func (PeerExpressRouteCircuitConnectionsClient) ListComplete 

func (c PeerExpressRouteCircuitConnectionsClient) ListComplete(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PeerExpressRouteCircuitConnectionsClient) ListCompleteMatchingPredicate 

func (c PeerExpressRouteCircuitConnectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId, predicate PeerExpressRouteCircuitConnectionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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

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.