Microsoft.Peering (stable:2025-05-01)

2025/12/10 • 45 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available API operations for peering resources."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_863f34fe52e142c681bdde821fe1e608": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_17ac28a0978e45119e323fc41883e6de": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_6129ddd35d6f45a0aa8e744a7346840d": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Peering/operations
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
properties:
{
Description: The properties of the operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specification payload. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Specifications of the Metrics for Azure Monitoring. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localized friendly description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: Unit that makes sense for the metric. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Aggregation type will be set to one of the values: Average, Minimum, Maximum, Total, Count. ,
Required: False ,
}
string ,
supportedTimeGrainTypes:
{
Description: Supported time grain types for the metric. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: Dimensions of the metric. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of peering API operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CdnPeeringPrefixes_List (updated)
Description :  Lists all of the advertised prefixes for the specified peering location
Reference :  Link ¶

⚶ Changes

{
  "#id": "CdnPeeringPrefixes_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a CdnPeeringPrefix list operation.",
        "old": "The paginated list of CDN peering prefixes."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The CdnPeeringPrefix items on this page",
            "old": "The list of CDN peering prefixes."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of CDN peering prefixes."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_66cff95e3b2247d2817d6333a48c96f7": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_3050280137674065a86eaa6c67830898": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_9903e2995b4f42778198f8eea43312e2": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/cdnPeeringPrefixes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
peeringLocation:
{
Description: The peering location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CdnPeeringPrefix items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties that define a cdn peering prefix. ,
Required: False ,
}
{
prefix:
{
Description: The prefix. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region. ,
Required: False ,
}
string ,
azureService:
{
Description: The Azure service. ,
Required: False ,
}
string ,
isPrimaryRegion:
{
Description: The flag that indicates whether or not this is the primary region. ,
Required: False ,
}
boolean ,
bgpCommunity:
{
Description: The BGP Community ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckServiceProviderAvailability (updated)
Description :  Checks if the peering service provider is present within 1000 miles of customer's location
Reference :  Link ¶

⚶ Changes

{
  "#id": "CheckServiceProviderAvailability",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "checkServiceProviderAvailabilityInput",
      "Description": {
        "new": "The request body",
        "old": "The CheckServiceProviderAvailabilityInput indicating customer location and service provider."
      }
    }
  ],
  "$responses": {
    "200": {
      "Enum": {
        "new": [
          [
            "Available",
            "available"
          ],
          [
            "Unavailable",
            "unavailable"
          ]
        ],
        "old": [
          [
            "Available",
            ""
          ],
          [
            "Unavailable",
            ""
          ]
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_9e7e7b38394c498294304a5d5d7554df": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_2304ae93bfcd46dfb2bd76cfd35e378f": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_8b5cbca96bd34bcdbd76720fa8a1807d": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/checkServiceProviderAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
checkServiceProviderAvailabilityInput:
{
Description: The request body ,
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 ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Response for checking service provider availability ,
Enum:
[
[
Available ,
available ,
]
,
[
Unavailable ,
unavailable ,
]
,
]
,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServices_InitializeConnectionMonitor (updated)
Description :  Initialize Peering Service for Connection Monitor functionality
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServices_InitializeConnectionMonitor",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_7a37a8d06c464e59bc50b544a6e1277d": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_a662e521924042caba3df0e480fcd03b": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_da8d5d215072406992cadc60b1a6f5e0": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/initializeConnectionMonitor
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LegacyPeerings_List (updated)
Description :  Lists all of the legacy peerings under the given subscription matching the specified kind and location.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LegacyPeerings_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Peering list operation.",
        "old": "The paginated list of peerings."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Peering items on this page",
            "old": "The list of peerings."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "connectivityProbes": {
                    "Description": {
                      "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                      "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
                    },
                    "$properties": [
                      {
                        "#name": "prefixesToAccesslist",
                        "Description": {
                          "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                          "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                        }
                      }
                    ]
                  }
                }
              ],
              "@removed_b795a594a5f6442a86722ceabfec51bd": {
                "#name": "location",
                "Description": "The location of the resource.",
                "Required": true,
                "Type": "string"
              },
              "@removed_4702523a4e2b4305ad708932167407bf": {
                "#name": "tags",
                "Description": "The resource tags.",
                "Required": false,
                "Type": "object"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peerings."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_c1a5436df8894f2480346ec51ebc0362": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_528d3f95a23446c7a86c7cf8ed0ff92f": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_03d8fae35cb64fc5be95be9d56470e9d": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/legacyPeerings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
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 ,
directPeeringType:
{
Description: The direct peering type. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Peering items on this page ,
Required: True ,
}
[
{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LookingGlass_Invoke (updated)
Description :  Run looking glass functionality
Reference :  Link ¶

⚶ Changes

{
  "#id": "LookingGlass_Invoke",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_df3627d012234333844253b7b1d32dbd": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_b56e3b114f7a4e74b8776e90c46c750f": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_123bfd3af13d468f877c4be90122e28a": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/lookingGlass
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
command:
{
Description: The command to be executed: ping, traceroute, bgpRoute. ,
Required: True ,
}
string ,
sourceType:
{
Description: The type of the source: Edge site or Azure Region. ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source. ,
Required: True ,
}
string ,
destinationIP:
{
Description: The IP address of the destination. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
command:
{
Description: Invoked command ,
Enum:
{
Traceroute: No description available. ,
Ping: No description available. ,
BgpRoute: No description available. ,
}
,
Required: False ,
}
enum ,
output:
{
Description: Output of the command ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeerAsns_ListBySubscription (updated)
Description :  Lists all of the peer ASNs under the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeerAsns_ListBySubscription",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeerAsn list operation.",
        "old": "The paginated list of peer ASNs."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeerAsn items on this page",
            "old": "The list of peer ASNs."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peer ASNs."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_a5936dabe23a4b88a188444ad5ac48a2": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_b5b165d6492a4624927a1da4a94582b4": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_8dc644755e9047419363c9cca5d66c10": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeerAsn items on this page ,
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. ,
Escalation: 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 the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeerAsns_Get (updated)
Description :  Gets the peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeerAsns_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_038bfba83157445db376de2881db28b9": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_5287acf5d10c44e7b3c8c966ae03e5fc": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_53e279a7a237454f800f25290f9e1c7b": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
peerAsnName:
{
Description: The peer ASN name. ,
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. ,
Escalation: 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeerAsns_CreateOrUpdate (updated)
Description :  Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeerAsns_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_220dac6d88dd4f17a8f998a31bfeb4f2": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_e9faa9c9c32d488c9097f274bb11544b": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_aa42c6709a964e289bfe5842e05fbb14": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
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. ,
Escalation: 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 (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. ,
Escalation: 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. ,
Escalation: 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeerAsns_Delete (updated)
Description :  Deletes an existing peer ASN with the specified name under the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeerAsns_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_ae80f3e387804b91a03faf347d24f235": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_cdbd1eb0ee0e4b09a70efc8b617448cc": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_e9434ce7c61244e89c2bd22e46f722f5": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
peerAsnName:
{
Description: The peer ASN name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringLocations_List (updated)
Description :  Lists all of the available peering locations for the specified kind of peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringLocations_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringLocation list operation.",
        "old": "The paginated list of peering locations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringLocation items on this page",
            "old": "The list of peering locations."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering locations."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_d5e858b4439048718adf5c604858dfe7": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_4e753aa620ed43a3a49a10a34ad55dd8": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_3c420d1035c24395a6f10df1aea14313": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The PeeringLocation items on this page ,
Required: True ,
}
[
{
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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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 the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServiceCountries_List (updated)
Description :  Lists all of the available countries for peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServiceCountries_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringServiceCountry list operation.",
        "old": "The paginated list of peering service countries."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringServiceCountry items on this page",
            "old": "The list of peering service countries."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering service countries."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_d40ee21f3a494692846ae13825c33b9c": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_9731b50e306342238913e2c2c9f53cb2": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_7bdf842c97084c21a65106a890ec40ce": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceCountries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringServiceCountry items on this page ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServiceLocations_List (updated)
Description :  Lists all of the available locations for peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServiceLocations_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringServiceLocation list operation.",
        "old": "The paginated list of peering service locations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringServiceLocation items on this page",
            "old": "The list of peering service locations."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering service locations."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_377117f1941444b7a63e7458cfa6db64": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_4be419726dcf48e79ef1253ffb8506ca": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_fa719d562f514dc1bf7f1c860d30ecd5": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The PeeringServiceLocation items on this page ,
Required: True ,
}
[
{
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 the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServiceProviders_List (updated)
Description :  Lists all of the available peering service locations for the specified kind of peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServiceProviders_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringServiceProvider list operation.",
        "old": "The paginated list of peering service providers."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringServiceProvider items on this page",
            "old": "The list of peering service providers."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering service providers."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_4c0339ef066c472d87ca1c85343c79f7": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_13ba557e5b7a4c55ae9181c45b413039": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_f14cfddebd6c48cc86301c9a362eb0ba": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceProviders
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringServiceProvider items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties that define a peering service provider. ,
Required: False ,
}
{
serviceProviderName:
{
Description: The name of the service provider. ,
Required: False ,
}
string ,
peeringLocations:
{
Description: The list of locations at which the service provider peers with Microsoft. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServices_ListBySubscription (updated)
Description :  Lists all of the peerings under the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServices_ListBySubscription",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringService list operation.",
        "old": "The paginated list of peering services."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringService items on this page",
            "old": "The list of peering services."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_c8f79f66854c4f8f9f43bb54bdc81b05": {
                "#name": "location",
                "Description": "The location of the resource.",
                "Required": true,
                "Type": "string"
              },
              "@removed_56410aa9f13a4957866ccddf7118fb88": {
                "#name": "tags",
                "Description": "The resource tags.",
                "Required": false,
                "Type": "object"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering services."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_4d4b7ba6edb54ecc8bb25d29850cff82": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_0629135d9b6d4b7eb177d7feba439ac8": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_3d0f12e6e23247b4a38d219952b4e58b": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringService items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The location (state/province) of the customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The name of the service provider. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
providerPrimaryPeeringLocation:
{
Description: The primary peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
providerBackupPeeringLocation:
{
Description: The backup peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
logAnalyticsWorkspaceProperties:
{
Description: The Log Analytics Workspace Properties ,
Required: False ,
}
{
workspaceID:
{
Description: The Workspace ID. ,
Required: False ,
}
string ,
key:
{
Description: The Workspace Key. ,
Required: False ,
}
string ,
connectedAgents:
{
Description: The list of connected agents. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Peerings_ListBySubscription (updated)
Description :  Lists all of the peerings under the given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Peerings_ListBySubscription",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Peering list operation.",
        "old": "The paginated list of peerings."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Peering items on this page",
            "old": "The list of peerings."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "connectivityProbes": {
                    "Description": {
                      "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                      "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
                    },
                    "$properties": [
                      {
                        "#name": "prefixesToAccesslist",
                        "Description": {
                          "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                          "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                        }
                      }
                    ]
                  }
                }
              ],
              "@removed_a9287d5fec144fce83496c72d223022b": {
                "#name": "location",
                "Description": "The location of the resource.",
                "Required": true,
                "Type": "string"
              },
              "@removed_ef6422672b354af4941f9fca429bd548": {
                "#name": "tags",
                "Description": "The resource tags.",
                "Required": false,
                "Type": "object"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peerings."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_050d0340aea84bdebb8c059e010c1b44": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_7c2a5fafc4624f5ca4b9d5f456d28d17": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_fa08d0c5b28045d5a4baf950d9385790": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Peering items on this page ,
Required: True ,
}
[
{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServices_ListByResourceGroup (updated)
Description :  Lists all of the peering services under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServices_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringService list operation.",
        "old": "The paginated list of peering services."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringService items on this page",
            "old": "The list of peering services."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_bd5a846015464d6786270c64b6fec970": {
                "#name": "location",
                "Description": "The location of the resource.",
                "Required": true,
                "Type": "string"
              },
              "@removed_f691a6305fca4ce0810ae5225de8047b": {
                "#name": "tags",
                "Description": "The resource tags.",
                "Required": false,
                "Type": "object"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering services."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_a2dced542d464bf0813e2c5ad38a3be5": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_87491416917e43cf91c69c6acc8918d4": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_ecf9f391ce974321b62f763df0564003": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringService items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The location (state/province) of the customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The name of the service provider. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
providerPrimaryPeeringLocation:
{
Description: The primary peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
providerBackupPeeringLocation:
{
Description: The backup peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
logAnalyticsWorkspaceProperties:
{
Description: The Log Analytics Workspace Properties ,
Required: False ,
}
{
workspaceID:
{
Description: The Workspace ID. ,
Required: False ,
}
string ,
key:
{
Description: The Workspace Key. ,
Required: False ,
}
string ,
connectedAgents:
{
Description: The list of connected agents. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServices_Get (updated)
Description :  Gets an existing peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServices_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_62a2548a3d4d430ca06550a72ec25ffd": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_7fc2e00be9234fb988cdbe3e8cfb3511": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_2f6759f816c745abbc5a7f0d5ba5f429": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_014c4e1d484646349917eccd55f1629a": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_d61b865532a04c3b9505b872d99f97d4": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The location (state/province) of the customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The name of the service provider. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
providerPrimaryPeeringLocation:
{
Description: The primary peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
providerBackupPeeringLocation:
{
Description: The backup peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
logAnalyticsWorkspaceProperties:
{
Description: The Log Analytics Workspace Properties ,
Required: False ,
}
{
workspaceID:
{
Description: The Workspace ID. ,
Required: False ,
}
string ,
key:
{
Description: The Workspace Key. ,
Required: False ,
}
string ,
connectedAgents:
{
Description: The list of connected agents. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServices_CreateOrUpdate (updated)
Description :  Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServices_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    },
    {
      "peeringService": {
        "$properties": {
          "@removed_e4caa7b2dec54d3098a40ab71eb2583f": {
            "#name": "location",
            "Description": "The location of the resource.",
            "Required": true,
            "Type": "string"
          },
          "@removed_2b99f650ece54e769793f74cd495013a": {
            "#name": "tags",
            "Description": "The resource tags.",
            "Required": false,
            "Type": "object"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_58183403092d4414b94db6855557481b": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_a7dcf27a2bbc45778fa43d92f54abab4": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_748dc07e03c04dedbba618a29e748046": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_c12ac4dd32574e7f9bbbbe10ba4de6d7": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_2131098c3a2448b89f822b941ef8b223": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_c88de257a1844d4fa0a03941c3653211": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_f599bc74ec044c5e848c0e334780b15e": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
peeringService:
{
Description: The properties needed to create or update a peering service. ,
Required: True ,
}
{
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The location (state/province) of the customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The name of the service provider. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
providerPrimaryPeeringLocation:
{
Description: The primary peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
providerBackupPeeringLocation:
{
Description: The backup peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
logAnalyticsWorkspaceProperties:
{
Description: The Log Analytics Workspace Properties ,
Required: False ,
}
{
workspaceID:
{
Description: The Workspace ID. ,
Required: False ,
}
string ,
key:
{
Description: The Workspace Key. ,
Required: False ,
}
string ,
connectedAgents:
{
Description: The list of connected agents. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The location (state/province) of the customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The name of the service provider. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
providerPrimaryPeeringLocation:
{
Description: The primary peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
providerBackupPeeringLocation:
{
Description: The backup peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
logAnalyticsWorkspaceProperties:
{
Description: The Log Analytics Workspace Properties ,
Required: False ,
}
{
workspaceID:
{
Description: The Workspace ID. ,
Required: False ,
}
string ,
key:
{
Description: The Workspace Key. ,
Required: False ,
}
string ,
connectedAgents:
{
Description: The list of connected agents. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The location (state/province) of the customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The name of the service provider. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
providerPrimaryPeeringLocation:
{
Description: The primary peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
providerBackupPeeringLocation:
{
Description: The backup peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
logAnalyticsWorkspaceProperties:
{
Description: The Log Analytics Workspace Properties ,
Required: False ,
}
{
workspaceID:
{
Description: The Workspace ID. ,
Required: False ,
}
string ,
key:
{
Description: The Workspace Key. ,
Required: False ,
}
string ,
connectedAgents:
{
Description: The list of connected agents. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServices_Update (updated)
Description :  Updates tags for a peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServices_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_0db70435042b45608ac89974de0e23e2": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_d884a6592d584c6d83e37a14291cabff": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_45106864b78e49269d7d90650efdb287": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_ded55d4f40044ecb95981d6bd4f67879": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_69de5fa1f0e847b9abdccc39facfbf79": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
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 ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a peering service. ,
Required: False ,
}
{
peeringServiceLocation:
{
Description: The location (state/province) of the customer. ,
Required: False ,
}
string ,
peeringServiceProvider:
{
Description: The name of the service provider. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
providerPrimaryPeeringLocation:
{
Description: The primary peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
providerBackupPeeringLocation:
{
Description: The backup peering (Microsoft/service provider) location to be used for customer traffic. ,
Required: False ,
}
string ,
logAnalyticsWorkspaceProperties:
{
Description: The Log Analytics Workspace Properties ,
Required: False ,
}
{
workspaceID:
{
Description: The Workspace ID. ,
Required: False ,
}
string ,
key:
{
Description: The Workspace Key. ,
Required: False ,
}
string ,
connectedAgents:
{
Description: The list of connected agents. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PeeringServices_Delete (updated)
Description :  Deletes an existing peering service with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PeeringServices_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_0650eb499e314eabaf0db1c05ec15832": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_7e096d81b4264c739509eab725af81f3": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_a7e7e4f007244373b92b3586b9db6b58": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectionMonitorTests_ListByPeeringService (updated)
Description :  Lists all connection monitor tests under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectionMonitorTests_ListByPeeringService",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a ConnectionMonitorTest list operation.",
        "old": "The paginated list of Connection Monitor Tests."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ConnectionMonitorTest items on this page",
            "old": "The list of Connection Monitor Tests."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of Connection Monitor Tests."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_100c343c50434939ba9d33fff2f0de9f": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_9a35d04209eb473181765060aa217094": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_4eb0b9baedd941da944997effb0c602e": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/connectionMonitorTests
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ConnectionMonitorTest items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties that define a Connection Monitor Test. ,
Required: False ,
}
{
sourceAgent:
{
Description: The Connection Monitor test source agent ,
Required: False ,
}
string ,
destination:
{
Description: The Connection Monitor test destination ,
Required: False ,
}
string ,
destinationPort:
{
Description: The Connection Monitor test destination port ,
Format: int32 ,
Required: False ,
}
integer ,
testFrequencyInSec:
{
Description: The Connection Monitor test frequency in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
isTestSuccessful:
{
Description: The flag that indicates if the Connection Monitor test is successful or not. ,
Required: False ,
}
boolean ,
path:
{
Description: The path representing the Connection Monitor test. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectionMonitorTests_Get (updated)
Description :  Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectionMonitorTests_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_cd875cbbe68a482fb5487374a50ad1d8": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_d1942b18eca1437f8a5bc3a8b9d993f8": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_b8dc6a7b259848c2bd5a49c9fdff24fe": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/connectionMonitorTests/{connectionMonitorTestName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
connectionMonitorTestName:
{
Description: The name of the connection monitor test ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a Connection Monitor Test. ,
Required: False ,
}
{
sourceAgent:
{
Description: The Connection Monitor test source agent ,
Required: False ,
}
string ,
destination:
{
Description: The Connection Monitor test destination ,
Required: False ,
}
string ,
destinationPort:
{
Description: The Connection Monitor test destination port ,
Format: int32 ,
Required: False ,
}
integer ,
testFrequencyInSec:
{
Description: The Connection Monitor test frequency in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
isTestSuccessful:
{
Description: The flag that indicates if the Connection Monitor test is successful or not. ,
Required: False ,
}
boolean ,
path:
{
Description: The path representing the Connection Monitor test. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectionMonitorTests_CreateOrUpdate (updated)
Description :  Creates or updates a connection monitor test with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectionMonitorTests_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_55222a90bf324254993a6f9560885a81": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_b158e07f7fb84a2185862147f3d833e6": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_0bc3493460104be1a36fbd28c335daae": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/connectionMonitorTests/{connectionMonitorTestName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
connectionMonitorTestName:
{
Description: The name of the connection monitor test ,
Required: True ,
}
string ,
connectionMonitorTest:
{
Description: The properties needed to create a connection monitor test ,
Required: True ,
}
{
properties:
{
Description: The properties that define a Connection Monitor Test. ,
Required: False ,
}
{
sourceAgent:
{
Description: The Connection Monitor test source agent ,
Required: False ,
}
string ,
destination:
{
Description: The Connection Monitor test destination ,
Required: False ,
}
string ,
destinationPort:
{
Description: The Connection Monitor test destination port ,
Format: int32 ,
Required: False ,
}
integer ,
testFrequencyInSec:
{
Description: The Connection Monitor test frequency in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
isTestSuccessful:
{
Description: The flag that indicates if the Connection Monitor test is successful or not. ,
Required: False ,
}
boolean ,
path:
{
Description: The path representing the Connection Monitor test. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties that define a Connection Monitor Test. ,
Required: False ,
}
{
sourceAgent:
{
Description: The Connection Monitor test source agent ,
Required: False ,
}
string ,
destination:
{
Description: The Connection Monitor test destination ,
Required: False ,
}
string ,
destinationPort:
{
Description: The Connection Monitor test destination port ,
Format: int32 ,
Required: False ,
}
integer ,
testFrequencyInSec:
{
Description: The Connection Monitor test frequency in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
isTestSuccessful:
{
Description: The flag that indicates if the Connection Monitor test is successful or not. ,
Required: False ,
}
boolean ,
path:
{
Description: The path representing the Connection Monitor test. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties that define a Connection Monitor Test. ,
Required: False ,
}
{
sourceAgent:
{
Description: The Connection Monitor test source agent ,
Required: False ,
}
string ,
destination:
{
Description: The Connection Monitor test destination ,
Required: False ,
}
string ,
destinationPort:
{
Description: The Connection Monitor test destination port ,
Format: int32 ,
Required: False ,
}
integer ,
testFrequencyInSec:
{
Description: The Connection Monitor test frequency in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
isTestSuccessful:
{
Description: The flag that indicates if the Connection Monitor test is successful or not. ,
Required: False ,
}
boolean ,
path:
{
Description: The path representing the Connection Monitor test. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectionMonitorTests_Delete (updated)
Description :  Deletes an existing connection monitor test with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectionMonitorTests_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_ffc9e71f74664af3a6d1ef090009a50b": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_df54a3e242024e85a373fecc2ed9343a": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_d67a5190f63e4fe78d529afdf509af46": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/connectionMonitorTests/{connectionMonitorTestName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
connectionMonitorTestName:
{
Description: The name of the connection monitor test ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Prefixes_ListByPeeringService (updated)
Description :  Lists all prefixes under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Prefixes_ListByPeeringService",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringServicePrefix list operation.",
        "old": "The paginated list of peering service prefixes."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringServicePrefix items on this page",
            "old": "The list of peering service prefixes."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering service prefixes."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_b92f91fb2d204d24b5c8f5e143f9c339": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_30f0952f98964af3ba1b8c5b8ebdfe86": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_8bf66c258a9b4da58c75e74feae3a32c": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
$expand:
{
Description: The properties to be expanded. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringServicePrefix items on this page ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Prefixes_Get (updated)
Description :  Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Prefixes_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_3c420dbd6fb04efdafaeef5b20cb085d": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_1780e97a7b0349e6905f5a88a6177e09": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_c63b8bbf42c241d2b9a838edd9468024": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
$expand:
{
Description: The properties to be expanded. ,
Required: False ,
}
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Prefixes_CreateOrUpdate (updated)
Description :  Creates a new prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Prefixes_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_f7ac166825954a3a93bcfc2d7609e3f3": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_fabefab5819c4b96bf3f3647204880f3": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_64dd9768cacf44e9a9b71df38ba11fbe": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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. ,
Canceled: 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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Prefixes_Delete (updated)
Description :  Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Prefixes_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "peeringServiceName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The name of the peering service."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_076aa1b2caaa49eeb8a3904f0e7a981c": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_17a1f63df86449f3b4a39273db214a54": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_49a6ca4c2a9c4b7a85f59042170b4790": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringServiceName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
prefixName:
{
Description: The name of the prefix. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Peerings_ListByResourceGroup (updated)
Description :  Lists all of the peerings under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Peerings_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Peering list operation.",
        "old": "The paginated list of peerings."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Peering items on this page",
            "old": "The list of peerings."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "connectivityProbes": {
                    "Description": {
                      "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                      "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
                    },
                    "$properties": [
                      {
                        "#name": "prefixesToAccesslist",
                        "Description": {
                          "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                          "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                        }
                      }
                    ]
                  }
                }
              ],
              "@removed_98fa0baafa0345e98ea29ffc27b414fb": {
                "#name": "location",
                "Description": "The location of the resource.",
                "Required": true,
                "Type": "string"
              },
              "@removed_173d0c2be25541d2ac70d35a6b5ef533": {
                "#name": "tags",
                "Description": "The resource tags.",
                "Required": false,
                "Type": "object"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peerings."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_1a5e78354f4344bca8182c524e580423": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_a5362b0f4fcd4e5e9447fd07448af879": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_cc6c52fcdd4846d6ab6f9fe571c9f0e1": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Peering items on this page ,
Required: True ,
}
[
{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Peerings_Get (updated)
Description :  Gets an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Peerings_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "connectivityProbes": {
              "Description": {
                "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
              },
              "$properties": [
                {
                  "#name": "prefixesToAccesslist",
                  "Description": {
                    "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                    "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                  }
                }
              ]
            }
          }
        ],
        "@removed_7614298802fb47c9b7c103d4d722b416": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_4ddaef7fdad44761a79b679d32035d0e": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_3a87ec2813ab4c3587b0668ea0b348fb": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_51d3f6bf01dc4a18a17f785a423234bd": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_091bd0c8d7344b73a1643948d90eca55": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Peerings_CreateOrUpdate (updated)
Description :  Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Peerings_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "peering": {
        "$properties": {
          "properties": [
            {
              "connectivityProbes": {
                "Description": {
                  "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                  "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
                },
                "$properties": [
                  {
                    "#name": "prefixesToAccesslist",
                    "Description": {
                      "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                      "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                    }
                  }
                ]
              }
            }
          ],
          "@removed_d8453a0d4f584262978339218318abeb": {
            "#name": "location",
            "Description": "The location of the resource.",
            "Required": true,
            "Type": "string"
          },
          "@removed_b908da77cd104b6685b1f96e97fd31dc": {
            "#name": "tags",
            "Description": "The resource tags.",
            "Required": false,
            "Type": "object"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "connectivityProbes": {
              "Description": {
                "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
              },
              "$properties": [
                {
                  "#name": "prefixesToAccesslist",
                  "Description": {
                    "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                    "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                  }
                }
              ]
            }
          }
        ],
        "@removed_6a1c207eb87149f790d149f54f778482": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_c0dac8e089464208a9575fe91e251aee": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "connectivityProbes": {
              "Description": {
                "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
              },
              "$properties": [
                {
                  "#name": "prefixesToAccesslist",
                  "Description": {
                    "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                    "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                  }
                }
              ]
            }
          }
        ],
        "@removed_9e72ca4951984365b648a74d64045bc9": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_89d7b96eadbe486fbb8156b40bb63713": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_77adbb3ef1ce4e4790e84ee649c57506": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_092177fbdc3643c89f83b3c3a6db9465": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_2c82965c9da142b0ab2927abfc89f9c6": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}
,
}

⚐ Response (200)

{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}

⚐ Response (201)

{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Peerings_Update (updated)
Description :  Updates tags for a peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Peerings_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "connectivityProbes": {
              "Description": {
                "new": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\nConnectivity probe blade of their peering.",
                "old": "Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping\r\ntests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint\r\nIP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the\r\nConnectivity probe blade of their peering."
              },
              "$properties": [
                {
                  "#name": "prefixesToAccesslist",
                  "Description": {
                    "new": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe.",
                    "old": "Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their\r\nnetwork the connectivity probe traffic can reach their endpoint for the connectivity probe."
                  }
                }
              ]
            }
          }
        ],
        "@removed_2bc690bb09b54f45a702a0535884e96f": {
          "#name": "location",
          "Description": "The location of the resource.",
          "Required": true,
          "Type": "string"
        },
        "@removed_3f373df7a3e54ecfb26ee881aca2dc3e": {
          "#name": "tags",
          "Description": "The resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_362e81f4d6fd45439cfbbf25ff4c7b13": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_715cdb00def34d8ba4c152873597d3a4": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_8ea98d66fbe541cfb2861474c6a511d1": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
,
}

⚐ Response (200)

{
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 ,
microsoftTrackingId:
{
Description: The ID used within Microsoft's peering provisioning system to track the connection ,
Required: False ,
}
string ,
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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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. ,
Voice: No description available. ,
EdgeZoneForOperators: No description available. ,
PeerProp: 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. ,
TypeChangeRequested: No description available. ,
TypeChangeInProgress: No description available. ,
ExternalBlocker: 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 ,
}
,
}
,
connectivityProbes:
{
Description: The connectivity probes associated with the peering. ,
Required: False ,
}
[
{
endpoint:
{
Description: The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region where traffic will originate from for the connectivity probe. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the traffic that will be sent for the connectivity probe. ,
Enum:
{
None: No description available. ,
ICMP: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
prefixesToAccesslist:
{
Description: Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Peerings_Delete (updated)
Description :  Deletes an existing peering with the specified name under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Peerings_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_4647de20b01c4505bd7071d06d688c86": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_ad0bc67f32f14edeb206b7d838c6200f": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_d9ce3028b20242fb9542a4ee5f5610a6": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReceivedRoutes_ListByPeering (updated)
Description :  Lists the prefixes received over the specified peering under the given subscription and resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ReceivedRoutes_ListByPeering",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringReceivedRoute items on this page",
            "old": "The list of received routes for the peering."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of received routes for the peering."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_ca7a3a9401554abe83021e52c409ffe8": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_9548c29885bd478c8945c183c1209e50": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_60002ecb64614f6ab5760877a45bc022": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/receivedRoutes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
prefix:
{
Description: The optional prefix that can be used to filter the routes. ,
Required: False ,
}
string ,
asPath:
{
Description: The optional AS path that can be used to filter the routes. ,
Required: False ,
}
string ,
originAsValidationState:
{
Description: The optional origin AS validation state that can be used to filter the routes. ,
Required: False ,
}
string ,
rpkiValidationState:
{
Description: The optional RPKI validation state that can be used to filter the routes. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The optional page continuation token that is used in the event of paginated result. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringReceivedRoute items on this page ,
Required: True ,
}
[
{
prefix:
{
Description: The prefix. ,
Required: False ,
}
string ,
nextHop:
{
Description: The next hop for the prefix. ,
Required: False ,
}
string ,
asPath:
{
Description: The AS path for the prefix. ,
Required: False ,
}
string ,
originAsValidationState:
{
Description: The origin AS change information for the prefix. ,
Required: False ,
}
string ,
rpkiValidationState:
{
Description: The RPKI validation state for the prefix and origin AS that's listed in the AS path. ,
Required: False ,
}
string ,
trustAnchor:
{
Description: The authority which holds the Route Origin Authorization record for the prefix, if any. ,
Required: False ,
}
string ,
receivedTimestamp:
{
Description: The received timestamp associated with the prefix. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredAsns_ListByPeering (updated)
Description :  Lists all registered ASNs under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredAsns_ListByPeering",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringRegisteredAsn list operation.",
        "old": "The paginated list of peering registered ASNs."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringRegisteredAsn items on this page",
            "old": "The list of peering registered ASNs."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering registered ASNs."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_71b077c2e9724f7a805ed49df3d02aff": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_1a9dcf1cc3324ee2917ab0da033c2f22": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_537197fb058c426c9f7551fb13b1c87c": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringRegisteredAsn items on this page ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredAsns_Get (updated)
Description :  Gets an existing registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredAsns_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_7936311e48604de9bc86dfc089fb666e": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_4bc7494c00bc4228af41899f00ac41fb": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_23d3ff3f3f4e4eac9c529f27232aa070": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the registered ASN. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredAsns_CreateOrUpdate (updated)
Description :  Creates a new registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredAsns_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    },
    {
      "#name": "registeredAsnName",
      "Description": {
        "new": "The name of the registered ASN.",
        "old": "The name of the ASN."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_3b73bb55e7ab4157aa24b482011ca552": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_165b32702b5f4183839064c68b80fe8a": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_a41def6aaa154b4d8eb9c8cd23f4a064": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the registered 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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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. ,
Canceled: 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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredAsns_Delete (updated)
Description :  Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredAsns_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_eb42a7cba1fd4364ae402145ce0a6cbd": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_67f8874331444b1d92b26c220697e080": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_11234b6ebf084971bb22c92735e9bdaf": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredAsnName:
{
Description: The name of the registered ASN. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredPrefixes_ListByPeering (updated)
Description :  Lists all registered prefixes under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredPrefixes_ListByPeering",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PeeringRegisteredPrefix list operation.",
        "old": "The paginated list of peering registered prefixes."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PeeringRegisteredPrefix items on this page",
            "old": "The list of peering registered prefixes."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of peering registered prefixes."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_88283f919df647b290c7286af6702d41": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_7b47b1a767724d8693d5d01ba1250cc0": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_8e9e828e83c94a5c9fdad804ed479653": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PeeringRegisteredPrefix items on this page ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredPrefixes_Get (updated)
Description :  Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredPrefixes_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_606eb8f365f142af9fe98355ad3350cf": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_06d6326c94874a3f9d0c21f1a9160d19": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_541e0f1e46a04bf683de801c43b77141": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredPrefixes_CreateOrUpdate (updated)
Description :  Creates a new registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredPrefixes_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_2ffbffcf00fc4acd9dff7e62d6468b6e": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_60c5e096b83744a5b33ed9d365e167a5": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_735ac8ce07e346f2999fd52f6857017e": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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. ,
Canceled: 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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredPrefixes_Delete (updated)
Description :  Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredPrefixes_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_0dd3c2be7b104518a5e324ff21f8d025": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_53a0b402c68f47c6bd47befc1575c813": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_c0bbbd8f72db491db05e69cd3551eb0f": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredPrefixes_Validate (updated)
Description :  Validates an existing registered prefix with the specified name under the given subscription, resource group and peering.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredPrefixes_Validate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_448b1e1faeed423ba5e3e3ef22685875": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_287f8e3dcba3429e84b552867f5ae6a6": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_d17e91ced84d4af0a1f2fa1b538d1d20": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}/validate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
registeredPrefixName:
{
Description: The name of the registered prefix. ,
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. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RpUnbilledPrefixes_List (updated)
Description :  Lists all of the RP unbilled prefixes for the specified peering
Reference :  Link ¶

⚶ Changes

{
  "#id": "RpUnbilledPrefixes_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The Azure resource group name."
      }
    },
    {
      "#name": "peeringName",
      "Description": {
        "new": "The name of the peering.",
        "old": "The peering name."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RpUnbilledPrefix items on this page",
            "old": "The list of RP unbilled prefixes."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link to fetch the next page of RP unbilled prefixes."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error response that indicates why an operation has failed."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The error detail that describes why an operation has failed."
          },
          "$properties": {
            "@added_0e2e12d0b9654459ba61a1961a82054a": {
              "#name": "target",
              "Description": "The error target.",
              "Required": false,
              "Type": "string"
            },
            "@added_998265d9d40d49d7b1db4ef3024ab39b": {
              "#name": "details",
              "Description": "The error details.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_d4dbc2a811004cd7ad235a4d89f68f4e": {
              "#name": "additionalInfo",
              "Description": "The error additional info.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "The resource management error additional info.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The additional info type.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional info.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/rpUnbilledPrefixes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the peering. ,
Required: True ,
}
string ,
consolidate:
{
Description: Flag to enable consolidation prefixes ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
value:
{
Description: The RpUnbilledPrefix items on this page ,
Required: True ,
}
[
{
prefix:
{
Description: The prefix. ,
Required: False ,
}
string ,
azureRegion:
{
Description: The Azure region. ,
Required: False ,
}
string ,
peerAsn:
{
Description: The peer ASN. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}