你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Peerings - List By Resource Group

列出给定订阅和资源组下的所有对等互连。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings?api-version=2021-01-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

Azure 订阅 ID。

api-version
query True
  • string

客户端 API 版本。

响应

Name Type Description
200 OK

OK

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

List peerings in a resource group

Sample Request

GET https://management.azure.com/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings?api-version=2021-01-01

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "Basic_Exchange_Free",
        "tier": "Basic",
        "family": "Exchange",
        "size": "Free"
      },
      "kind": "Exchange",
      "properties": {
        "exchange": {
          "connections": [
            {
              "peeringDBFacilityId": 99999,
              "connectionState": "Active",
              "bgpSession": {
                "microsoftSessionIPv4Address": "192.168.3.1",
                "microsoftSessionIPv6Address": "fd00::1:1",
                "peerSessionIPv4Address": "192.168.2.1",
                "peerSessionIPv6Address": "fd00::1",
                "sessionStateV4": "Established",
                "sessionStateV6": "Established",
                "maxPrefixesAdvertisedV4": 1000,
                "maxPrefixesAdvertisedV6": 100,
                "md5AuthenticationKey": "test-md5-auth-key"
              },
              "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D"
            },
            {
              "peeringDBFacilityId": 99999,
              "connectionState": "Active",
              "bgpSession": {
                "microsoftSessionIPv4Address": "192.168.3.2",
                "microsoftSessionIPv6Address": "fd00::1:2",
                "peerSessionIPv4Address": "192.168.2.2",
                "peerSessionIPv6Address": "fd00::2",
                "sessionStateV4": "Established",
                "sessionStateV6": "Established",
                "maxPrefixesAdvertisedV4": 1000,
                "maxPrefixesAdvertisedV6": 100,
                "md5AuthenticationKey": "test-md5-auth-key"
              },
              "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B"
            }
          ],
          "peerAsn": {
            "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1"
          }
        },
        "peeringLocation": "peeringLocation0",
        "provisioningState": "Succeeded"
      },
      "location": "eastus",
      "name": "peeringName",
      "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName",
      "type": "Microsoft.Peering/peerings"
    }
  ]
}

定义

BgpSession

定义 BGP 会话的属性。

connectionState

连接的状态。

DirectConnection

定义直接连接的属性。

directPeeringType

直接对等互连的类型。

ErrorDetail

描述操作失败的原因的错误详细信息。

ErrorResponse

指示操作失败的原因的错误响应。

ExchangeConnection

定义交换连接的属性。

family

对等互连 SKU 的系列。

kind

对等互连的类型。

Peering

对等互连是一组连接到 Microsoft Cloud Edge 的位置的逻辑表示形式。

PeeringListResult

对等互连的分页列表。

PeeringPropertiesDirect

定义直接对等互连的属性。

PeeringPropertiesExchange

定义交换对等互连的属性。

PeeringSku

定义层和对等互连类型的 SKU。

provisioningState

资源的预配状态。

sessionAddressProvider

指示 Microsoft 是否提供会话 IP 地址的字段。

sessionStateV4

IPv4 会话的状态。

sessionStateV6

IPv6 会话的状态。

size

对等互连 SKU 的大小。

SubResource

子资源。

tier

对等互连 SKU 的层。

BgpSession

定义 BGP 会话的属性。

Name Type Description
maxPrefixesAdvertisedV4
  • integer

通过 IPv4 会话播发的最大前缀数。

maxPrefixesAdvertisedV6
  • integer

通过 IPv6 会话播发的最大前缀数。

md5AuthenticationKey
  • string

会话的 MD5 身份验证密钥。

microsoftSessionIPv4Address
  • string

Microsoft 端的 IPv4 会话地址。

microsoftSessionIPv6Address
  • string

Microsoft 端的 IPv6 会话地址。

peerSessionIPv4Address
  • string

对等端的 IPv4 会话地址。

peerSessionIPv6Address
  • string

对等端的 IPv6 会话地址。

sessionPrefixV4
  • string

包含两端 IPv4 地址的 IPv4 前缀。

sessionPrefixV6
  • string

包含两端 IPv6 地址的 IPv6 前缀。

sessionStateV4

IPv4 会话的状态。

sessionStateV6

IPv6 会话的状态。

connectionState

连接的状态。

Name Type Description
Active
  • string
Approved
  • string
None
  • string
PendingApproval
  • string
ProvisioningCompleted
  • string
ProvisioningFailed
  • string
ProvisioningStarted
  • string
Validating
  • string

DirectConnection

定义直接连接的属性。

Name Type Description
bandwidthInMbps
  • integer

连接的带宽。

bgpSession

与连接关联的 BGP 会话。

connectionIdentifier
  • string

连接的唯一标识符 (GUID) 。

connectionState

连接的状态。

errorMessage
  • string

与连接状态相关的错误消息(如果有)。

microsoftTrackingId
  • string

Microsoft 对等互连预配系统中用于跟踪连接的 ID

peeringDBFacilityId
  • integer

必须设置连接的设施的 PeeringDB.com ID。

provisionedBandwidthInMbps
  • integer

实际预配的带宽。

sessionAddressProvider

指示 Microsoft 是否提供会话 IP 地址的字段。

useForPeeringService
  • boolean

指示连接是否用于对等互连服务的标志。

directPeeringType

直接对等互连的类型。

Name Type Description
Cdn
  • string
Edge
  • string
Internal
  • string
Ix
  • string
IxRs
  • string
Transit
  • string
Voice
  • string

ErrorDetail

描述操作失败的原因的错误详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息。

ErrorResponse

指示操作失败的原因的错误响应。

Name Type Description
error

描述操作失败的原因的错误详细信息。

ExchangeConnection

定义交换连接的属性。

Name Type Description
bgpSession

与连接关联的 BGP 会话。

connectionIdentifier
  • string

连接的唯一标识符 (GUID) 。

connectionState

连接的状态。

errorMessage
  • string

与连接状态相关的错误消息(如果有)。

peeringDBFacilityId
  • integer

必须设置连接的设施的 PeeringDB.com ID。

family

对等互连 SKU 的系列。

Name Type Description
Direct
  • string
Exchange
  • string

kind

对等互连的类型。

Name Type Description
Direct
  • string
Exchange
  • string

Peering

对等互连是一组连接到 Microsoft Cloud Edge 的位置的逻辑表示形式。

Name Type Description
id
  • string

资源的 ID。

kind

对等互连的类型。

location
  • string

资源的位置。

name
  • string

资源的名称。

properties.direct

定义直接对等互连的属性。

properties.exchange

定义交换对等互连的属性。

properties.peeringLocation
  • string

对等互连的位置。

properties.provisioningState

资源的预配状态。

sku

定义层和对等互连类型的 SKU。

tags
  • object

资源标记。

type
  • string

资源类型。

PeeringListResult

对等互连的分页列表。

Name Type Description
nextLink
  • string

用于提取下一页对等互连的链接。

value

对等互连的列表。

PeeringPropertiesDirect

定义直接对等互连的属性。

Name Type Description
connections

构成直接对等互连的连接集。

directPeeringType

直接对等互连的类型。

peerAsn

对等 ASN 的引用。

useForPeeringService
  • boolean

指示对等互连是否用于对等互连服务的标志。

PeeringPropertiesExchange

定义交换对等互连的属性。

Name Type Description
connections

构成交换对等互连的连接集。

peerAsn

对等 ASN 的引用。

PeeringSku

定义层和对等互连类型的 SKU。

Name Type Description
family

对等互连 SKU 的系列。

name
  • string

对等互连 SKU 的名称。

size

对等互连 SKU 的大小。

tier

对等互连 SKU 的层。

provisioningState

资源的预配状态。

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

sessionAddressProvider

指示 Microsoft 是否提供会话 IP 地址的字段。

Name Type Description
Microsoft
  • string
Peer
  • string

sessionStateV4

IPv4 会话的状态。

Name Type Description
Active
  • string
Connect
  • string
Established
  • string
Idle
  • string
None
  • string
OpenConfirm
  • string
OpenReceived
  • string
OpenSent
  • string
PendingAdd
  • string
PendingRemove
  • string
PendingUpdate
  • string

sessionStateV6

IPv6 会话的状态。

Name Type Description
Active
  • string
Connect
  • string
Established
  • string
Idle
  • string
None
  • string
OpenConfirm
  • string
OpenReceived
  • string
OpenSent
  • string
PendingAdd
  • string
PendingRemove
  • string
PendingUpdate
  • string

size

对等互连 SKU 的大小。

Name Type Description
Free
  • string
Metered
  • string
Unlimited
  • string

SubResource

子资源。

Name Type Description
id
  • string

所引用资源的标识符。

tier

对等互连 SKU 的层。

Name Type Description
Basic
  • string
Premium
  • string