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

Peerings - List By Resource Group

参考

Service:: Peering

API Version:: 2021-01-01

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

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	PeeringListResult	确定
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

List peerings in a resource group

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

/** Samples for Peerings ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/examples/ListPeeringsByResourceGroup.json
     */
    /**
     * Sample code: List peerings in a resource group.
     *
     * @param manager Entry point to PeeringManager.
     */
    public static void listPeeringsInAResourceGroup(com.azure.resourcemanager.peering.PeeringManager manager) {
        manager.peerings().listByResourceGroup("rgName", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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 会话的属性。

名称	类型	说明
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	sessionStateV4	IPv4 会话的状态。
sessionStateV6	sessionStateV6	IPv6 会话的状态。

connectionState

连接的状态。

名称	类型	说明
Active	string
Approved	string
None	string
PendingApproval	string
ProvisioningCompleted	string
ProvisioningFailed	string
ProvisioningStarted	string
Validating	string

DirectConnection

定义直接连接的属性。

名称	类型	说明
bandwidthInMbps	integer	连接的带宽。
bgpSession	BgpSession	与连接关联的 BGP 会话。
connectionIdentifier	string	连接的唯一标识符 (GUID) 。
connectionState	connectionState	连接的状态。
errorMessage	string	与连接状态相关的错误消息（如果有）。
microsoftTrackingId	string	Microsoft 的对等互连预配系统中用于跟踪连接的 ID
peeringDBFacilityId	integer	必须设置连接的设施的 PeeringDB.com ID。
provisionedBandwidthInMbps	integer	实际预配的带宽。
sessionAddressProvider	sessionAddressProvider	指示 Microsoft 是否提供会话 IP 地址的字段。
useForPeeringService	boolean	指示连接是否用于对等互连服务的标志。

directPeeringType

直接对等互连的类型。

名称	类型	说明
Cdn	string
Edge	string
Internal	string
Ix	string
IxRs	string
Transit	string
Voice	string

ErrorDetail

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

名称	类型	说明
code	string	错误代码。
message	string	错误消息。

ErrorResponse

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

名称	类型	说明
error	ErrorDetail	描述操作失败原因的错误详细信息。

ExchangeConnection

定义交换连接的属性。

名称	类型	说明
bgpSession	BgpSession	与连接关联的 BGP 会话。
connectionIdentifier	string	连接的唯一标识符 (GUID) 。
connectionState	connectionState	连接的状态。
errorMessage	string	与连接状态相关的错误消息（如果有）。
peeringDBFacilityId	integer	必须设置连接的设施的 PeeringDB.com ID。

family

对等互连 SKU 的系列。

名称	类型	说明
Direct	string
Exchange	string

kind

对等互连的类型。

名称	类型	说明
Direct	string
Exchange	string

Peering

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

名称	类型	说明
id	string	资源的 ID。
kind	kind	对等互连的类型。
location	string	资源的位置。
name	string	资源的名称。
properties.direct	PeeringPropertiesDirect	定义直接对等互连的属性。
properties.exchange	PeeringPropertiesExchange	定义交换对等互连的属性。
properties.peeringLocation	string	对等互连的位置。
properties.provisioningState	provisioningState	资源的预配状态。
sku	PeeringSku	定义对等互连的层和类型的 SKU。
tags	object	资源标记。
type	string	资源类型。

PeeringListResult

对等互连的分页列表。

名称	类型	说明
nextLink	string	用于提取下一页对等互连的链接。
value	Peering[]	对等互连的列表。

PeeringPropertiesDirect

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

名称	类型	说明
connections	DirectConnection[]	构成直接对等互连的连接集。
directPeeringType	directPeeringType	直接对等互连的类型。
peerAsn	SubResource	对等 ASN 的引用。
useForPeeringService	boolean	指示是否将对等互连用于对等互连服务的标志。

PeeringPropertiesExchange

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

名称	类型	说明
connections	ExchangeConnection[]	构成交换对等互连的连接集。
peerAsn	SubResource	对等 ASN 的引用。

PeeringSku

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

名称	类型	说明
family	family	对等互连 SKU 的系列。
name	string	对等互连 SKU 的名称。
size	size	对等互连 SKU 的大小。
tier	tier	对等互连 SKU 的层。

provisioningState

资源的预配状态。

名称	类型	说明
Deleting	string
Failed	string
Succeeded	string
Updating	string

sessionAddressProvider

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

名称	类型	说明
Microsoft	string
Peer	string

sessionStateV4

IPv4 会话的状态。

名称	类型	说明
Active	string
Connect	string
Established	string
Idle	string
None	string
OpenConfirm	string
OpenReceived	string
OpenSent	string
PendingAdd	string
PendingRemove	string
PendingUpdate	string

sessionStateV6

IPv6 会话的状态。

名称	类型	说明
Active	string
Connect	string
Established	string
Idle	string
None	string
OpenConfirm	string
OpenReceived	string
OpenSent	string
PendingAdd	string
PendingRemove	string
PendingUpdate	string

size

对等互连 SKU 的大小。

名称	类型	说明
Free	string
Metered	string
Unlimited	string

SubResource

子资源。

名称	类型	说明
id	string	引用资源的标识符。

tier

对等互连 SKU 的层。

名称	类型	说明
Basic	string
Premium	string