expressrouteports

package
v0.20240122.1052955 Latest Latest
Warning

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

Go to latest
Published: Jan 22, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/expressrouteports Documentation

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

Client Initialization

client := expressrouteports.NewExpressRoutePortsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRoutePortsClient.CreateOrUpdate

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

payload := expressrouteports.ExpressRoutePort{
	// ...
}


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

Example Usage: ExpressRoutePortsClient.Delete

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

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

Example Usage: ExpressRoutePortsClient.GenerateLOA

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

payload := expressrouteports.GenerateExpressRoutePortsLOARequest{
	// ...
}


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

Example Usage: ExpressRoutePortsClient.Get

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

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

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

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

Example Usage: ExpressRoutePortsClient.ListByResourceGroup

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

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ExpressRoutePortsClient.UpdateTags

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

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


read, err := client.UpdateTags(ctx, id, payload)
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 PossibleValuesForExpressRouteLinkAdminState

func PossibleValuesForExpressRouteLinkAdminState() []string

func PossibleValuesForExpressRouteLinkConnectorType

func PossibleValuesForExpressRouteLinkConnectorType() []string

func PossibleValuesForExpressRouteLinkMacSecCipher

func PossibleValuesForExpressRouteLinkMacSecCipher() []string

func PossibleValuesForExpressRouteLinkMacSecSciState

func PossibleValuesForExpressRouteLinkMacSecSciState() []string

func PossibleValuesForExpressRoutePortsBillingType

func PossibleValuesForExpressRoutePortsBillingType() []string

func PossibleValuesForExpressRoutePortsEncapsulation

func PossibleValuesForExpressRoutePortsEncapsulation() []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

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

type ExpressRoutePort struct {
	Etag       *string                            `json:"etag,omitempty"`
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ExpressRoutePortPropertiesFormat  `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

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 added in v0.20231127.1171502

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 ExpressRoutePortOperationPredicate

type ExpressRoutePortOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ExpressRoutePortOperationPredicate) Matches

type ExpressRoutePortPropertiesFormat

type ExpressRoutePortPropertiesFormat struct {
	AllocationDate             *string                         `json:"allocationDate,omitempty"`
	BandwidthInGbps            *int64                          `json:"bandwidthInGbps,omitempty"`
	BillingType                *ExpressRoutePortsBillingType   `json:"billingType,omitempty"`
	Circuits                   *[]SubResource                  `json:"circuits,omitempty"`
	Encapsulation              *ExpressRoutePortsEncapsulation `json:"encapsulation,omitempty"`
	EtherType                  *string                         `json:"etherType,omitempty"`
	Links                      *[]ExpressRouteLink             `json:"links,omitempty"`
	Mtu                        *string                         `json:"mtu,omitempty"`
	PeeringLocation            *string                         `json:"peeringLocation,omitempty"`
	ProvisionedBandwidthInGbps *float64                        `json:"provisionedBandwidthInGbps,omitempty"`
	ProvisioningState          *ProvisioningState              `json:"provisioningState,omitempty"`
	ResourceGuid               *string                         `json:"resourceGuid,omitempty"`
}

type ExpressRoutePortsBillingType

type ExpressRoutePortsBillingType string
const (
	ExpressRoutePortsBillingTypeMeteredData   ExpressRoutePortsBillingType = "MeteredData"
	ExpressRoutePortsBillingTypeUnlimitedData ExpressRoutePortsBillingType = "UnlimitedData"
)

func (*ExpressRoutePortsBillingType) UnmarshalJSON

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

type ExpressRoutePortsClient

type ExpressRoutePortsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRoutePortsClientWithBaseURI

func NewExpressRoutePortsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRoutePortsClient, error)

func (ExpressRoutePortsClient) CreateOrUpdate

CreateOrUpdate ...

func (ExpressRoutePortsClient) CreateOrUpdateThenPoll

func (c ExpressRoutePortsClient) CreateOrUpdateThenPoll(ctx context.Context, id ExpressRoutePortId, input ExpressRoutePort) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ExpressRoutePortsClient) Delete

Delete ...

func (ExpressRoutePortsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ExpressRoutePortsClient) GenerateLOA

GenerateLOA ...

func (ExpressRoutePortsClient) Get

Get ...

func (ExpressRoutePortsClient) List

List ...

func (ExpressRoutePortsClient) ListByResourceGroup

ListByResourceGroup ...

func (ExpressRoutePortsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (ExpressRoutePortsClient) ListByResourceGroupCompleteMatchingPredicate

func (c ExpressRoutePortsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ExpressRoutePortOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ExpressRoutePortsClient) ListComplete

ListComplete retrieves all the results into a single object

func (ExpressRoutePortsClient) ListCompleteMatchingPredicate

func (c ExpressRoutePortsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ExpressRoutePortOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ExpressRoutePortsClient) UpdateTags

UpdateTags ...

type ExpressRoutePortsEncapsulation

type ExpressRoutePortsEncapsulation string
const (
	ExpressRoutePortsEncapsulationDotOneQ ExpressRoutePortsEncapsulation = "Dot1Q"
	ExpressRoutePortsEncapsulationQinQ    ExpressRoutePortsEncapsulation = "QinQ"
)

func (*ExpressRoutePortsEncapsulation) UnmarshalJSON

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

type GenerateExpressRoutePortsLOARequest

type GenerateExpressRoutePortsLOARequest struct {
	CustomerName string `json:"customerName"`
}

type GenerateExpressRoutePortsLOAResult

type GenerateExpressRoutePortsLOAResult struct {
	EncodedContent *string `json:"encodedContent,omitempty"`
}

type GenerateLOAOperationResponse

type GenerateLOAOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GenerateExpressRoutePortsLOAResult
}

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ExpressRoutePort
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ExpressRoutePort
}

type ListCompleteResult

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

type ListOperationResponse

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

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"`
}

type TagsObject

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

type UpdateTagsOperationResponse

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRoutePort
}

Jump to

Keyboard shortcuts

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