expressroutegateways

package
v0.20231018.1165214 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-05-01/expressroutegateways Documentation

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

Client Initialization

client := expressroutegateways.NewExpressRouteGatewaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteGatewaysClient.CreateOrUpdate

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

payload := expressroutegateways.ExpressRouteGateway{
	// ...
}


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

Example Usage: ExpressRouteGatewaysClient.Delete

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

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

Example Usage: ExpressRouteGatewaysClient.Get

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

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: ExpressRouteGatewaysClient.ListByResourceGroup

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

read, err := client.ListByResourceGroup(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ExpressRouteGatewaysClient.ListBySubscription

ctx := context.TODO()
id := expressroutegateways.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.ListBySubscription(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ExpressRouteGatewaysClient.UpdateTags

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

payload := expressroutegateways.TagsObject{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForVnetLocalRouteOverrideCriteria 

func PossibleValuesForVnetLocalRouteOverrideCriteria() []string

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
}

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 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 ExpressRouteGateway 

type ExpressRouteGateway struct {
	Etag       *string                        `json:"etag,omitempty"`
	Id         *string                        `json:"id,omitempty"`
	Location   *string                        `json:"location,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *ExpressRouteGatewayProperties `json:"properties,omitempty"`
	Tags       *map[string]string             `json:"tags,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

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) 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 ExpressRouteGatewayList 

type ExpressRouteGatewayList struct {
	Value *[]ExpressRouteGateway `json:"value,omitempty"`
}

type ExpressRouteGatewayProperties 

type ExpressRouteGatewayProperties struct {
	AllowNonVirtualWanTraffic *bool                                                `json:"allowNonVirtualWanTraffic,omitempty"`
	AutoScaleConfiguration    *ExpressRouteGatewayPropertiesAutoScaleConfiguration `json:"autoScaleConfiguration,omitempty"`
	ExpressRouteConnections   *[]ExpressRouteConnection                            `json:"expressRouteConnections,omitempty"`
	ProvisioningState         *ProvisioningState                                   `json:"provisioningState,omitempty"`
	VirtualHub                VirtualHubId                                         `json:"virtualHub"`
}

type ExpressRouteGatewayPropertiesAutoScaleConfiguration 

type ExpressRouteGatewayPropertiesAutoScaleConfiguration struct {
	Bounds *ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds `json:"bounds,omitempty"`
}

type ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds 

type ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds struct {
	Max *int64 `json:"max,omitempty"`
	Min *int64 `json:"min,omitempty"`
}

type ExpressRouteGatewaysClient 

type ExpressRouteGatewaysClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteGatewaysClientWithBaseURI 

func NewExpressRouteGatewaysClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteGatewaysClient, error)

func (ExpressRouteGatewaysClient) CreateOrUpdate 

func (c ExpressRouteGatewaysClient) CreateOrUpdate(ctx context.Context, id ExpressRouteGatewayId, input ExpressRouteGateway) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ExpressRouteGatewaysClient) CreateOrUpdateThenPoll 

func (c ExpressRouteGatewaysClient) CreateOrUpdateThenPoll(ctx context.Context, id ExpressRouteGatewayId, input ExpressRouteGateway) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ExpressRouteGatewaysClient) Delete 

func (c ExpressRouteGatewaysClient) Delete(ctx context.Context, id ExpressRouteGatewayId) (result DeleteOperationResponse, err error)

Delete ...

func (ExpressRouteGatewaysClient) DeleteThenPoll 

func (c ExpressRouteGatewaysClient) DeleteThenPoll(ctx context.Context, id ExpressRouteGatewayId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ExpressRouteGatewaysClient) Get 

func (c ExpressRouteGatewaysClient) Get(ctx context.Context, id ExpressRouteGatewayId) (result GetOperationResponse, err error)

Get ...

func (ExpressRouteGatewaysClient) ListByResourceGroup 

func (c ExpressRouteGatewaysClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ExpressRouteGatewaysClient) ListBySubscription 

func (c ExpressRouteGatewaysClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (ExpressRouteGatewaysClient) UpdateTags 

func (c ExpressRouteGatewaysClient) UpdateTags(ctx context.Context, id ExpressRouteGatewayId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

func (ExpressRouteGatewaysClient) UpdateTagsThenPoll 

func (c ExpressRouteGatewaysClient) UpdateTagsThenPoll(ctx context.Context, id ExpressRouteGatewayId, input TagsObject) error

UpdateTagsThenPoll performs UpdateTags then polls until it's completed

type GetOperationResponse 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteGatewayList
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteGatewayList
}

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 TagsObject 

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse 

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

type VirtualHubId 

type VirtualHubId 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.