expressroutelinks

package
v0.20240620.1161515 Latest Latest
Warning

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

Go to latest
Published: Jun 20, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

The expressroutelinks SDK allows for interaction with the Azure Resource Manager Service network (API Version 2022-07-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/2022-07-01/expressroutelinks"

Client Initialization

client := expressroutelinks.NewExpressRouteLinksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteLinksClient.Get

ctx := context.TODO()
id := expressroutelinks.NewLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "expressRoutePortValue", "linkValue")

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

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

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

func PossibleValuesForExpressRouteLinkAdminState() []string

func PossibleValuesForExpressRouteLinkConnectorType

func PossibleValuesForExpressRouteLinkConnectorType() []string

func PossibleValuesForExpressRouteLinkMacSecCipher

func PossibleValuesForExpressRouteLinkMacSecCipher() []string

func PossibleValuesForExpressRouteLinkMacSecSciState

func PossibleValuesForExpressRouteLinkMacSecSciState() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateExpressRoutePortID

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

ValidateExpressRoutePortID checks that 'input' can be parsed as a Express Route Port ID

func ValidateLinkID

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

ValidateLinkID checks that 'input' can be parsed as a Link ID

Types

type ExpressRouteLink struct {
	Etag       *string                           `json:"etag,omitempty"`
	Id         *string                           `json:"id,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *ExpressRouteLinkPropertiesFormat `json:"properties,omitempty"`
}

type ExpressRouteLinkAdminState

type ExpressRouteLinkAdminState string
const (
	ExpressRouteLinkAdminStateDisabled ExpressRouteLinkAdminState = "Disabled"
	ExpressRouteLinkAdminStateEnabled  ExpressRouteLinkAdminState = "Enabled"
)

func (*ExpressRouteLinkAdminState) UnmarshalJSON

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

type ExpressRouteLinkConnectorType

type ExpressRouteLinkConnectorType string
const (
	ExpressRouteLinkConnectorTypeLC ExpressRouteLinkConnectorType = "LC"
	ExpressRouteLinkConnectorTypeSC ExpressRouteLinkConnectorType = "SC"
)

func (*ExpressRouteLinkConnectorType) UnmarshalJSON

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

type ExpressRouteLinkMacSecCipher

type ExpressRouteLinkMacSecCipher string
const (
	ExpressRouteLinkMacSecCipherGcmAesOneTwoEight    ExpressRouteLinkMacSecCipher = "GcmAes128"
	ExpressRouteLinkMacSecCipherGcmAesTwoFiveSix     ExpressRouteLinkMacSecCipher = "GcmAes256"
	ExpressRouteLinkMacSecCipherGcmAesXpnOneTwoEight ExpressRouteLinkMacSecCipher = "GcmAesXpn128"
	ExpressRouteLinkMacSecCipherGcmAesXpnTwoFiveSix  ExpressRouteLinkMacSecCipher = "GcmAesXpn256"
)

func (*ExpressRouteLinkMacSecCipher) UnmarshalJSON

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

type ExpressRouteLinkMacSecConfig

type ExpressRouteLinkMacSecConfig struct {
	CakSecretIdentifier *string                         `json:"cakSecretIdentifier,omitempty"`
	Cipher              *ExpressRouteLinkMacSecCipher   `json:"cipher,omitempty"`
	CknSecretIdentifier *string                         `json:"cknSecretIdentifier,omitempty"`
	SciState            *ExpressRouteLinkMacSecSciState `json:"sciState,omitempty"`
}

type ExpressRouteLinkMacSecSciState

type ExpressRouteLinkMacSecSciState string
const (
	ExpressRouteLinkMacSecSciStateDisabled ExpressRouteLinkMacSecSciState = "Disabled"
	ExpressRouteLinkMacSecSciStateEnabled  ExpressRouteLinkMacSecSciState = "Enabled"
)

func (*ExpressRouteLinkMacSecSciState) UnmarshalJSON

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

type ExpressRouteLinkOperationPredicate

type ExpressRouteLinkOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
}

func (ExpressRouteLinkOperationPredicate) Matches

type ExpressRouteLinkPropertiesFormat

type ExpressRouteLinkPropertiesFormat struct {
	AdminState        *ExpressRouteLinkAdminState    `json:"adminState,omitempty"`
	ColoLocation      *string                        `json:"coloLocation,omitempty"`
	ConnectorType     *ExpressRouteLinkConnectorType `json:"connectorType,omitempty"`
	InterfaceName     *string                        `json:"interfaceName,omitempty"`
	MacSecConfig      *ExpressRouteLinkMacSecConfig  `json:"macSecConfig,omitempty"`
	PatchPanelId      *string                        `json:"patchPanelId,omitempty"`
	ProvisioningState *ProvisioningState             `json:"provisioningState,omitempty"`
	RackId            *string                        `json:"rackId,omitempty"`
	RouterName        *string                        `json:"routerName,omitempty"`
}

type ExpressRouteLinksClient

type ExpressRouteLinksClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteLinksClientWithBaseURI

func NewExpressRouteLinksClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteLinksClient, error)

func (ExpressRouteLinksClient) Get

Get ...

func (ExpressRouteLinksClient) List

List ...

func (ExpressRouteLinksClient) ListComplete

ListComplete retrieves all the results into a single object

func (ExpressRouteLinksClient) ListCompleteMatchingPredicate

func (c ExpressRouteLinksClient) ListCompleteMatchingPredicate(ctx context.Context, id ExpressRoutePortId, predicate ExpressRouteLinkOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ExpressRoutePortId

type ExpressRoutePortId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ExpressRoutePortName string
}

ExpressRoutePortId is a struct representing the Resource ID for a Express Route Port

func NewExpressRoutePortID

func NewExpressRoutePortID(subscriptionId string, resourceGroupName string, expressRoutePortName string) ExpressRoutePortId

NewExpressRoutePortID returns a new ExpressRoutePortId struct

func ParseExpressRoutePortID

func ParseExpressRoutePortID(input string) (*ExpressRoutePortId, error)

ParseExpressRoutePortID parses 'input' into a ExpressRoutePortId

func ParseExpressRoutePortIDInsensitively

func ParseExpressRoutePortIDInsensitively(input string) (*ExpressRoutePortId, error)

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

func (*ExpressRoutePortId) FromParseResult

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

func (ExpressRoutePortId) ID

func (id ExpressRoutePortId) ID() string

ID returns the formatted Express Route Port ID

func (ExpressRoutePortId) Segments

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

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

func (ExpressRoutePortId) String

func (id ExpressRoutePortId) String() string

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

type GetOperationResponse

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

type LinkId

type LinkId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ExpressRoutePortName string
	LinkName             string
}

LinkId is a struct representing the Resource ID for a Link

func NewLinkID

func NewLinkID(subscriptionId string, resourceGroupName string, expressRoutePortName string, linkName string) LinkId

NewLinkID returns a new LinkId struct

func ParseLinkID

func ParseLinkID(input string) (*LinkId, error)

ParseLinkID parses 'input' into a LinkId

func ParseLinkIDInsensitively

func ParseLinkIDInsensitively(input string) (*LinkId, error)

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

func (*LinkId) FromParseResult

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

func (LinkId) ID

func (id LinkId) ID() string

ID returns the formatted Link ID

func (LinkId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Link ID

func (LinkId) String

func (id LinkId) String() string

String returns a human-readable description of this Link ID

type ListCompleteResult

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

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ExpressRouteLink
}

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL