Microsoft.Peering (preview:2020-01-01)

2025/10/23 • 35 new, 35 deleted methods

CheckServiceProviderAvailability (new)
Description :  Checks if the peering service provider is present within 1000 miles of customer's location
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/CheckServiceProviderAvailability
{
checkServiceProviderAvailabilityInput:
{
Description: The CheckServiceProviderAvailabilityInput indicating customer location and service provider. ,
Required: True ,
}
{
peeringServiceLocation:
{
Description: Gets or sets the peering service location. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: Gets or sets the peering service provider. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Enum:
[
[
Available ,
,
]
,
[
Unavailable ,
,
]
,
]
,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
LegacyPeerings_List (new)
Description :  Lists all of the legacy peerings under the given subscription matching the specified kind and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/legacyPeerings
{
peeringLocation:
{
Description: The location of the peering. ,
Required: True ,
}
string ,
kind:
{
Description: The kind of the peering. ,
Required: True ,
}
string ,
asn:
{
Description: The ASN number associated with a legacy peering. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peerings. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peerings. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Operations_List (new)
Description :  Lists all of the available API operations for peering resources.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Peering/operations
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering API operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The information related to the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the resource provider. ,
Required: False ,
}
string ,
resource:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
operation:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: The flag that indicates whether the operation applies to data plane. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering API operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_Get (new)
Description :  Gets the peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
peerAsnName:
{
Description: The peer ASN name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_CreateOrUpdate (new)
Description :  Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
peerAsnName:
{
Description: The peer ASN name. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The peer ASN. ,
Required: True ,
}
{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_Delete (new)
Description :  Deletes an existing peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
peerAsnName:
{
Description: The peer ASN name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_ListBySubscription (new)
Description :  Lists all of the peer ASNs under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peer ASNs. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peer ASNs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringLocations_List (new)
Description :  Lists all of the available peering locations for the specified kind of peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringLocations
{
kind:
{
Description: The kind of the peering. ,
Required: True ,
}
string ,
directPeeringType:
{
Description: The type of direct peering. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering locations. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of peering that the peering location supports. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties that define a peering location. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering location. ,
Required: False ,
}
{
peeringFacilities:
{
Description: The list of direct peering facilities at the peering location. ,
Required: False ,
}
[
{
address:
{
Description: The address of the direct peering facility. ,
Required: False ,
}
string ,
directPeeringType:
{
Description: The type of the direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringDBFacilityLink:
{
Description: The PeeringDB.com URL of the facility. ,
Required: False ,
}
string ,
}
,
]
,
bandwidthOffers:
{
Description: The list of bandwidth offers available at the peering location. ,
Required: False ,
}
[
{
offerName:
{
Description: The name of the bandwidth offer. ,
Required: False ,
}
string ,
valueInMbps:
{
Description: The value of the bandwidth offer in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
exchange:
{
Description: The properties that define an exchange peering location. ,
Required: False ,
}
{
peeringFacilities:
{
Description: The list of exchange peering facilities at the peering location. ,
Required: False ,
}
[
{
exchangeName:
{
Description: The name of the exchange peering facility. ,
Required: False ,
}
string ,
bandwidthInMbps:
{
Description: The bandwidth of the connection between Microsoft and the exchange peering facility. ,
Format: int32 ,
Required: False ,
}
integer ,
microsoftIPv4Address:
{
Description: The IPv4 address of Microsoft at the exchange peering facility. ,
Required: False ,
}
string ,
microsoftIPv6Address:
{
Description: The IPv6 address of Microsoft at the exchange peering facility. ,
Required: False ,
}
string ,
facilityIPv4Prefix:
{
Description: The IPv4 prefixes associated with the exchange peering facility. ,
Required: False ,
}
string ,
facilityIPv6Prefix:
{
Description: The IPv6 prefixes associated with the exchange peering facility. ,
Required: False ,
}
string ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringDBFacilityLink:
{
Description: The PeeringDB.com URL of the facility. ,
Required: False ,
}
string ,
}
,
]
,
}
,
peeringLocation:
{
Description: The name of the peering location. ,
Required: False ,
}
string ,
country:
{
Description: The country in which the peering location exists. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region associated with the peering location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering locations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_Get (new)
Description :  Gets an existing registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the registered ASN. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_CreateOrUpdate (new)
Description :  Creates a new registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the ASN. ,
Required: True ,
}
string ,
registeredAsn:
{
Description: The properties needed to create a registered ASN. ,
Required: True ,
}
{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_Delete (new)
Description :  Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the registered ASN. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_ListByPeering (new)
Description :  Lists all registered ASNs under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering registered ASNs. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering registered ASNs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_Get (new)
Description :  Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_CreateOrUpdate (new)
Description :  Creates a new registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
Required: True ,
}
string ,
registeredPrefix:
{
Description: The properties needed to create a registered prefix. ,
Required: True ,
}
{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_Delete (new)
Description :  Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_ListByPeering (new)
Description :  Lists all registered prefixes under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering registered prefixes. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering registered prefixes. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_Get (new)
Description :  Gets an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_CreateOrUpdate (new)
Description :  Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
peering:
{
Description: The properties needed to create or update a peering. ,
Required: True ,
}
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_Delete (new)
Description :  Deletes an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_Update (new)
Description :  Updates tags for a peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: True ,
}
{
tags:
{
Description: Gets or sets the tags, a dictionary of descriptors arm object ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_ListByResourceGroup (new)
Description :  Lists all of the peerings under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peerings. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peerings. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_ListBySubscription (new)
Description :  Lists all of the peerings under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerings
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peerings. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peerings. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServiceCountries_List (new)
Description :  Lists all of the available countries for peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceCountries
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service countries. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service countries. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServiceLocations_List (new)
Description :  Lists all of the available locations for peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceLocations
{
country:
{
Description: The country of interest, in which the locations are to be present. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service locations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a peering service location. ,
Required: False ,
}
{
country:
{
Description: Country of the customer ,
Required: False ,
}
string ,
state:
{
Description: State of the customer ,
Required: False ,
}
string ,
azureRegion:
{
Description: Azure region for the location ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service locations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_Get (new)
Description :  Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
$expand:
{
Description: The properties to be expanded. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_CreateOrUpdate (new)
Description :  Creates a new prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
peeringServicePrefix:
{
Description: The properties needed to create a prefix. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_Delete (new)
Description :  Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_ListByPeeringService (new)
Description :  Lists all prefixes under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
$expand:
{
Description: The properties to be expanded. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service prefixes. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service prefixes. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServiceProviders_List (new)
Description :  Lists all of the available peering service locations for the specified kind of peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceProviders
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service providers. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a peering service provider. ,
Required: False ,
}
{
serviceProviderName:
{
Description: The name of the service provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service providers. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_Get (new)
Description :  Gets an existing peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_CreateOrUpdate (new)
Description :  Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
peeringService:
{
Description: The properties needed to create or update a peering service. ,
Required: True ,
}
{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_Delete (new)
Description :  Deletes an existing peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_Update (new)
Description :  Updates tags for a peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: True ,
}
{
tags:
{
Description: Gets or sets the tags, a dictionary of descriptors arm object ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_ListByResourceGroup (new)
Description :  Lists all of the peering services under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering services. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering services. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_ListBySubscription (new)
Description :  Lists all of the peerings under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServices
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering services. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering services. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
CheckServiceProviderAvailability (removed)
Description :  Checks if the peering service provider is present within 1000 miles of customer's location
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/CheckServiceProviderAvailability
{
checkServiceProviderAvailabilityInput:
{
Description: The CheckServiceProviderAvailabilityInput indicating customer location and service provider. ,
Required: True ,
}
{
peeringServiceLocation:
{
Description: Gets or sets the peering service location. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: Gets or sets the peering service provider. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Enum:
[
[
Available ,
,
]
,
[
Unavailable ,
,
]
,
]
,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
LegacyPeerings_List (removed)
Description :  Lists all of the legacy peerings under the given subscription matching the specified kind and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/legacyPeerings
{
peeringLocation:
{
Description: The location of the peering. ,
Required: True ,
}
string ,
kind:
{
Description: The kind of the peering. ,
Required: True ,
}
string ,
asn:
{
Description: The ASN number associated with a legacy peering. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peerings. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peerings. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists all of the available API operations for peering resources.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Peering/operations
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering API operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The information related to the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the resource provider. ,
Required: False ,
}
string ,
resource:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
operation:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: The flag that indicates whether the operation applies to data plane. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering API operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_Get (removed)
Description :  Gets the peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
peerAsnName:
{
Description: The peer ASN name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_CreateOrUpdate (removed)
Description :  Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
peerAsnName:
{
Description: The peer ASN name. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The peer ASN. ,
Required: True ,
}
{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_Delete (removed)
Description :  Deletes an existing peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
peerAsnName:
{
Description: The peer ASN name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeerAsns_ListBySubscription (removed)
Description :  Lists all of the peer ASNs under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peer ASNs. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a peer's ASN. ,
Required: False ,
}
{
peerAsn:
{
Description: The Autonomous System Number (ASN) of the peer. ,
Format: int32 ,
Required: False ,
}
integer ,
peerContactDetail:
{
Description: The contact details of the peer. ,
Required: False ,
}
[
{
role:
{
Description: The role of the contact. ,
Enum:
{
Noc: No description available. ,
Policy: No description available. ,
Technical: No description available. ,
Service: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
email:
{
Description: The e-mail address of the contact. ,
Required: False ,
}
string ,
phone:
{
Description: The phone number of the contact. ,
Required: False ,
}
string ,
}
,
]
,
peerName:
{
Description: The name of the peer. ,
Required: False ,
}
string ,
validationState:
{
Description: The validation state of the ASN associated with the peer. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for the validation state ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peer ASNs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringLocations_List (removed)
Description :  Lists all of the available peering locations for the specified kind of peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringLocations
{
kind:
{
Description: The kind of the peering. ,
Required: True ,
}
string ,
directPeeringType:
{
Description: The type of direct peering. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering locations. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of peering that the peering location supports. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties that define a peering location. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering location. ,
Required: False ,
}
{
peeringFacilities:
{
Description: The list of direct peering facilities at the peering location. ,
Required: False ,
}
[
{
address:
{
Description: The address of the direct peering facility. ,
Required: False ,
}
string ,
directPeeringType:
{
Description: The type of the direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringDBFacilityLink:
{
Description: The PeeringDB.com URL of the facility. ,
Required: False ,
}
string ,
}
,
]
,
bandwidthOffers:
{
Description: The list of bandwidth offers available at the peering location. ,
Required: False ,
}
[
{
offerName:
{
Description: The name of the bandwidth offer. ,
Required: False ,
}
string ,
valueInMbps:
{
Description: The value of the bandwidth offer in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
exchange:
{
Description: The properties that define an exchange peering location. ,
Required: False ,
}
{
peeringFacilities:
{
Description: The list of exchange peering facilities at the peering location. ,
Required: False ,
}
[
{
exchangeName:
{
Description: The name of the exchange peering facility. ,
Required: False ,
}
string ,
bandwidthInMbps:
{
Description: The bandwidth of the connection between Microsoft and the exchange peering facility. ,
Format: int32 ,
Required: False ,
}
integer ,
microsoftIPv4Address:
{
Description: The IPv4 address of Microsoft at the exchange peering facility. ,
Required: False ,
}
string ,
microsoftIPv6Address:
{
Description: The IPv6 address of Microsoft at the exchange peering facility. ,
Required: False ,
}
string ,
facilityIPv4Prefix:
{
Description: The IPv4 prefixes associated with the exchange peering facility. ,
Required: False ,
}
string ,
facilityIPv6Prefix:
{
Description: The IPv6 prefixes associated with the exchange peering facility. ,
Required: False ,
}
string ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringDBFacilityLink:
{
Description: The PeeringDB.com URL of the facility. ,
Required: False ,
}
string ,
}
,
]
,
}
,
peeringLocation:
{
Description: The name of the peering location. ,
Required: False ,
}
string ,
country:
{
Description: The country in which the peering location exists. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region associated with the peering location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering locations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_Get (removed)
Description :  Gets an existing registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the registered ASN. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_CreateOrUpdate (removed)
Description :  Creates a new registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the ASN. ,
Required: True ,
}
string ,
registeredAsn:
{
Description: The properties needed to create a registered ASN. ,
Required: True ,
}
{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_Delete (removed)
Description :  Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the registered ASN. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredAsns_ListByPeering (removed)
Description :  Lists all registered ASNs under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering registered ASNs. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a registered ASN. ,
Required: False ,
}
{
asn:
{
Description: The customer's ASN from which traffic originates. ,
Format: int32 ,
Required: False ,
}
integer ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering registered ASNs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_Get (removed)
Description :  Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_CreateOrUpdate (removed)
Description :  Creates a new registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
Required: True ,
}
string ,
registeredPrefix:
{
Description: The properties needed to create a registered prefix. ,
Required: True ,
}
{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_Delete (removed)
Description :  Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
RegisteredPrefixes_ListByPeering (removed)
Description :  Lists all registered prefixes under the given subscription, resource group and peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering registered prefixes. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a registered prefix. ,
Required: False ,
}
{
prefix:
{
Description: The customer's prefix from which traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state. ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
peeringServicePrefixKey:
{
Description: The peering service prefix key that is to be shared with the customer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message associated with the validation state, if any. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering registered prefixes. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_Get (removed)
Description :  Gets an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_CreateOrUpdate (removed)
Description :  Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
peering:
{
Description: The properties needed to create or update a peering. ,
Required: True ,
}
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_Delete (removed)
Description :  Deletes an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_Update (removed)
Description :  Updates tags for a peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: True ,
}
{
tags:
{
Description: Gets or sets the tags, a dictionary of descriptors arm object ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_ListByResourceGroup (removed)
Description :  Lists all of the peerings under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peerings. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peerings. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Peerings_ListBySubscription (removed)
Description :  Lists all of the peerings under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerings
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peerings. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the tier and kind of the peering. ,
Required: True ,
}
{
name:
{
Description: The name of the peering SKU. ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the peering SKU. ,
Enum:
{
Basic: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family of the peering SKU. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The size of the peering SKU. ,
Enum:
{
Free: No description available. ,
Metered: No description available. ,
Unlimited: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: The kind of the peering. ,
Enum:
{
Direct: No description available. ,
Exchange: No description available. ,
}
,
Required: True ,
}
enum ,
properties:
{
Description: The properties that define a peering. ,
Required: False ,
}
{
direct:
{
Description: The properties that define a direct peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute a direct peering. ,
Required: False ,
}
[
{
bandwidthInMbps:
{
Description: The bandwidth of the connection. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthInMbps:
{
Description: The bandwidth that is actually provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionAddressProvider:
{
Description: The field indicating if Microsoft provides session ip addresses. ,
Enum:
{
Microsoft: No description available. ,
Peer: No description available. ,
}
,
Required: False ,
}
enum ,
useForPeeringService:
{
Description: The flag that indicates whether or not the connection is used for peering service. ,
Required: False ,
}
boolean ,
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
useForPeeringService:
{
Description: The flag that indicates whether or not the peering is used for peering service. ,
Required: False ,
}
boolean ,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
directPeeringType:
{
Description: The type of direct peering. ,
Enum:
{
Edge: No description available. ,
Transit: No description available. ,
Cdn: No description available. ,
Internal: No description available. ,
Ix: No description available. ,
IxRs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exchange:
{
Description: The properties that define an exchange peering. ,
Required: False ,
}
{
connections:
{
Description: The set of connections that constitute an exchange peering. ,
Required: False ,
}
[
{
peeringDBFacilityId:
{
Description: The PeeringDB.com ID of the facility at which the connection has to be set up. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionState:
{
Description: The state of the connection. ,
Enum:
{
None: No description available. ,
PendingApproval: No description available. ,
Approved: No description available. ,
ProvisioningStarted: No description available. ,
ProvisioningFailed: No description available. ,
ProvisioningCompleted: No description available. ,
Validating: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
bgpSession:
{
Description: The BGP session associated with the connection. ,
Required: False ,
}
{
sessionPrefixV4:
{
Description: The IPv4 prefix that contains both ends' IPv4 addresses. ,
Required: False ,
}
string ,
sessionPrefixV6:
{
Description: The IPv6 prefix that contains both ends' IPv6 addresses. ,
Required: False ,
}
string ,
microsoftSessionIPv4Address:
{
Description: The IPv4 session address on Microsoft's end. ,
Required: False ,
}
string ,
microsoftSessionIPv6Address:
{
Description: The IPv6 session address on Microsoft's end. ,
Required: False ,
}
string ,
peerSessionIPv4Address:
{
Description: The IPv4 session address on peer's end. ,
Required: False ,
}
string ,
peerSessionIPv6Address:
{
Description: The IPv6 session address on peer's end. ,
Required: False ,
}
string ,
sessionStateV4:
{
Description: The state of the IPv4 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
sessionStateV6:
{
Description: The state of the IPv6 session. ,
Enum:
{
None: No description available. ,
Idle: No description available. ,
Connect: No description available. ,
Active: No description available. ,
OpenSent: No description available. ,
OpenConfirm: No description available. ,
OpenReceived: No description available. ,
Established: No description available. ,
PendingAdd: No description available. ,
PendingUpdate: No description available. ,
PendingRemove: No description available. ,
}
,
Required: False ,
}
enum ,
maxPrefixesAdvertisedV4:
{
Description: The maximum number of prefixes advertised over the IPv4 session. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPrefixesAdvertisedV6:
{
Description: The maximum number of prefixes advertised over the IPv6 session. ,
Format: int32 ,
Required: False ,
}
integer ,
md5AuthenticationKey:
{
Description: The MD5 authentication key of the session. ,
Required: False ,
}
string ,
}
,
connectionIdentifier:
{
Description: The unique identifier (GUID) for the connection. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message related to the connection state, if any. ,
Required: False ,
}
string ,
}
,
]
,
peerAsn:
{
Description: The reference of the peer ASN. ,
Required: False ,
}
{
id:
{
Description: The identifier of the referenced resource. ,
Required: False ,
}
string ,
}
,
}
,
peeringLocation:
{
Description: The location of the peering. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peerings. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServiceCountries_List (removed)
Description :  Lists all of the available countries for peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceCountries
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service countries. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service countries. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServiceLocations_List (removed)
Description :  Lists all of the available locations for peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceLocations
{
country:
{
Description: The country of interest, in which the locations are to be present. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service locations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a peering service location. ,
Required: False ,
}
{
country:
{
Description: Country of the customer ,
Required: False ,
}
string ,
state:
{
Description: State of the customer ,
Required: False ,
}
string ,
azureRegion:
{
Description: Azure region for the location ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service locations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_Get (removed)
Description :  Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
$expand:
{
Description: The properties to be expanded. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_CreateOrUpdate (removed)
Description :  Creates a new prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
peeringServicePrefix:
{
Description: The properties needed to create a prefix. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_Delete (removed)
Description :  Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Prefixes_ListByPeeringService (removed)
Description :  Lists all prefixes under the given subscription, resource group and peering service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
$expand:
{
Description: The properties to be expanded. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service prefixes. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the peering prefix properties. ,
Required: False ,
}
{
prefix:
{
Description: The prefix from which your traffic originates. ,
Required: False ,
}
string ,
prefixValidationState:
{
Description: The prefix validation state ,
Enum:
{
None: No description available. ,
Invalid: No description available. ,
Verified: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
learnedType:
{
Description: The prefix learned type ,
Enum:
{
None: No description available. ,
ViaServiceProvider: No description available. ,
ViaSession: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message for validation state ,
Required: False ,
}
string ,
events:
{
Description: The list of events for peering service prefix ,
Required: False ,
}
[
{
eventTimestamp:
{
Description: The timestamp of the event associated with a prefix. ,
Format: date-time ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event associated with a prefix. ,
Required: False ,
}
string ,
eventSummary:
{
Description: The summary of the event associated with a prefix. ,
Required: False ,
}
string ,
eventLevel:
{
Description: The level of the event associated with a prefix. ,
Required: False ,
}
string ,
eventDescription:
{
Description: The description of the event associated with a prefix. ,
Required: False ,
}
string ,
}
,
]
,
peeringServicePrefixKey:
{
Description: The peering service prefix key ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service prefixes. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServiceProviders_List (removed)
Description :  Lists all of the available peering service locations for the specified kind of peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceProviders
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering service providers. ,
Required: False ,
}
[
{
properties:
{
Description: The properties that define a peering service provider. ,
Required: False ,
}
{
serviceProviderName:
{
Description: The name of the service provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering service providers. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_Get (removed)
Description :  Gets an existing peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_CreateOrUpdate (removed)
Description :  Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
peeringService:
{
Description: The properties needed to create or update a peering service. ,
Required: True ,
}
{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_Delete (removed)
Description :  Deletes an existing peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_Update (removed)
Description :  Updates tags for a peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering service. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: True ,
}
{
tags:
{
Description: Gets or sets the tags, a dictionary of descriptors arm object ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_ListByResourceGroup (removed)
Description :  Lists all of the peering services under the given subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering services. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering services. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
PeeringServices_ListBySubscription (removed)
Description :  Lists all of the peerings under the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServices
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of peering services. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU that defines the type of the peering service. ,
Required: False ,
}
{
name:
{
Description: The name of the peering service SKU. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The PeeringServiceLocation of the Customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The MAPS Provider Name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering services. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}