ExpressRoute 回線配置 API

ExpressRoute のパートナー向け回線配置 API を使用すると、ExpressRoute パートナーは特定のポートペアで回線接続をプロビジョニングできます。具体的には、ExpressRoute パートナーが 1 つのピアリングの場所で複数のポートペアを管理している場合、この API を使用すると、どのポートペアで ExpressRoute 回線を促進するかを選択することができます。

この API は、expressRouteCrossConnection リソースの種類を使用します。詳細については、ExpressRoute の CrossConnection API の開発と統合に関するページを参照してください。

expressRouteProviderPort リソースの種類にプロバイダーのサブスクリプションを登録する

サーキット配置 API を使用するには、まず、ポートリソースの種類にアクセスするようにサブスクリプションを登録する必要があります。

Azure にサインインして、登録するサブスクリプションを選択します。

Connect-AzAccount 

Select-AzSubscription -Subscription "<SubscriptionID or SubscriptionName>"

サブスクリプションを登録します。

Register-AzProviderFeature -FeatureName AllowExpressRoutePorts -ProviderNamespace Microsoft.Network

登録したら、Microsoft.Network リソースプロバイダーがサブスクリプションに登録されていることを確認します。リソースプロバイダーの登録によって、サブスクリプションがリソースプロバイダーと連携するように構成されます。

ワークフロー

ExpressRoute のお客様は、ターゲットとなる ExpressRoute 回線のサービスキーを共有します。
ExpressRoute パートナーは、expressRouteProviderPorts API を使用して GET を実行し、ターゲットのポートペアの PortPairDescription を特定します。 ExpressRoute パートナーは、サブスクリプション内のすべてのポートペアの PortPairDescriptions の一覧に対してクエリを実行したり、特定のピアリングの場所に対してクエリのスコープを指定したりすることができます。
ターゲットの PortPairDescription を特定すると、ExpressRoute パートナーは GET/PUT expressRouteCrossConnection を実行して 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 (無効な要求) いずれかの検証が失敗しました。たとえば、プロバイダーの subid が無効です。

場所ことにすべてのポートペアの一覧を取得する

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 (無効な要求) いずれかの検証が失敗しました。たとえば、プロバイダーの subid が無効か、場所が無効です。

ポートペアの記述子 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 (無効な要求) いずれかの検証が失敗しました。たとえば、プロバイダーの subid が無効です。

ターゲットの 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」を参照してください。

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-03-11

次の方法で共有

ExpressRoute 回線配置 API

expressRouteProviderPort リソースの種類にプロバイダーのサブスクリプションを登録する

ワークフロー

API の開発と統合の手順

expressRouteProviderPorts API を使って GET を実行してポート ペアを一覧表示する

プロバイダーのすべてのポート ペアの一覧を取得する方法

場所ことにすべてのポート ペアの一覧を取得する

ポートペアの記述子 ID を使用して、特定のポート ペアを取得します。

ターゲットの ExpressRoute 回線を特定のポート ペアに移動する