armpeering

package module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Dec 16, 2021 License: MIT Imports: 13 Imported by: 4

README

Azure Peering Service Module for Go

PkgGoDev

The armpeering module provides operations for working with Azure Peering Service.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Peering Service module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Peering Service. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Peering Service modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armpeering.NewPeeringLocationsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armpeering.NewPeeringLocationsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Peering Service label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BgpSession

type BgpSession struct {
	// The MD5 authentication key of the session.
	MD5AuthenticationKey *string `json:"md5AuthenticationKey,omitempty"`

	// The maximum number of prefixes advertised over the IPv4 session.
	MaxPrefixesAdvertisedV4 *int32 `json:"maxPrefixesAdvertisedV4,omitempty"`

	// The maximum number of prefixes advertised over the IPv6 session.
	MaxPrefixesAdvertisedV6 *int32 `json:"maxPrefixesAdvertisedV6,omitempty"`

	// The IPv4 session address on peer's end.
	PeerSessionIPv4Address *string `json:"peerSessionIPv4Address,omitempty"`

	// The IPv6 session address on peer's end.
	PeerSessionIPv6Address *string `json:"peerSessionIPv6Address,omitempty"`

	// The IPv4 prefix that contains both ends' IPv4 addresses.
	SessionPrefixV4 *string `json:"sessionPrefixV4,omitempty"`

	// The IPv6 prefix that contains both ends' IPv6 addresses.
	SessionPrefixV6 *string `json:"sessionPrefixV6,omitempty"`

	// READ-ONLY; The IPv4 session address on Microsoft's end.
	MicrosoftSessionIPv4Address *string `json:"microsoftSessionIPv4Address,omitempty" azure:"ro"`

	// READ-ONLY; The IPv6 session address on Microsoft's end.
	MicrosoftSessionIPv6Address *string `json:"microsoftSessionIPv6Address,omitempty" azure:"ro"`

	// READ-ONLY; The state of the IPv4 session.
	SessionStateV4 *SessionStateV4 `json:"sessionStateV4,omitempty" azure:"ro"`

	// READ-ONLY; The state of the IPv6 session.
	SessionStateV6 *SessionStateV6 `json:"sessionStateV6,omitempty" azure:"ro"`
}

BgpSession - The properties that define a BGP session.

type CheckServiceProviderAvailabilityInput

type CheckServiceProviderAvailabilityInput struct {
	// Gets or sets the PeeringServiceLocation
	PeeringServiceLocation *string `json:"peeringServiceLocation,omitempty"`

	// Gets or sets the PeeringServiceProvider
	PeeringServiceProvider *string `json:"peeringServiceProvider,omitempty"`
}

CheckServiceProviderAvailabilityInput - Class for CheckServiceProviderAvailabilityInput

type ConnectionState

type ConnectionState string

ConnectionState - The state of the connection.

const (
	ConnectionStateActive                ConnectionState = "Active"
	ConnectionStateApproved              ConnectionState = "Approved"
	ConnectionStateNone                  ConnectionState = "None"
	ConnectionStatePendingApproval       ConnectionState = "PendingApproval"
	ConnectionStateProvisioningCompleted ConnectionState = "ProvisioningCompleted"
	ConnectionStateProvisioningFailed    ConnectionState = "ProvisioningFailed"
	ConnectionStateProvisioningStarted   ConnectionState = "ProvisioningStarted"
	ConnectionStateValidating            ConnectionState = "Validating"
)

func PossibleConnectionStateValues

func PossibleConnectionStateValues() []ConnectionState

PossibleConnectionStateValues returns the possible values for the ConnectionState const type.

func (ConnectionState) ToPtr

func (c ConnectionState) ToPtr() *ConnectionState

ToPtr returns a *ConnectionState pointing to the current value.

type ContactInfo

type ContactInfo struct {
	// The list of email addresses.
	Emails []*string `json:"emails,omitempty"`

	// The list of contact numbers.
	Phone []*string `json:"phone,omitempty"`
}

ContactInfo - The contact information of the peer.

func (ContactInfo) MarshalJSON

func (c ContactInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactInfo.

type DirectConnection

type DirectConnection struct {
	// The bandwidth of the connection.
	BandwidthInMbps *int32 `json:"bandwidthInMbps,omitempty"`

	// The BGP session associated with the connection.
	BgpSession *BgpSession `json:"bgpSession,omitempty"`

	// The unique identifier (GUID) for the connection.
	ConnectionIdentifier *string `json:"connectionIdentifier,omitempty"`

	// The PeeringDB.com ID of the facility at which the connection has to be set up.
	PeeringDBFacilityID *int32 `json:"peeringDBFacilityId,omitempty"`

	// The bandwidth that is actually provisioned.
	ProvisionedBandwidthInMbps *int32 `json:"provisionedBandwidthInMbps,omitempty"`

	// The field indicating if Microsoft provides session ip addresses.
	SessionAddressProvider *SessionAddressProvider `json:"sessionAddressProvider,omitempty"`

	// The flag that indicates whether or not the connection is used for peering service.
	UseForPeeringService *bool `json:"useForPeeringService,omitempty"`

	// READ-ONLY; The state of the connection.
	ConnectionState *ConnectionState `json:"connectionState,omitempty" azure:"ro"`
}

DirectConnection - The properties that define a direct connection.

type DirectPeeringFacility

type DirectPeeringFacility struct {
	// The address of the direct peering facility.
	Address *string `json:"address,omitempty"`

	// The type of the direct peering.
	DirectPeeringType *DirectPeeringType `json:"directPeeringType,omitempty"`

	// The PeeringDB.com ID of the facility.
	PeeringDBFacilityID *int32 `json:"peeringDBFacilityId,omitempty"`

	// The PeeringDB.com URL of the facility.
	PeeringDBFacilityLink *string `json:"peeringDBFacilityLink,omitempty"`
}

DirectPeeringFacility - The properties that define a direct peering facility.

type DirectPeeringType

type DirectPeeringType string

DirectPeeringType - The type of direct peering.

const (
	DirectPeeringTypeCdn      DirectPeeringType = "Cdn"
	DirectPeeringTypeEdge     DirectPeeringType = "Edge"
	DirectPeeringTypeInternal DirectPeeringType = "Internal"
	DirectPeeringTypeTransit  DirectPeeringType = "Transit"
)

func PossibleDirectPeeringTypeValues

func PossibleDirectPeeringTypeValues() []DirectPeeringType

PossibleDirectPeeringTypeValues returns the possible values for the DirectPeeringType const type.

func (DirectPeeringType) ToPtr

ToPtr returns a *DirectPeeringType pointing to the current value.

type Enum0

type Enum0 string
const (
	Enum0Available   Enum0 = "Available"
	Enum0UnAvailable Enum0 = "UnAvailable"
)

func PossibleEnum0Values

func PossibleEnum0Values() []Enum0

PossibleEnum0Values returns the possible values for the Enum0 const type.

func (Enum0) ToPtr

func (c Enum0) ToPtr() *Enum0

ToPtr returns a *Enum0 pointing to the current value.

type Enum1

type Enum1 string
const (
	Enum1Direct   Enum1 = "Direct"
	Enum1Exchange Enum1 = "Exchange"
)

func PossibleEnum1Values

func PossibleEnum1Values() []Enum1

PossibleEnum1Values returns the possible values for the Enum1 const type.

func (Enum1) ToPtr

func (c Enum1) ToPtr() *Enum1

ToPtr returns a *Enum1 pointing to the current value.

type Enum14

type Enum14 string
const (
	Enum14Direct   Enum14 = "Direct"
	Enum14Exchange Enum14 = "Exchange"
)

func PossibleEnum14Values

func PossibleEnum14Values() []Enum14

PossibleEnum14Values returns the possible values for the Enum14 const type.

func (Enum14) ToPtr

func (c Enum14) ToPtr() *Enum14

ToPtr returns a *Enum14 pointing to the current value.

type Enum15

type Enum15 string
const (
	Enum15Cdn      Enum15 = "Cdn"
	Enum15Edge     Enum15 = "Edge"
	Enum15Internal Enum15 = "Internal"
	Enum15Transit  Enum15 = "Transit"
)

func PossibleEnum15Values

func PossibleEnum15Values() []Enum15

PossibleEnum15Values returns the possible values for the Enum15 const type.

func (Enum15) ToPtr

func (c Enum15) ToPtr() *Enum15

ToPtr returns a *Enum15 pointing to the current value.

type ErrorResponse

type ErrorResponse struct {

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`
	// contains filtered or unexported fields
}

ErrorResponse - The error response that indicates why an operation has failed. Implements the error and azcore.HTTPResponse interfaces.

func (ErrorResponse) Error

func (e ErrorResponse) Error() string

Error implements the error interface for type ErrorResponse. The contents of the error text are not contractual and subject to change.

type ExchangeConnection

type ExchangeConnection struct {
	// The BGP session associated with the connection.
	BgpSession *BgpSession `json:"bgpSession,omitempty"`

	// The unique identifier (GUID) for the connection.
	ConnectionIdentifier *string `json:"connectionIdentifier,omitempty"`

	// The PeeringDB.com ID of the facility at which the connection has to be set up.
	PeeringDBFacilityID *int32 `json:"peeringDBFacilityId,omitempty"`

	// READ-ONLY; The state of the connection.
	ConnectionState *ConnectionState `json:"connectionState,omitempty" azure:"ro"`
}

ExchangeConnection - The properties that define an exchange connection.

type ExchangePeeringFacility

type ExchangePeeringFacility struct {
	// The bandwidth of the connection between Microsoft and the exchange peering facility.
	BandwidthInMbps *int32 `json:"bandwidthInMbps,omitempty"`

	// The name of the exchange peering facility.
	ExchangeName *string `json:"exchangeName,omitempty"`

	// The IPv4 prefixes associated with the exchange peering facility.
	FacilityIPv4Prefix *string `json:"facilityIPv4Prefix,omitempty"`

	// The IPv6 prefixes associated with the exchange peering facility.
	FacilityIPv6Prefix *string `json:"facilityIPv6Prefix,omitempty"`

	// The IPv4 address of Microsoft at the exchange peering facility.
	MicrosoftIPv4Address *string `json:"microsoftIPv4Address,omitempty"`

	// The IPv6 address of Microsoft at the exchange peering facility.
	MicrosoftIPv6Address *string `json:"microsoftIPv6Address,omitempty"`

	// The PeeringDB.com ID of the facility.
	PeeringDBFacilityID *int32 `json:"peeringDBFacilityId,omitempty"`

	// The PeeringDB.com URL of the facility.
	PeeringDBFacilityLink *string `json:"peeringDBFacilityLink,omitempty"`
}

ExchangePeeringFacility - The properties that define an exchange peering facility.

type Family

type Family string

Family - The family of the peering SKU.

const (
	FamilyDirect   Family = "Direct"
	FamilyExchange Family = "Exchange"
)

func PossibleFamilyValues

func PossibleFamilyValues() []Family

PossibleFamilyValues returns the possible values for the Family const type.

func (Family) ToPtr

func (c Family) ToPtr() *Family

ToPtr returns a *Family pointing to the current value.

type Kind

type Kind string

Kind - The kind of the peering.

const (
	KindDirect   Kind = "Direct"
	KindExchange Kind = "Exchange"
)

func PossibleKindValues

func PossibleKindValues() []Kind

PossibleKindValues returns the possible values for the Kind const type.

func (Kind) ToPtr

func (c Kind) ToPtr() *Kind

ToPtr returns a *Kind pointing to the current value.

type LearnedType

type LearnedType string

LearnedType - The prefix learned type

const (
	LearnedTypeNone       LearnedType = "None"
	LearnedTypeViaPartner LearnedType = "ViaPartner"
	LearnedTypeViaSession LearnedType = "ViaSession"
)

func PossibleLearnedTypeValues

func PossibleLearnedTypeValues() []LearnedType

PossibleLearnedTypeValues returns the possible values for the LearnedType const type.

func (LearnedType) ToPtr

func (c LearnedType) ToPtr() *LearnedType

ToPtr returns a *LearnedType pointing to the current value.

type LegacyPeeringsClient

type LegacyPeeringsClient struct {
	// contains filtered or unexported fields
}

LegacyPeeringsClient contains the methods for the LegacyPeerings group. Don't use this type directly, use NewLegacyPeeringsClient() instead.

func NewLegacyPeeringsClient

func NewLegacyPeeringsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LegacyPeeringsClient

NewLegacyPeeringsClient creates a new instance of LegacyPeeringsClient with the specified values.

func (*LegacyPeeringsClient) List

func (client *LegacyPeeringsClient) List(peeringLocation string, kind Enum1, options *LegacyPeeringsListOptions) *LegacyPeeringsListPager

List - Lists all of the legacy peerings under the given subscription matching the specified kind and location. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListLegacyPeerings.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewLegacyPeeringsClient("<subscription-id>", cred, nil)
	pager := client.List("<peering-location>",
		armpeering.Enum1Exchange,
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Peering.ID: %s\n", *v.ID)
		}
	}
}
Output:

type LegacyPeeringsListOptions

type LegacyPeeringsListOptions struct {
}

LegacyPeeringsListOptions contains the optional parameters for the LegacyPeerings.List method.

type LegacyPeeringsListPager

type LegacyPeeringsListPager struct {
	// contains filtered or unexported fields
}

LegacyPeeringsListPager provides operations for iterating over paged responses.

func (*LegacyPeeringsListPager) Err

func (p *LegacyPeeringsListPager) Err() error

Err returns the last error encountered while paging.

func (*LegacyPeeringsListPager) NextPage

func (p *LegacyPeeringsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LegacyPeeringsListPager) PageResponse

PageResponse returns the current LegacyPeeringsListResponse page.

type LegacyPeeringsListResponse

type LegacyPeeringsListResponse struct {
	LegacyPeeringsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LegacyPeeringsListResponse contains the response from method LegacyPeerings.List.

type LegacyPeeringsListResult

type LegacyPeeringsListResult struct {
	PeeringListResult
}

LegacyPeeringsListResult contains the result from method LegacyPeerings.List.

type Name

type Name string

Name - The name of the peering SKU.

const (
	NameBasicDirectFree        Name = "Basic_Direct_Free"
	NameBasicExchangeFree      Name = "Basic_Exchange_Free"
	NamePremiumDirectFree      Name = "Premium_Direct_Free"
	NamePremiumDirectMetered   Name = "Premium_Direct_Metered"
	NamePremiumDirectUnlimited Name = "Premium_Direct_Unlimited"
	NamePremiumExchangeMetered Name = "Premium_Exchange_Metered"
)

func PossibleNameValues

func PossibleNameValues() []Name

PossibleNameValues returns the possible values for the Name const type.

func (Name) ToPtr

func (c Name) ToPtr() *Name

ToPtr returns a *Name pointing to the current value.

type Operation

type Operation struct {
	// READ-ONLY; The information related to the operation.
	Display *OperationDisplayInfo `json:"display,omitempty" azure:"ro"`

	// READ-ONLY; The flag that indicates whether the operation applies to data plane.
	IsDataAction *bool `json:"isDataAction,omitempty" azure:"ro"`

	// READ-ONLY; The name of the operation.
	Name *string `json:"name,omitempty" azure:"ro"`
}

Operation - The peering API operation.

type OperationDisplayInfo

type OperationDisplayInfo struct {
	// READ-ONLY; The description of the operation.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The name of the operation.
	Operation *string `json:"operation,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource provider.
	Provider *string `json:"provider,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Resource *string `json:"resource,omitempty" azure:"ro"`
}

OperationDisplayInfo - The information related to the operation.

type OperationListResult

type OperationListResult struct {
	// The link to fetch the next page of peering API operations.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of peering API operations.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - The paginated list of peering API operations.

func (OperationListResult) MarshalJSON

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationsClient

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values.

func (*OperationsClient) List

List - Lists all of the available API operations for peering resources. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeeringOperations.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}
Output:

type OperationsListOptions

type OperationsListOptions struct {
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListPager

type OperationsListPager struct {
	// contains filtered or unexported fields
}

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage

func (p *OperationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsListPager) PageResponse

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse

type OperationsListResponse struct {
	OperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult

type OperationsListResult struct {
	OperationListResult
}

OperationsListResult contains the result from method Operations.List.

type PeerAsn

type PeerAsn struct {
	Resource
	// The properties that define a peer's ASN.
	Properties *PeerAsnProperties `json:"properties,omitempty"`
}

PeerAsn - The essential information related to the peer's ASN.

func (PeerAsn) MarshalJSON

func (p PeerAsn) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeerAsn.

type PeerAsnListResult

type PeerAsnListResult struct {
	// The link to fetch the next page of peer ASNs.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of peer ASNs.
	Value []*PeerAsn `json:"value,omitempty"`
}

PeerAsnListResult - The paginated list of peer ASNs.

func (PeerAsnListResult) MarshalJSON

func (p PeerAsnListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeerAsnListResult.

type PeerAsnProperties

type PeerAsnProperties struct {
	// The Autonomous System Number (ASN) of the peer.
	PeerAsn *int32 `json:"peerAsn,omitempty"`

	// The contact information of the peer.
	PeerContactInfo *ContactInfo `json:"peerContactInfo,omitempty"`

	// The name of the peer.
	PeerName *string `json:"peerName,omitempty"`

	// The validation state of the ASN associated with the peer.
	ValidationState *ValidationState `json:"validationState,omitempty"`
}

PeerAsnProperties - The properties that define a peer's ASN.

type PeerAsnsClient

type PeerAsnsClient struct {
	// contains filtered or unexported fields
}

PeerAsnsClient contains the methods for the PeerAsns group. Don't use this type directly, use NewPeerAsnsClient() instead.

func NewPeerAsnsClient

func NewPeerAsnsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeerAsnsClient

NewPeerAsnsClient creates a new instance of PeerAsnsClient with the specified values.

func (*PeerAsnsClient) CreateOrUpdate

func (client *PeerAsnsClient) CreateOrUpdate(ctx context.Context, peerAsnName string, peerAsn PeerAsn, options *PeerAsnsCreateOrUpdateOptions) (PeerAsnsCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/CreatePeerAsn.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeerAsnsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<peer-asn-name>",
		armpeering.PeerAsn{
			Properties: &armpeering.PeerAsnProperties{
				PeerAsn: to.Int32Ptr(65000),
				PeerContactInfo: &armpeering.ContactInfo{
					Emails: []*string{
						to.StringPtr("abc@contoso.com"),
						to.StringPtr("xyz@contoso.com")},
					Phone: []*string{
						to.StringPtr("+1 (234) 567-8900")},
				},
				PeerName: to.StringPtr("<peer-name>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PeerAsn.ID: %s\n", *res.ID)
}
Output:

func (*PeerAsnsClient) Delete

func (client *PeerAsnsClient) Delete(ctx context.Context, peerAsnName string, options *PeerAsnsDeleteOptions) (PeerAsnsDeleteResponse, error)

Delete - Deletes an existing peer ASN with the specified name under the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/DeletePeerAsn.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeerAsnsClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<peer-asn-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*PeerAsnsClient) Get

func (client *PeerAsnsClient) Get(ctx context.Context, peerAsnName string, options *PeerAsnsGetOptions) (PeerAsnsGetResponse, error)

Get - Gets the peer ASN with the specified name under the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/GetPeerAsn.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeerAsnsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<peer-asn-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PeerAsn.ID: %s\n", *res.ID)
}
Output:

func (*PeerAsnsClient) ListBySubscription

ListBySubscription - Lists all of the peer ASNs under the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeerAsnsBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeerAsnsClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PeerAsn.ID: %s\n", *v.ID)
		}
	}
}
Output:

type PeerAsnsCreateOrUpdateOptions

type PeerAsnsCreateOrUpdateOptions struct {
}

PeerAsnsCreateOrUpdateOptions contains the optional parameters for the PeerAsns.CreateOrUpdate method.

type PeerAsnsCreateOrUpdateResponse

type PeerAsnsCreateOrUpdateResponse struct {
	PeerAsnsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeerAsnsCreateOrUpdateResponse contains the response from method PeerAsns.CreateOrUpdate.

type PeerAsnsCreateOrUpdateResult

type PeerAsnsCreateOrUpdateResult struct {
	PeerAsn
}

PeerAsnsCreateOrUpdateResult contains the result from method PeerAsns.CreateOrUpdate.

type PeerAsnsDeleteOptions

type PeerAsnsDeleteOptions struct {
}

PeerAsnsDeleteOptions contains the optional parameters for the PeerAsns.Delete method.

type PeerAsnsDeleteResponse

type PeerAsnsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeerAsnsDeleteResponse contains the response from method PeerAsns.Delete.

type PeerAsnsGetOptions

type PeerAsnsGetOptions struct {
}

PeerAsnsGetOptions contains the optional parameters for the PeerAsns.Get method.

type PeerAsnsGetResponse

type PeerAsnsGetResponse struct {
	PeerAsnsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeerAsnsGetResponse contains the response from method PeerAsns.Get.

type PeerAsnsGetResult

type PeerAsnsGetResult struct {
	PeerAsn
}

PeerAsnsGetResult contains the result from method PeerAsns.Get.

type PeerAsnsListBySubscriptionOptions

type PeerAsnsListBySubscriptionOptions struct {
}

PeerAsnsListBySubscriptionOptions contains the optional parameters for the PeerAsns.ListBySubscription method.

type PeerAsnsListBySubscriptionPager

type PeerAsnsListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

PeerAsnsListBySubscriptionPager provides operations for iterating over paged responses.

func (*PeerAsnsListBySubscriptionPager) Err

Err returns the last error encountered while paging.

func (*PeerAsnsListBySubscriptionPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeerAsnsListBySubscriptionPager) PageResponse

PageResponse returns the current PeerAsnsListBySubscriptionResponse page.

type PeerAsnsListBySubscriptionResponse

type PeerAsnsListBySubscriptionResponse struct {
	PeerAsnsListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeerAsnsListBySubscriptionResponse contains the response from method PeerAsns.ListBySubscription.

type PeerAsnsListBySubscriptionResult

type PeerAsnsListBySubscriptionResult struct {
	PeerAsnListResult
}

PeerAsnsListBySubscriptionResult contains the result from method PeerAsns.ListBySubscription.

type Peering

type Peering struct {
	Resource
	// REQUIRED; The kind of the peering.
	Kind *Kind `json:"kind,omitempty"`

	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// REQUIRED; The SKU that defines the tier and kind of the peering.
	SKU *PeeringSKU `json:"sku,omitempty"`

	// The properties that define a peering.
	Properties *PeeringProperties `json:"properties,omitempty"`

	// The resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location.

func (Peering) MarshalJSON

func (p Peering) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Peering.

type PeeringBandwidthOffer

type PeeringBandwidthOffer struct {
	// The name of the bandwidth offer.
	OfferName *string `json:"offerName,omitempty"`

	// The value of the bandwidth offer in Mbps.
	ValueInMbps *int32 `json:"valueInMbps,omitempty"`
}

PeeringBandwidthOffer - The properties that define a peering bandwidth offer.

type PeeringListResult

type PeeringListResult struct {
	// The link to fetch the next page of peerings.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of peerings.
	Value []*Peering `json:"value,omitempty"`
}

PeeringListResult - The paginated list of peerings.

func (PeeringListResult) MarshalJSON

func (p PeeringListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringListResult.

type PeeringLocation

type PeeringLocation struct {
	Resource
	// The kind of peering that the peering location supports.
	Kind *Kind `json:"kind,omitempty"`

	// The properties that define a peering location.
	Properties *PeeringLocationProperties `json:"properties,omitempty"`
}

PeeringLocation - Peering location is where connectivity could be established to the Microsoft Cloud Edge.

func (PeeringLocation) MarshalJSON

func (p PeeringLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringLocation.

type PeeringLocationListResult

type PeeringLocationListResult struct {
	// The link to fetch the next page of peering locations.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of peering locations.
	Value []*PeeringLocation `json:"value,omitempty"`
}

PeeringLocationListResult - The paginated list of peering locations.

func (PeeringLocationListResult) MarshalJSON

func (p PeeringLocationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringLocationListResult.

type PeeringLocationProperties

type PeeringLocationProperties struct {
	// The Azure region associated with the peering location.
	AzureRegion *string `json:"azureRegion,omitempty"`

	// The country in which the peering location exists.
	Country *string `json:"country,omitempty"`

	// The properties that define a direct peering location.
	Direct *PeeringLocationPropertiesDirect `json:"direct,omitempty"`

	// The properties that define an exchange peering location.
	Exchange *PeeringLocationPropertiesExchange `json:"exchange,omitempty"`

	// The name of the peering location.
	PeeringLocation *string `json:"peeringLocation,omitempty"`
}

PeeringLocationProperties - The properties that define a peering location.

type PeeringLocationPropertiesDirect

type PeeringLocationPropertiesDirect struct {
	// The list of bandwidth offers available at the peering location.
	BandwidthOffers []*PeeringBandwidthOffer `json:"bandwidthOffers,omitempty"`

	// The list of direct peering facilities at the peering location.
	PeeringFacilities []*DirectPeeringFacility `json:"peeringFacilities,omitempty"`
}

PeeringLocationPropertiesDirect - The properties that define a direct peering location.

func (PeeringLocationPropertiesDirect) MarshalJSON

func (p PeeringLocationPropertiesDirect) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringLocationPropertiesDirect.

type PeeringLocationPropertiesExchange

type PeeringLocationPropertiesExchange struct {
	// The list of exchange peering facilities at the peering location.
	PeeringFacilities []*ExchangePeeringFacility `json:"peeringFacilities,omitempty"`
}

PeeringLocationPropertiesExchange - The properties that define an exchange peering location.

func (PeeringLocationPropertiesExchange) MarshalJSON

func (p PeeringLocationPropertiesExchange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringLocationPropertiesExchange.

type PeeringLocationsClient

type PeeringLocationsClient struct {
	// contains filtered or unexported fields
}

PeeringLocationsClient contains the methods for the PeeringLocations group. Don't use this type directly, use NewPeeringLocationsClient() instead.

func NewPeeringLocationsClient

func NewPeeringLocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeeringLocationsClient

NewPeeringLocationsClient creates a new instance of PeeringLocationsClient with the specified values.

func (*PeeringLocationsClient) List

List - Lists all of the available peering locations for the specified kind of peering. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListDirectPeeringLocations.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringLocationsClient("<subscription-id>", cred, nil)
	pager := client.List(armpeering.Enum14Direct,
		&armpeering.PeeringLocationsListOptions{DirectPeeringType: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PeeringLocation.ID: %s\n", *v.ID)
		}
	}
}
Output:

type PeeringLocationsListOptions

type PeeringLocationsListOptions struct {
	// The type of direct peering.
	DirectPeeringType *Enum15
}

PeeringLocationsListOptions contains the optional parameters for the PeeringLocations.List method.

type PeeringLocationsListPager

type PeeringLocationsListPager struct {
	// contains filtered or unexported fields
}

PeeringLocationsListPager provides operations for iterating over paged responses.

func (*PeeringLocationsListPager) Err

Err returns the last error encountered while paging.

func (*PeeringLocationsListPager) NextPage

func (p *PeeringLocationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeeringLocationsListPager) PageResponse

PageResponse returns the current PeeringLocationsListResponse page.

type PeeringLocationsListResponse

type PeeringLocationsListResponse struct {
	PeeringLocationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringLocationsListResponse contains the response from method PeeringLocations.List.

type PeeringLocationsListResult

type PeeringLocationsListResult struct {
	PeeringLocationListResult
}

PeeringLocationsListResult contains the result from method PeeringLocations.List.

type PeeringManagementClient

type PeeringManagementClient struct {
	// contains filtered or unexported fields
}

PeeringManagementClient contains the methods for the PeeringManagementClient group. Don't use this type directly, use NewPeeringManagementClient() instead.

func NewPeeringManagementClient

func NewPeeringManagementClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeeringManagementClient

NewPeeringManagementClient creates a new instance of PeeringManagementClient with the specified values.

func (*PeeringManagementClient) CheckServiceProviderAvailability

CheckServiceProviderAvailability - Checks if the peering service provider is present within 1000 miles of customer's location If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/CheckServiceProviderAvailability.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringManagementClient("<subscription-id>", cred, nil)
	_, err = client.CheckServiceProviderAvailability(ctx,
		armpeering.CheckServiceProviderAvailabilityInput{
			PeeringServiceLocation: to.StringPtr("<peering-service-location>"),
			PeeringServiceProvider: to.StringPtr("<peering-service-provider>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

type PeeringManagementClientCheckServiceProviderAvailabilityOptions

type PeeringManagementClientCheckServiceProviderAvailabilityOptions struct {
}

PeeringManagementClientCheckServiceProviderAvailabilityOptions contains the optional parameters for the PeeringManagementClient.CheckServiceProviderAvailability method.

type PeeringManagementClientCheckServiceProviderAvailabilityResponse

type PeeringManagementClientCheckServiceProviderAvailabilityResponse struct {
	PeeringManagementClientCheckServiceProviderAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringManagementClientCheckServiceProviderAvailabilityResponse contains the response from method PeeringManagementClient.CheckServiceProviderAvailability.

type PeeringManagementClientCheckServiceProviderAvailabilityResult

type PeeringManagementClientCheckServiceProviderAvailabilityResult struct {
	Value *Enum0
}

PeeringManagementClientCheckServiceProviderAvailabilityResult contains the result from method PeeringManagementClient.CheckServiceProviderAvailability.

type PeeringProperties

type PeeringProperties struct {
	// The properties that define a direct peering.
	Direct *PeeringPropertiesDirect `json:"direct,omitempty"`

	// The properties that define an exchange peering.
	Exchange *PeeringPropertiesExchange `json:"exchange,omitempty"`

	// The location of the peering.
	PeeringLocation *string `json:"peeringLocation,omitempty"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PeeringProperties - The properties that define connectivity to the Microsoft Cloud Edge.

type PeeringPropertiesDirect

type PeeringPropertiesDirect struct {
	// The set of connections that constitute a direct peering.
	Connections []*DirectConnection `json:"connections,omitempty"`

	// The type of direct peering.
	DirectPeeringType *DirectPeeringType `json:"directPeeringType,omitempty"`

	// The reference of the peer ASN.
	PeerAsn *SubResource `json:"peerAsn,omitempty"`

	// The flag that indicates whether or not the peering is used for peering service.
	UseForPeeringService *bool `json:"useForPeeringService,omitempty"`
}

PeeringPropertiesDirect - The properties that define a direct peering.

func (PeeringPropertiesDirect) MarshalJSON

func (p PeeringPropertiesDirect) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringPropertiesDirect.

type PeeringPropertiesExchange

type PeeringPropertiesExchange struct {
	// The set of connections that constitute an exchange peering.
	Connections []*ExchangeConnection `json:"connections,omitempty"`

	// The reference of the peer ASN.
	PeerAsn *SubResource `json:"peerAsn,omitempty"`
}

PeeringPropertiesExchange - The properties that define an exchange peering.

func (PeeringPropertiesExchange) MarshalJSON

func (p PeeringPropertiesExchange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringPropertiesExchange.

type PeeringSKU

type PeeringSKU struct {
	// The family of the peering SKU.
	Family *Family `json:"family,omitempty"`

	// The name of the peering SKU.
	Name *Name `json:"name,omitempty"`

	// The size of the peering SKU.
	Size *Size `json:"size,omitempty"`

	// The tier of the peering SKU.
	Tier *Tier `json:"tier,omitempty"`
}

PeeringSKU - The SKU that defines the tier and kind of the peering.

type PeeringService

type PeeringService struct {
	Resource
	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// The properties that define a peering service.
	Properties *PeeringServiceProperties `json:"properties,omitempty"`

	// The resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

PeeringService - Peering Service

func (PeeringService) MarshalJSON

func (p PeeringService) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringService.

type PeeringServiceListResult

type PeeringServiceListResult struct {
	// The link to fetch the next page of peering services.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of peering services.
	Value []*PeeringService `json:"value,omitempty"`
}

PeeringServiceListResult - The paginated list of peering services.

func (PeeringServiceListResult) MarshalJSON

func (p PeeringServiceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringServiceListResult.

type PeeringServiceLocation

type PeeringServiceLocation struct {
	Resource
	// The properties that define a peering service location.
	Properties *PeeringServiceLocationProperties `json:"properties,omitempty"`
}

PeeringServiceLocation - PeeringService location

func (PeeringServiceLocation) MarshalJSON

func (p PeeringServiceLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringServiceLocation.

type PeeringServiceLocationListResult

type PeeringServiceLocationListResult struct {
	// The link to fetch the next page of peering service locations.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of peering service locations.
	Value []*PeeringServiceLocation `json:"value,omitempty"`
}

PeeringServiceLocationListResult - The paginated list of peering service locations.

func (PeeringServiceLocationListResult) MarshalJSON

func (p PeeringServiceLocationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringServiceLocationListResult.

type PeeringServiceLocationProperties

type PeeringServiceLocationProperties struct {
	// Azure region for the location
	AzureRegion *string `json:"azureRegion,omitempty"`

	// Country of the customer
	Country *string `json:"country,omitempty"`

	// State of the customer
	State *string `json:"state,omitempty"`
}

PeeringServiceLocationProperties - The properties that define connectivity to the Peering Service Location.

type PeeringServiceLocationsClient

type PeeringServiceLocationsClient struct {
	// contains filtered or unexported fields
}

PeeringServiceLocationsClient contains the methods for the PeeringServiceLocations group. Don't use this type directly, use NewPeeringServiceLocationsClient() instead.

func NewPeeringServiceLocationsClient

func NewPeeringServiceLocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeeringServiceLocationsClient

NewPeeringServiceLocationsClient creates a new instance of PeeringServiceLocationsClient with the specified values.

func (*PeeringServiceLocationsClient) List

List - Lists all of the available peering service locations for the specified kind of peering. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeeringServiceLocations.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServiceLocationsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PeeringServiceLocation.ID: %s\n", *v.ID)
		}
	}
}
Output:

type PeeringServiceLocationsListOptions

type PeeringServiceLocationsListOptions struct {
}

PeeringServiceLocationsListOptions contains the optional parameters for the PeeringServiceLocations.List method.

type PeeringServiceLocationsListPager

type PeeringServiceLocationsListPager struct {
	// contains filtered or unexported fields
}

PeeringServiceLocationsListPager provides operations for iterating over paged responses.

func (*PeeringServiceLocationsListPager) Err

Err returns the last error encountered while paging.

func (*PeeringServiceLocationsListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeeringServiceLocationsListPager) PageResponse

PageResponse returns the current PeeringServiceLocationsListResponse page.

type PeeringServiceLocationsListResponse

type PeeringServiceLocationsListResponse struct {
	PeeringServiceLocationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServiceLocationsListResponse contains the response from method PeeringServiceLocations.List.

type PeeringServiceLocationsListResult

type PeeringServiceLocationsListResult struct {
	PeeringServiceLocationListResult
}

PeeringServiceLocationsListResult contains the result from method PeeringServiceLocations.List.

type PeeringServicePrefix

type PeeringServicePrefix struct {
	Resource
	// Gets or sets the peering prefix properties.
	Properties *PeeringServicePrefixProperties `json:"properties,omitempty"`
}

PeeringServicePrefix - The peering service prefix class.

func (PeeringServicePrefix) MarshalJSON

func (p PeeringServicePrefix) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringServicePrefix.

type PeeringServicePrefixListResult

type PeeringServicePrefixListResult struct {
	// The link to fetch the next page of [T].
	NextLink *string `json:"nextLink,omitempty"`

	// The list of [T].
	Value []*PeeringServicePrefix `json:"value,omitempty"`
}

PeeringServicePrefixListResult - The paginated list of [T].

func (PeeringServicePrefixListResult) MarshalJSON

func (p PeeringServicePrefixListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringServicePrefixListResult.

type PeeringServicePrefixProperties

type PeeringServicePrefixProperties struct {
	// The prefix learned type
	LearnedType *LearnedType `json:"learnedType,omitempty"`

	// Valid route prefix
	Prefix *string `json:"prefix,omitempty"`

	// The prefix validation state
	PrefixValidationState *PrefixValidationState `json:"prefixValidationState,omitempty"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PeeringServicePrefixProperties - The peering service prefix properties class.

type PeeringServicePrefixesClient

type PeeringServicePrefixesClient struct {
	// contains filtered or unexported fields
}

PeeringServicePrefixesClient contains the methods for the PeeringServicePrefixes group. Don't use this type directly, use NewPeeringServicePrefixesClient() instead.

func NewPeeringServicePrefixesClient

func NewPeeringServicePrefixesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeeringServicePrefixesClient

NewPeeringServicePrefixesClient creates a new instance of PeeringServicePrefixesClient with the specified values.

func (*PeeringServicePrefixesClient) CreateOrUpdate

func (client *PeeringServicePrefixesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, peeringServiceName string, prefixName string, peeringServicePrefix PeeringServicePrefix, options *PeeringServicePrefixesCreateOrUpdateOptions) (PeeringServicePrefixesCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the peering prefix. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/CreatePeeringServicePrefix.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicePrefixesClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<peering-service-name>",
		"<prefix-name>",
		armpeering.PeeringServicePrefix{
			Properties: &armpeering.PeeringServicePrefixProperties{
				Prefix: to.StringPtr("<prefix>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PeeringServicePrefix.ID: %s\n", *res.ID)
}
Output:

func (*PeeringServicePrefixesClient) Delete

func (client *PeeringServicePrefixesClient) Delete(ctx context.Context, resourceGroupName string, peeringServiceName string, prefixName string, options *PeeringServicePrefixesDeleteOptions) (PeeringServicePrefixesDeleteResponse, error)

Delete - removes the peering prefix. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/DeletePeeringServicePrefix.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicePrefixesClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<peering-service-name>",
		"<prefix-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*PeeringServicePrefixesClient) Get

func (client *PeeringServicePrefixesClient) Get(ctx context.Context, resourceGroupName string, peeringServiceName string, prefixName string, options *PeeringServicePrefixesGetOptions) (PeeringServicePrefixesGetResponse, error)

Get - Gets the peering service prefix. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/GetPeeringServicePrefix.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicePrefixesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<peering-service-name>",
		"<prefix-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PeeringServicePrefix.ID: %s\n", *res.ID)
}
Output:

type PeeringServicePrefixesCreateOrUpdateOptions

type PeeringServicePrefixesCreateOrUpdateOptions struct {
}

PeeringServicePrefixesCreateOrUpdateOptions contains the optional parameters for the PeeringServicePrefixes.CreateOrUpdate method.

type PeeringServicePrefixesCreateOrUpdateResponse

type PeeringServicePrefixesCreateOrUpdateResponse struct {
	PeeringServicePrefixesCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicePrefixesCreateOrUpdateResponse contains the response from method PeeringServicePrefixes.CreateOrUpdate.

type PeeringServicePrefixesCreateOrUpdateResult

type PeeringServicePrefixesCreateOrUpdateResult struct {
	PeeringServicePrefix
}

PeeringServicePrefixesCreateOrUpdateResult contains the result from method PeeringServicePrefixes.CreateOrUpdate.

type PeeringServicePrefixesDeleteOptions

type PeeringServicePrefixesDeleteOptions struct {
}

PeeringServicePrefixesDeleteOptions contains the optional parameters for the PeeringServicePrefixes.Delete method.

type PeeringServicePrefixesDeleteResponse

type PeeringServicePrefixesDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicePrefixesDeleteResponse contains the response from method PeeringServicePrefixes.Delete.

type PeeringServicePrefixesGetOptions

type PeeringServicePrefixesGetOptions struct {
}

PeeringServicePrefixesGetOptions contains the optional parameters for the PeeringServicePrefixes.Get method.

type PeeringServicePrefixesGetResponse

type PeeringServicePrefixesGetResponse struct {
	PeeringServicePrefixesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicePrefixesGetResponse contains the response from method PeeringServicePrefixes.Get.

type PeeringServicePrefixesGetResult

type PeeringServicePrefixesGetResult struct {
	PeeringServicePrefix
}

PeeringServicePrefixesGetResult contains the result from method PeeringServicePrefixes.Get.

type PeeringServiceProperties

type PeeringServiceProperties struct {
	// The PeeringServiceLocation of the Customer.
	PeeringServiceLocation *string `json:"peeringServiceLocation,omitempty"`

	// The MAPS Provider Name.
	PeeringServiceProvider *string `json:"peeringServiceProvider,omitempty"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PeeringServiceProperties - The properties that define connectivity to the Peering Service.

type PeeringServiceProvider

type PeeringServiceProvider struct {
	Resource
	// The properties that define a peering service provider.
	Properties *PeeringServiceProviderProperties `json:"properties,omitempty"`
}

PeeringServiceProvider - PeeringService provider

func (PeeringServiceProvider) MarshalJSON

func (p PeeringServiceProvider) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringServiceProvider.

type PeeringServiceProviderListResult

type PeeringServiceProviderListResult struct {
	// The link to fetch the next page of peering service providers.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of peering service providers.
	Value []*PeeringServiceProvider `json:"value,omitempty"`
}

PeeringServiceProviderListResult - The paginated list of peering service providers.

func (PeeringServiceProviderListResult) MarshalJSON

func (p PeeringServiceProviderListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeeringServiceProviderListResult.

type PeeringServiceProviderProperties

type PeeringServiceProviderProperties struct {
	// The name of the service provider.
	ServiceProviderName *string `json:"serviceProviderName,omitempty"`
}

PeeringServiceProviderProperties - The properties that define connectivity to the Peering Service Provider.

type PeeringServiceProvidersClient

type PeeringServiceProvidersClient struct {
	// contains filtered or unexported fields
}

PeeringServiceProvidersClient contains the methods for the PeeringServiceProviders group. Don't use this type directly, use NewPeeringServiceProvidersClient() instead.

func NewPeeringServiceProvidersClient

func NewPeeringServiceProvidersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeeringServiceProvidersClient

NewPeeringServiceProvidersClient creates a new instance of PeeringServiceProvidersClient with the specified values.

func (*PeeringServiceProvidersClient) List

List - Lists all of the available peering service locations for the specified kind of peering. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeeringServiceProviders.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServiceProvidersClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PeeringServiceProvider.ID: %s\n", *v.ID)
		}
	}
}
Output:

type PeeringServiceProvidersListOptions

type PeeringServiceProvidersListOptions struct {
}

PeeringServiceProvidersListOptions contains the optional parameters for the PeeringServiceProviders.List method.

type PeeringServiceProvidersListPager

type PeeringServiceProvidersListPager struct {
	// contains filtered or unexported fields
}

PeeringServiceProvidersListPager provides operations for iterating over paged responses.

func (*PeeringServiceProvidersListPager) Err

Err returns the last error encountered while paging.

func (*PeeringServiceProvidersListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeeringServiceProvidersListPager) PageResponse

PageResponse returns the current PeeringServiceProvidersListResponse page.

type PeeringServiceProvidersListResponse

type PeeringServiceProvidersListResponse struct {
	PeeringServiceProvidersListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServiceProvidersListResponse contains the response from method PeeringServiceProviders.List.

type PeeringServiceProvidersListResult

type PeeringServiceProvidersListResult struct {
	PeeringServiceProviderListResult
}

PeeringServiceProvidersListResult contains the result from method PeeringServiceProviders.List.

type PeeringServicesClient

type PeeringServicesClient struct {
	// contains filtered or unexported fields
}

PeeringServicesClient contains the methods for the PeeringServices group. Don't use this type directly, use NewPeeringServicesClient() instead.

func NewPeeringServicesClient

func NewPeeringServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeeringServicesClient

NewPeeringServicesClient creates a new instance of PeeringServicesClient with the specified values.

func (*PeeringServicesClient) CreateOrUpdate

func (client *PeeringServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, peeringServiceName string, peeringService PeeringService, options *PeeringServicesCreateOrUpdateOptions) (PeeringServicesCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/CreatePeeringService.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicesClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<peering-service-name>",
		armpeering.PeeringService{
			Location: to.StringPtr("<location>"),
			Properties: &armpeering.PeeringServiceProperties{
				PeeringServiceLocation: to.StringPtr("<peering-service-location>"),
				PeeringServiceProvider: to.StringPtr("<peering-service-provider>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PeeringService.ID: %s\n", *res.ID)
}
Output:

func (*PeeringServicesClient) Delete

func (client *PeeringServicesClient) Delete(ctx context.Context, resourceGroupName string, peeringServiceName string, options *PeeringServicesDeleteOptions) (PeeringServicesDeleteResponse, error)

Delete - Deletes an existing peering service with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/DeletePeeringService.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicesClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<peering-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*PeeringServicesClient) Get

func (client *PeeringServicesClient) Get(ctx context.Context, resourceGroupName string, peeringServiceName string, options *PeeringServicesGetOptions) (PeeringServicesGetResponse, error)

Get - Gets an existing peering service with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/GetPeeringService.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<peering-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PeeringService.ID: %s\n", *res.ID)
}
Output:

func (*PeeringServicesClient) ListByResourceGroup

ListByResourceGroup - Lists all of the peering services under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeeringServicesByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicesClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PeeringService.ID: %s\n", *v.ID)
		}
	}
}
Output:

func (*PeeringServicesClient) ListBySubscription

ListBySubscription - Lists all of the peerings under the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeeringServicesBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicesClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PeeringService.ID: %s\n", *v.ID)
		}
	}
}
Output:

func (*PeeringServicesClient) Update

func (client *PeeringServicesClient) Update(ctx context.Context, resourceGroupName string, peeringServiceName string, tags ResourceTags, options *PeeringServicesUpdateOptions) (PeeringServicesUpdateResponse, error)

Update - Updates tags for a peering service with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/UpdatePeeringServiceTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringServicesClient("<subscription-id>", cred, nil)
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<peering-service-name>",
		armpeering.ResourceTags{
			Tags: map[string]*string{
				"tag0": to.StringPtr("value0"),
				"tag1": to.StringPtr("value1"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PeeringService.ID: %s\n", *res.ID)
}
Output:

type PeeringServicesCreateOrUpdateOptions

type PeeringServicesCreateOrUpdateOptions struct {
}

PeeringServicesCreateOrUpdateOptions contains the optional parameters for the PeeringServices.CreateOrUpdate method.

type PeeringServicesCreateOrUpdateResponse

type PeeringServicesCreateOrUpdateResponse struct {
	PeeringServicesCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicesCreateOrUpdateResponse contains the response from method PeeringServices.CreateOrUpdate.

type PeeringServicesCreateOrUpdateResult

type PeeringServicesCreateOrUpdateResult struct {
	PeeringService
}

PeeringServicesCreateOrUpdateResult contains the result from method PeeringServices.CreateOrUpdate.

type PeeringServicesDeleteOptions

type PeeringServicesDeleteOptions struct {
}

PeeringServicesDeleteOptions contains the optional parameters for the PeeringServices.Delete method.

type PeeringServicesDeleteResponse

type PeeringServicesDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicesDeleteResponse contains the response from method PeeringServices.Delete.

type PeeringServicesGetOptions

type PeeringServicesGetOptions struct {
}

PeeringServicesGetOptions contains the optional parameters for the PeeringServices.Get method.

type PeeringServicesGetResponse

type PeeringServicesGetResponse struct {
	PeeringServicesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicesGetResponse contains the response from method PeeringServices.Get.

type PeeringServicesGetResult

type PeeringServicesGetResult struct {
	PeeringService
}

PeeringServicesGetResult contains the result from method PeeringServices.Get.

type PeeringServicesListByResourceGroupOptions

type PeeringServicesListByResourceGroupOptions struct {
}

PeeringServicesListByResourceGroupOptions contains the optional parameters for the PeeringServices.ListByResourceGroup method.

type PeeringServicesListByResourceGroupPager

type PeeringServicesListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

PeeringServicesListByResourceGroupPager provides operations for iterating over paged responses.

func (*PeeringServicesListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*PeeringServicesListByResourceGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeeringServicesListByResourceGroupPager) PageResponse

PageResponse returns the current PeeringServicesListByResourceGroupResponse page.

type PeeringServicesListByResourceGroupResponse

type PeeringServicesListByResourceGroupResponse struct {
	PeeringServicesListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicesListByResourceGroupResponse contains the response from method PeeringServices.ListByResourceGroup.

type PeeringServicesListByResourceGroupResult

type PeeringServicesListByResourceGroupResult struct {
	PeeringServiceListResult
}

PeeringServicesListByResourceGroupResult contains the result from method PeeringServices.ListByResourceGroup.

type PeeringServicesListBySubscriptionOptions

type PeeringServicesListBySubscriptionOptions struct {
}

PeeringServicesListBySubscriptionOptions contains the optional parameters for the PeeringServices.ListBySubscription method.

type PeeringServicesListBySubscriptionPager

type PeeringServicesListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

PeeringServicesListBySubscriptionPager provides operations for iterating over paged responses.

func (*PeeringServicesListBySubscriptionPager) Err

Err returns the last error encountered while paging.

func (*PeeringServicesListBySubscriptionPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeeringServicesListBySubscriptionPager) PageResponse

PageResponse returns the current PeeringServicesListBySubscriptionResponse page.

type PeeringServicesListBySubscriptionResponse

type PeeringServicesListBySubscriptionResponse struct {
	PeeringServicesListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicesListBySubscriptionResponse contains the response from method PeeringServices.ListBySubscription.

type PeeringServicesListBySubscriptionResult

type PeeringServicesListBySubscriptionResult struct {
	PeeringServiceListResult
}

PeeringServicesListBySubscriptionResult contains the result from method PeeringServices.ListBySubscription.

type PeeringServicesUpdateOptions

type PeeringServicesUpdateOptions struct {
}

PeeringServicesUpdateOptions contains the optional parameters for the PeeringServices.Update method.

type PeeringServicesUpdateResponse

type PeeringServicesUpdateResponse struct {
	PeeringServicesUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringServicesUpdateResponse contains the response from method PeeringServices.Update.

type PeeringServicesUpdateResult

type PeeringServicesUpdateResult struct {
	PeeringService
}

PeeringServicesUpdateResult contains the result from method PeeringServices.Update.

type PeeringsClient

type PeeringsClient struct {
	// contains filtered or unexported fields
}

PeeringsClient contains the methods for the Peerings group. Don't use this type directly, use NewPeeringsClient() instead.

func NewPeeringsClient

func NewPeeringsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeeringsClient

NewPeeringsClient creates a new instance of PeeringsClient with the specified values.

func (*PeeringsClient) CreateOrUpdate

func (client *PeeringsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, peeringName string, peering Peering, options *PeeringsCreateOrUpdateOptions) (PeeringsCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/CreateDirectPeering.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<peering-name>",
		armpeering.Peering{
			Kind:     armpeering.KindDirect.ToPtr(),
			Location: to.StringPtr("<location>"),
			Properties: &armpeering.PeeringProperties{
				Direct: &armpeering.PeeringPropertiesDirect{
					Connections: []*armpeering.DirectConnection{
						{
							BandwidthInMbps: to.Int32Ptr(10000),
							BgpSession: &armpeering.BgpSession{
								MaxPrefixesAdvertisedV4: to.Int32Ptr(1000),
								MaxPrefixesAdvertisedV6: to.Int32Ptr(100),
								MD5AuthenticationKey:    to.StringPtr("<md5authentication-key>"),
								SessionPrefixV4:         to.StringPtr("<session-prefix-v4>"),
								SessionPrefixV6:         to.StringPtr("<session-prefix-v6>"),
							},
							ConnectionIdentifier:   to.StringPtr("<connection-identifier>"),
							PeeringDBFacilityID:    to.Int32Ptr(99999),
							SessionAddressProvider: armpeering.SessionAddressProviderPeer.ToPtr(),
							UseForPeeringService:   to.BoolPtr(false),
						},
						{
							BandwidthInMbps: to.Int32Ptr(10000),
							BgpSession: &armpeering.BgpSession{
								MaxPrefixesAdvertisedV4: to.Int32Ptr(1000),
								MaxPrefixesAdvertisedV6: to.Int32Ptr(100),
								MD5AuthenticationKey:    to.StringPtr("<md5authentication-key>"),
								SessionPrefixV4:         to.StringPtr("<session-prefix-v4>"),
								SessionPrefixV6:         to.StringPtr("<session-prefix-v6>"),
							},
							ConnectionIdentifier:   to.StringPtr("<connection-identifier>"),
							PeeringDBFacilityID:    to.Int32Ptr(99999),
							SessionAddressProvider: armpeering.SessionAddressProviderMicrosoft.ToPtr(),
							UseForPeeringService:   to.BoolPtr(true),
						}},
					DirectPeeringType: armpeering.DirectPeeringTypeEdge.ToPtr(),
					PeerAsn: &armpeering.SubResource{
						ID: to.StringPtr("<id>"),
					},
					UseForPeeringService: to.BoolPtr(false),
				},
				PeeringLocation: to.StringPtr("<peering-location>"),
			},
			SKU: &armpeering.PeeringSKU{
				Name: armpeering.NameBasicDirectFree.ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Peering.ID: %s\n", *res.ID)
}
Output:

func (*PeeringsClient) Delete

func (client *PeeringsClient) Delete(ctx context.Context, resourceGroupName string, peeringName string, options *PeeringsDeleteOptions) (PeeringsDeleteResponse, error)

Delete - Deletes an existing peering with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/DeletePeering.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringsClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*PeeringsClient) Get

func (client *PeeringsClient) Get(ctx context.Context, resourceGroupName string, peeringName string, options *PeeringsGetOptions) (PeeringsGetResponse, error)

Get - Gets an existing peering with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/GetPeering.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Peering.ID: %s\n", *res.ID)
}
Output:

func (*PeeringsClient) ListByResourceGroup

func (client *PeeringsClient) ListByResourceGroup(resourceGroupName string, options *PeeringsListByResourceGroupOptions) *PeeringsListByResourceGroupPager

ListByResourceGroup - Lists all of the peerings under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeeringsByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Peering.ID: %s\n", *v.ID)
		}
	}
}
Output:

func (*PeeringsClient) ListBySubscription

ListBySubscription - Lists all of the peerings under the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPeeringsBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringsClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Peering.ID: %s\n", *v.ID)
		}
	}
}
Output:

func (*PeeringsClient) Update

func (client *PeeringsClient) Update(ctx context.Context, resourceGroupName string, peeringName string, tags ResourceTags, options *PeeringsUpdateOptions) (PeeringsUpdateResponse, error)

Update - Updates tags for a peering with the specified name under the given subscription and resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/UpdatePeeringTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPeeringsClient("<subscription-id>", cred, nil)
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<peering-name>",
		armpeering.ResourceTags{
			Tags: map[string]*string{
				"tag0": to.StringPtr("value0"),
				"tag1": to.StringPtr("value1"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Peering.ID: %s\n", *res.ID)
}
Output:

type PeeringsCreateOrUpdateOptions

type PeeringsCreateOrUpdateOptions struct {
}

PeeringsCreateOrUpdateOptions contains the optional parameters for the Peerings.CreateOrUpdate method.

type PeeringsCreateOrUpdateResponse

type PeeringsCreateOrUpdateResponse struct {
	PeeringsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringsCreateOrUpdateResponse contains the response from method Peerings.CreateOrUpdate.

type PeeringsCreateOrUpdateResult

type PeeringsCreateOrUpdateResult struct {
	Peering
}

PeeringsCreateOrUpdateResult contains the result from method Peerings.CreateOrUpdate.

type PeeringsDeleteOptions

type PeeringsDeleteOptions struct {
}

PeeringsDeleteOptions contains the optional parameters for the Peerings.Delete method.

type PeeringsDeleteResponse

type PeeringsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringsDeleteResponse contains the response from method Peerings.Delete.

type PeeringsGetOptions

type PeeringsGetOptions struct {
}

PeeringsGetOptions contains the optional parameters for the Peerings.Get method.

type PeeringsGetResponse

type PeeringsGetResponse struct {
	PeeringsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringsGetResponse contains the response from method Peerings.Get.

type PeeringsGetResult

type PeeringsGetResult struct {
	Peering
}

PeeringsGetResult contains the result from method Peerings.Get.

type PeeringsListByResourceGroupOptions

type PeeringsListByResourceGroupOptions struct {
}

PeeringsListByResourceGroupOptions contains the optional parameters for the Peerings.ListByResourceGroup method.

type PeeringsListByResourceGroupPager

type PeeringsListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

PeeringsListByResourceGroupPager provides operations for iterating over paged responses.

func (*PeeringsListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*PeeringsListByResourceGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeeringsListByResourceGroupPager) PageResponse

PageResponse returns the current PeeringsListByResourceGroupResponse page.

type PeeringsListByResourceGroupResponse

type PeeringsListByResourceGroupResponse struct {
	PeeringsListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringsListByResourceGroupResponse contains the response from method Peerings.ListByResourceGroup.

type PeeringsListByResourceGroupResult

type PeeringsListByResourceGroupResult struct {
	PeeringListResult
}

PeeringsListByResourceGroupResult contains the result from method Peerings.ListByResourceGroup.

type PeeringsListBySubscriptionOptions

type PeeringsListBySubscriptionOptions struct {
}

PeeringsListBySubscriptionOptions contains the optional parameters for the Peerings.ListBySubscription method.

type PeeringsListBySubscriptionPager

type PeeringsListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

PeeringsListBySubscriptionPager provides operations for iterating over paged responses.

func (*PeeringsListBySubscriptionPager) Err

Err returns the last error encountered while paging.

func (*PeeringsListBySubscriptionPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeeringsListBySubscriptionPager) PageResponse

PageResponse returns the current PeeringsListBySubscriptionResponse page.

type PeeringsListBySubscriptionResponse

type PeeringsListBySubscriptionResponse struct {
	PeeringsListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringsListBySubscriptionResponse contains the response from method Peerings.ListBySubscription.

type PeeringsListBySubscriptionResult

type PeeringsListBySubscriptionResult struct {
	PeeringListResult
}

PeeringsListBySubscriptionResult contains the result from method Peerings.ListBySubscription.

type PeeringsUpdateOptions

type PeeringsUpdateOptions struct {
}

PeeringsUpdateOptions contains the optional parameters for the Peerings.Update method.

type PeeringsUpdateResponse

type PeeringsUpdateResponse struct {
	PeeringsUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeeringsUpdateResponse contains the response from method Peerings.Update.

type PeeringsUpdateResult

type PeeringsUpdateResult struct {
	Peering
}

PeeringsUpdateResult contains the result from method Peerings.Update.

type PrefixValidationState

type PrefixValidationState string

PrefixValidationState - The prefix validation state

const (
	PrefixValidationStateFailed   PrefixValidationState = "Failed"
	PrefixValidationStateInvalid  PrefixValidationState = "Invalid"
	PrefixValidationStateNone     PrefixValidationState = "None"
	PrefixValidationStatePending  PrefixValidationState = "Pending"
	PrefixValidationStateUnknown  PrefixValidationState = "Unknown"
	PrefixValidationStateVerified PrefixValidationState = "Verified"
)

func PossiblePrefixValidationStateValues

func PossiblePrefixValidationStateValues() []PrefixValidationState

PossiblePrefixValidationStateValues returns the possible values for the PrefixValidationState const type.

func (PrefixValidationState) ToPtr

ToPtr returns a *PrefixValidationState pointing to the current value.

type PrefixesClient

type PrefixesClient struct {
	// contains filtered or unexported fields
}

PrefixesClient contains the methods for the Prefixes group. Don't use this type directly, use NewPrefixesClient() instead.

func NewPrefixesClient

func NewPrefixesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrefixesClient

NewPrefixesClient creates a new instance of PrefixesClient with the specified values.

func (*PrefixesClient) ListByPeeringService

func (client *PrefixesClient) ListByPeeringService(resourceGroupName string, peeringServiceName string, options *PrefixesListByPeeringServiceOptions) *PrefixesListByPeeringServicePager

ListByPeeringService - Lists the peerings prefix in the resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/preview/2019-08-01-preview/examples/ListPrefixesByPeeringService.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/peering/armpeering"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armpeering.NewPrefixesClient("<subscription-id>", cred, nil)
	pager := client.ListByPeeringService("<resource-group-name>",
		"<peering-service-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PeeringServicePrefix.ID: %s\n", *v.ID)
		}
	}
}
Output:

type PrefixesListByPeeringServiceOptions

type PrefixesListByPeeringServiceOptions struct {
}

PrefixesListByPeeringServiceOptions contains the optional parameters for the Prefixes.ListByPeeringService method.

type PrefixesListByPeeringServicePager

type PrefixesListByPeeringServicePager struct {
	// contains filtered or unexported fields
}

PrefixesListByPeeringServicePager provides operations for iterating over paged responses.

func (*PrefixesListByPeeringServicePager) Err

Err returns the last error encountered while paging.

func (*PrefixesListByPeeringServicePager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrefixesListByPeeringServicePager) PageResponse

PageResponse returns the current PrefixesListByPeeringServiceResponse page.

type PrefixesListByPeeringServiceResponse

type PrefixesListByPeeringServiceResponse struct {
	PrefixesListByPeeringServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrefixesListByPeeringServiceResponse contains the response from method Prefixes.ListByPeeringService.

type PrefixesListByPeeringServiceResult

type PrefixesListByPeeringServiceResult struct {
	PeeringServicePrefixListResult
}

PrefixesListByPeeringServiceResult contains the result from method Prefixes.ListByPeeringService.

type ProvisioningState

type ProvisioningState string

ProvisioningState - The provisioning state of the resource.

const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

func (ProvisioningState) ToPtr

ToPtr returns a *ProvisioningState pointing to the current value.

type Resource

type Resource struct {
	// READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - The ARM resource class.

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceTags

type ResourceTags struct {
	// Gets or sets the tags, a dictionary of descriptors arm object
	Tags map[string]*string `json:"tags,omitempty"`
}

ResourceTags - The resource tags.

func (ResourceTags) MarshalJSON

func (r ResourceTags) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTags.

type SessionAddressProvider

type SessionAddressProvider string

SessionAddressProvider - The field indicating if Microsoft provides session ip addresses.

const (
	SessionAddressProviderMicrosoft SessionAddressProvider = "Microsoft"
	SessionAddressProviderPeer      SessionAddressProvider = "Peer"
)

func PossibleSessionAddressProviderValues

func PossibleSessionAddressProviderValues() []SessionAddressProvider

PossibleSessionAddressProviderValues returns the possible values for the SessionAddressProvider const type.

func (SessionAddressProvider) ToPtr

ToPtr returns a *SessionAddressProvider pointing to the current value.

type SessionStateV4

type SessionStateV4 string

SessionStateV4 - The state of the IPv4 session.

const (
	SessionStateV4Active        SessionStateV4 = "Active"
	SessionStateV4Connect       SessionStateV4 = "Connect"
	SessionStateV4Established   SessionStateV4 = "Established"
	SessionStateV4Idle          SessionStateV4 = "Idle"
	SessionStateV4None          SessionStateV4 = "None"
	SessionStateV4OpenConfirm   SessionStateV4 = "OpenConfirm"
	SessionStateV4OpenReceived  SessionStateV4 = "OpenReceived"
	SessionStateV4OpenSent      SessionStateV4 = "OpenSent"
	SessionStateV4PendingAdd    SessionStateV4 = "PendingAdd"
	SessionStateV4PendingRemove SessionStateV4 = "PendingRemove"
	SessionStateV4PendingUpdate SessionStateV4 = "PendingUpdate"
)

func PossibleSessionStateV4Values

func PossibleSessionStateV4Values() []SessionStateV4

PossibleSessionStateV4Values returns the possible values for the SessionStateV4 const type.

func (SessionStateV4) ToPtr

func (c SessionStateV4) ToPtr() *SessionStateV4

ToPtr returns a *SessionStateV4 pointing to the current value.

type SessionStateV6

type SessionStateV6 string

SessionStateV6 - The state of the IPv6 session.

const (
	SessionStateV6Active        SessionStateV6 = "Active"
	SessionStateV6Connect       SessionStateV6 = "Connect"
	SessionStateV6Established   SessionStateV6 = "Established"
	SessionStateV6Idle          SessionStateV6 = "Idle"
	SessionStateV6None          SessionStateV6 = "None"
	SessionStateV6OpenConfirm   SessionStateV6 = "OpenConfirm"
	SessionStateV6OpenReceived  SessionStateV6 = "OpenReceived"
	SessionStateV6OpenSent      SessionStateV6 = "OpenSent"
	SessionStateV6PendingAdd    SessionStateV6 = "PendingAdd"
	SessionStateV6PendingRemove SessionStateV6 = "PendingRemove"
	SessionStateV6PendingUpdate SessionStateV6 = "PendingUpdate"
)

func PossibleSessionStateV6Values

func PossibleSessionStateV6Values() []SessionStateV6

PossibleSessionStateV6Values returns the possible values for the SessionStateV6 const type.

func (SessionStateV6) ToPtr

func (c SessionStateV6) ToPtr() *SessionStateV6

ToPtr returns a *SessionStateV6 pointing to the current value.

type Size

type Size string

Size - The size of the peering SKU.

const (
	SizeFree      Size = "Free"
	SizeMetered   Size = "Metered"
	SizeUnlimited Size = "Unlimited"
)

func PossibleSizeValues

func PossibleSizeValues() []Size

PossibleSizeValues returns the possible values for the Size const type.

func (Size) ToPtr

func (c Size) ToPtr() *Size

ToPtr returns a *Size pointing to the current value.

type SubResource

type SubResource struct {
	// The identifier of the referenced resource.
	ID *string `json:"id,omitempty"`
}

SubResource - The sub resource.

type Tier

type Tier string

Tier - The tier of the peering SKU.

const (
	TierBasic   Tier = "Basic"
	TierPremium Tier = "Premium"
)

func PossibleTierValues

func PossibleTierValues() []Tier

PossibleTierValues returns the possible values for the Tier const type.

func (Tier) ToPtr

func (c Tier) ToPtr() *Tier

ToPtr returns a *Tier pointing to the current value.

type ValidationState

type ValidationState string

ValidationState - The validation state of the ASN associated with the peer.

const (
	ValidationStateApproved ValidationState = "Approved"
	ValidationStateFailed   ValidationState = "Failed"
	ValidationStateNone     ValidationState = "None"
	ValidationStatePending  ValidationState = "Pending"
)

func PossibleValidationStateValues

func PossibleValidationStateValues() []ValidationState

PossibleValidationStateValues returns the possible values for the ValidationState const type.

func (ValidationState) ToPtr

func (c ValidationState) ToPtr() *ValidationState

ToPtr returns a *ValidationState pointing to the current value.

Jump to

Keyboard shortcuts

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