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

ExpressRoute 线路部署 API

ExpressRoute 合作伙伴线路放置 API 允许 ExpressRoute 合作伙伴在特定端口对上预配线路连接。 具体而言,如果 ExpressRoute 合作伙伴在一个对等互连位置管理多个端口对,则他们可以使用此 API 来选择可帮助连接 ExpressRoute 线路的端口对。

该 API 使用 expressRouteCrossConnections 资源类型。 有关详细信息,请参阅 ExpressRoute CrossConnection API 开发和集成。

将提供程序订阅注册到 expressRouteProviderPort 资源类型

若要使用线路放置 API,首先需要注册订阅,以便访问端口资源类型。

  1. 登录到 Azure 并选择想要注册的订阅。

    Connect-AzAccount 
    
    Select-AzSubscription -Subscription "<SubscriptionID or SubscriptionName>"
    
  2. 请注册订阅。

    Register-AzProviderFeature -FeatureName AllowExpressRoutePorts -ProviderNamespace Microsoft.Network
    

注册后,验证 Microsoft.Network 资源提供程序是否已在你的订阅中注册。 注册资源提供程序会将你的订阅配置为可与该资源提供程序配合使用。

Workflow

  1. ExpressRoute 客户共享目标 ExpressRoute 线路的服务密钥。

  2. ExpressRoute 合作伙伴使用 expressRouteProviderPorts API 发出 GET 请求,以识别目标端口对的 PortPairDescription。 ExpressRoute 合作伙伴可查询订阅中所有端口对的 PortPairDescriptions 列表,或将查询范围限定为特定对等互连位置。

  3. 一旦识别出目标 PortPairDescription,ExpressRoute 合作伙伴就会对 expressRouteCrossConnection 执行 GET/PUT 操作,以将 ExpressRoute 线路迁移到目标端口对。

ExpressRoute 合作伙伴通过针对 expressRouteCrossConnections 资源发出 REST 操作来管理第 2 层和第 3 层配置。

API 开发和集成步骤

使用 expressRouteProviderPorts API 列出端口对的 GET 操作

ExpressRoute 合作伙伴可以列出目标提供商订阅中的所有端口对,也可以列出特定对等互连位置内的端口对

获取提供程序的所有端口对的列表

https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts?api-version={api-version}
{
    "parameters": {
      "api-version": "2025-05-01",
      "subscriptionId": "subid"
    },
    "responses": {
        "200": {
          "body": {
            "value": [
              {
                "portPairDescriptor": "bvtazureixpportpair1",
                "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRouteProviderPort/bvtazureixpportpair1",
                "type": "Microsoft.Network/expressRouteProviderPort",
                "location": "uswest",
                "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
                "properties": {
                    "portPairDescriptor": "bvtazureixpportpair",
                    "primaryAzurePort": "bvtazureixp01a",
                    "secondaryAzurePort": "bvtazureixp01b",
                    "peeringLocation": "SiliconValley",
                    "overprovisionFactor": 4,
                    "portBandwidthInMbps": 4000,
                    "usedBandwidthInMbps": 2500,
                    "remainingBandwidthInMbps": 1500
                }
              },
              {
                "portPairDescriptor": "bvtazureixpportpair2",
                "id": "/subscriptions/subid/providers/Microsoft.Network/expressRouteProviderPorts/bvtazureixpportpair2",
                "type": "Microsoft.Network/expressRouteProviderPort",
                "location": "uswest",
                "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
                "properties": {
                    "portPairDescriptor": "bvtazureixpportpair2",
                    "primaryAzurePort": "bvtazureixp02a",
                    "secondaryAzurePort": "bvtazureixp02b",
                    "peeringLocation": "seattle",
                    "overprovisionFactor": 4,
                    "portBandwidthInMbps": 4000,
                    "usedBandwidthInMbps": 1200,
                    "remainingBandwidthInMbps": 1800
                }
              }
            ]
          }
        }
      }
    }
  }
}

响应状态代码

  • 200(OK)请求成功。 它会获取端口列表。
  • 4XX(糟糕的请求)其中一次验证失败了。 例如:提供者订阅ID无效。

获取按位置划分的所有端口对列表

https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts?location={locationName}&api-version={api-version}
{
  "parameters": {
    "api-version": "2025-05-01",
    "locationName": "SiliconValley",
    "subscriptionId": "subid"
  },
  "responses": {
    "200": {
      "body": {
        "value": [
          {
            "portPairDescriptor": "bvtazureixpportpair1",
            "id": "/subscriptions/subid/providers/Microsoft.Network/expressRouteProviderPorts/bvtazureixpportpair1",
            "type": "Microsoft.Network/expressRouteProviderPort",
            "location": "uswest",
            "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
            "properties": {
              "portPairDescriptor": "bvtazureixpportpair",
              "primaryAzurePort": "bvtazureixp01a",
              "secondaryAzurePort": "bvtazureixp01b",
              "peeringLocation": "SiliconValley",
              "overprovisionFactor": 4,
              "portBandwidthInMbps": 4000,
              "usedBandwidthInMbps": 2500,
              "remainingBandwidthInMbps": 1500
            }
          }
        ]
      }
    }
  }
}

响应状态代码

  • 200(OK)请求成功。 它会获取端口列表。
  • 4XX(糟糕的请求)其中一次验证失败了。 例如:提供者订阅ID无效,或者所在位置无效。

使用端口对描述符 ID 获取特定端口对。

https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts/{portPairDescriptor}?api-version={api-version}

{
  "parameters": {
    "api-version": "2025-05-01",
    "portPairDescriptor": "bvtazureixpportpair1",
    "subscriptionId": "subid"
  },
  "responses": {
    "200": {
      "body": {
        "value": [
          {
            "portPairDescriptor": "bvtazureixpportpair1",
            "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRouteProviderPort/bvtazureixpportpair1",
            "type": "Microsoft.Network/expressRouteProviderPort",
            "location": "uswest",
            "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
            "properties": {
              "portPairDescriptor": "bvtazureixpportpair",
              "primaryAzurePort": "bvtazureixp01a",
              "secondaryAzurePort": "bvtazureixp01b",
              "peeringLocation": "SiliconValley",
              "overprovisionFactor": 4,
              "portBandwidthInMbps": 4000,
              "usedBandwidthInMbps": 2500,
              "remainingBandwidthInMbps": 15
            }
          }
        ]
      }
    }
  }
}

状态代码说明

  • 200(OK)请求成功。 它获取端口详情。
  • 204 具有上述描述符 ID 的端口对不可用。
  • 4XX(糟糕的请求)其中一次验证失败了。 例如:提供者订阅ID无效。

将目标 ExpressRoute 线路移动到特定端口对

标识了目标端口对的 portPairDescriptor 后,ExpressRoute 合作伙伴就可以使用 ExpressRouteCrossConnection API 将 ExpressRoute 线路移动到特定的端口对。

目前,提供商使用此 API 来更新线路的预配状态。 提供商将使用相同的 API 来更新线路的端口对。

目前,primaryAzurePort 和 secondaryAzurePort 是只读属性。 现在,我们已经禁用了这些端口的只读属性。

https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}?api-version={api-version}
{
"parameters": {
    "api-version": "2025-05-01",
    "crossConnectionName": "The name of the cross connection",
    "subscriptionId": "subid"
  }
},
{
Request   "body": {
    "primaryAzurePort": "bvtazureixp03a",
    "secondaryAzurePort": "bvtazureixp03b"
  }
}
Response:
{
  "name": "<circuitServiceKey>",
  "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>",
  "type": "Microsoft.Network/expressRouteCrossConnections",
  "location": "brazilsouth",
  "properties": {
    "provisioningState": "Enabled",
    "expressRouteCircuit": {
      "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1"
    },
    "peerings": [],
    "peeringLocation": "SiliconValley",
    "bandwidthInMbps": 1000,
    "primaryAzurePort": "bvtazureixp03a",
    "secondaryAzurePort": "bvtazureixp03b",
    "sTag": 2,
    "serviceProviderProvisioningState": "NotProvisioned"
  }
}

后续步骤

有关所有 ExpressRoute REST API 的详细信息,请参阅 ExpressRoute REST API。