expressrouteconnections

package
v0.20241212.1154051 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

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

The expressrouteconnections 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-sdk/resource-manager/network/2024-03-01/expressrouteconnections"

Client Initialization

client := expressrouteconnections.NewExpressRouteConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteConnectionsClient.CreateOrUpdate

ctx := context.TODO()
id := expressrouteconnections.NewExpressRouteConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteGatewayName", "expressRouteConnectionName")

payload := expressrouteconnections.ExpressRouteConnection{
	// ...
}


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

Example Usage: ExpressRouteConnectionsClient.Delete

ctx := context.TODO()
id := expressrouteconnections.NewExpressRouteConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteGatewayName", "expressRouteConnectionName")

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

Example Usage: ExpressRouteConnectionsClient.Get

ctx := context.TODO()
id := expressrouteconnections.NewExpressRouteConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRouteGatewayName", "expressRouteConnectionName")

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

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

read, err := client.List(ctx, id)
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 PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForVnetLocalRouteOverrideCriteria 

func PossibleValuesForVnetLocalRouteOverrideCriteria() []string

func ValidateExpressRouteConnectionID 

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

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

func ValidateExpressRouteGatewayID 

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

ValidateExpressRouteGatewayID checks that 'input' can be parsed as a Express Route Gateway ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type ExpressRouteCircuitPeeringId 

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

type ExpressRouteConnection 

type ExpressRouteConnection struct {
	Id         *string                           `json:"id,omitempty"`
	Name       string                            `json:"name"`
	Properties *ExpressRouteConnectionProperties `json:"properties,omitempty"`
}

type ExpressRouteConnectionId 

type ExpressRouteConnectionId struct {
	SubscriptionId             string
	ResourceGroupName          string
	ExpressRouteGatewayName    string
	ExpressRouteConnectionName string
}

ExpressRouteConnectionId is a struct representing the Resource ID for a Express Route Connection

func NewExpressRouteConnectionID 

func NewExpressRouteConnectionID(subscriptionId string, resourceGroupName string, expressRouteGatewayName string, expressRouteConnectionName string) ExpressRouteConnectionId

NewExpressRouteConnectionID returns a new ExpressRouteConnectionId struct

func ParseExpressRouteConnectionID 

func ParseExpressRouteConnectionID(input string) (*ExpressRouteConnectionId, error)

ParseExpressRouteConnectionID parses 'input' into a ExpressRouteConnectionId

func ParseExpressRouteConnectionIDInsensitively 

func ParseExpressRouteConnectionIDInsensitively(input string) (*ExpressRouteConnectionId, error)

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

func (*ExpressRouteConnectionId) FromParseResult 

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

func (ExpressRouteConnectionId) ID 

func (id ExpressRouteConnectionId) ID() string

ID returns the formatted Express Route Connection ID

func (ExpressRouteConnectionId) Segments 

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

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

func (ExpressRouteConnectionId) String 

func (id ExpressRouteConnectionId) String() string

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

type ExpressRouteConnectionList 

type ExpressRouteConnectionList struct {
	Value *[]ExpressRouteConnection `json:"value,omitempty"`
}

type ExpressRouteConnectionProperties 

type ExpressRouteConnectionProperties struct {
	AuthorizationKey           *string                      `json:"authorizationKey,omitempty"`
	EnableInternetSecurity     *bool                        `json:"enableInternetSecurity,omitempty"`
	EnablePrivateLinkFastPath  *bool                        `json:"enablePrivateLinkFastPath,omitempty"`
	ExpressRouteCircuitPeering ExpressRouteCircuitPeeringId `json:"expressRouteCircuitPeering"`
	ExpressRouteGatewayBypass  *bool                        `json:"expressRouteGatewayBypass,omitempty"`
	ProvisioningState          *ProvisioningState           `json:"provisioningState,omitempty"`
	RoutingConfiguration       *RoutingConfiguration        `json:"routingConfiguration,omitempty"`
	RoutingWeight              *int64                       `json:"routingWeight,omitempty"`
}

type ExpressRouteConnectionsClient 

type ExpressRouteConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteConnectionsClientWithBaseURI 

func NewExpressRouteConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteConnectionsClient, error)

func (ExpressRouteConnectionsClient) CreateOrUpdate 

func (c ExpressRouteConnectionsClient) CreateOrUpdate(ctx context.Context, id ExpressRouteConnectionId, input ExpressRouteConnection) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ExpressRouteConnectionsClient) CreateOrUpdateThenPoll 

func (c ExpressRouteConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ExpressRouteConnectionId, input ExpressRouteConnection) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ExpressRouteConnectionsClient) Delete 

func (c ExpressRouteConnectionsClient) Delete(ctx context.Context, id ExpressRouteConnectionId) (result DeleteOperationResponse, err error)

Delete ...

func (ExpressRouteConnectionsClient) DeleteThenPoll 

func (c ExpressRouteConnectionsClient) DeleteThenPoll(ctx context.Context, id ExpressRouteConnectionId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ExpressRouteConnectionsClient) Get 

func (c ExpressRouteConnectionsClient) Get(ctx context.Context, id ExpressRouteConnectionId) (result GetOperationResponse, err error)

Get ...

func (ExpressRouteConnectionsClient) List 

func (c ExpressRouteConnectionsClient) List(ctx context.Context, id ExpressRouteGatewayId) (result ListOperationResponse, err error)

List ...

type ExpressRouteGatewayId 

type ExpressRouteGatewayId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ExpressRouteGatewayName string
}

ExpressRouteGatewayId is a struct representing the Resource ID for a Express Route Gateway

func NewExpressRouteGatewayID 

func NewExpressRouteGatewayID(subscriptionId string, resourceGroupName string, expressRouteGatewayName string) ExpressRouteGatewayId

NewExpressRouteGatewayID returns a new ExpressRouteGatewayId struct

func ParseExpressRouteGatewayID 

func ParseExpressRouteGatewayID(input string) (*ExpressRouteGatewayId, error)

ParseExpressRouteGatewayID parses 'input' into a ExpressRouteGatewayId

func ParseExpressRouteGatewayIDInsensitively 

func ParseExpressRouteGatewayIDInsensitively(input string) (*ExpressRouteGatewayId, error)

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

func (*ExpressRouteGatewayId) FromParseResult 

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

func (ExpressRouteGatewayId) ID 

func (id ExpressRouteGatewayId) ID() string

ID returns the formatted Express Route Gateway ID

func (ExpressRouteGatewayId) Segments 

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

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

func (ExpressRouteGatewayId) String 

func (id ExpressRouteGatewayId) String() string

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

type GetOperationResponse 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteConnectionList
}

type PropagatedRouteTable 

type PropagatedRouteTable struct {
	Ids    *[]SubResource `json:"ids,omitempty"`
	Labels *[]string      `json:"labels,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 RoutingConfiguration 

type RoutingConfiguration struct {
	AssociatedRouteTable  *SubResource          `json:"associatedRouteTable,omitempty"`
	InboundRouteMap       *SubResource          `json:"inboundRouteMap,omitempty"`
	OutboundRouteMap      *SubResource          `json:"outboundRouteMap,omitempty"`
	PropagatedRouteTables *PropagatedRouteTable `json:"propagatedRouteTables,omitempty"`
	VnetRoutes            *VnetRoute            `json:"vnetRoutes,omitempty"`
}

type StaticRoute 

type StaticRoute struct {
	AddressPrefixes  *[]string `json:"addressPrefixes,omitempty"`
	Name             *string   `json:"name,omitempty"`
	NextHopIPAddress *string   `json:"nextHopIpAddress,omitempty"`
}

type StaticRoutesConfig 

type StaticRoutesConfig struct {
	PropagateStaticRoutes          *bool                           `json:"propagateStaticRoutes,omitempty"`
	VnetLocalRouteOverrideCriteria *VnetLocalRouteOverrideCriteria `json:"vnetLocalRouteOverrideCriteria,omitempty"`
}

type SubResource 

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

type VnetLocalRouteOverrideCriteria 

type VnetLocalRouteOverrideCriteria string
const (
	VnetLocalRouteOverrideCriteriaContains VnetLocalRouteOverrideCriteria = "Contains"
	VnetLocalRouteOverrideCriteriaEqual    VnetLocalRouteOverrideCriteria = "Equal"
)

func (*VnetLocalRouteOverrideCriteria) UnmarshalJSON 

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

type VnetRoute 

type VnetRoute struct {
	BgpConnections     *[]SubResource      `json:"bgpConnections,omitempty"`
	StaticRoutes       *[]StaticRoute      `json:"staticRoutes,omitempty"`
	StaticRoutesConfig *StaticRoutesConfig `json:"staticRoutesConfig,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.