Virtual Hubs - Get Outbound Routes

サービス:

Virtual WAN

API バージョン:

2025-05-01

特定の接続上の仮想 HUB に設定された送信ルートを取得します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes?api-version=2025-05-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前の大文字と小文字は区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
virtualHubName	path	True	string	VirtualHubの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
connectionType	string	ExpressRouteConnection、HubVirtualNetworkConnection、VpnConnection、P2SConnection など、指定された接続リソースの種類。
resourceUri	string	アウトバウンド・ルートが要求されている接続リソース。

応答

名前	型	説明
200 OK	EffectiveRouteMapRouteList	Azureの運用は無事に完了しました。
202 Accepted		リソース操作が受け入れられます。 ヘッダー Location: string Retry-After: integer
Other Status Codes	Common.CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Outbound Routes for the Virtual Hub on a Particular Connection

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/outboundRoutes?api-version=2025-05-01

{
  "connectionType": "ExpressRouteConnection",
  "resourceUri": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python get_outbound_routes.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.virtual_hubs.begin_get_outbound_routes(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub1",
        get_outbound_routes_parameters={
            "connectionType": "ExpressRouteConnection",
            "resourceUri": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-05-01/GetOutboundRoutes.json
if __name__ == "__main__":
    main()

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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the outbound routes configured for the Virtual Hub on a particular connection.
 *
 * @summary Gets the outbound routes configured for the Virtual Hub on a particular connection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/GetOutboundRoutes.json
 */
async function outboundRoutesForTheVirtualHubOnAParticularConnection() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const getOutboundRoutesParameters = {
    connectionType: "ExpressRouteConnection",
    resourceUri:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.beginGetOutboundRoutesAndWait(
    resourceGroupName,
    virtualHubName,
    getOutboundRoutesParameters,
  );
  console.log(result);
}

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "asPath": "65520-65520",
      "bgpCommunities": "4293853166,12076,51004",
      "prefix": "192.168.50.0/24"
    },
    {
      "asPath": "65520-65520-12076-12076",
      "bgpCommunities": "4293787629,12076,51027,4293734188",
      "prefix": "10.200.0.0/16"
    }
  ]
}

状態コード:

202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

定義

名前	説明
Common.CloudError	サービスからのエラー応答。
Common.CloudErrorBody	サービスからのエラー応答。
EffectiveRouteMapRoute	接続リソースで構成された有効な RouteMap ルート。
EffectiveRouteMapRouteList	EffectiveRouteMapRoute リスト。
GetOutboundRoutesParameters	送信ルートが要求される接続リソースを指定するパラメーター。

Common.CloudError

Object

サービスからのエラー応答。

名前	型	説明
error	Common.CloudErrorBody	クラウド エラー本文。

Common.CloudErrorBody

Object

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details	Common.CloudErrorBody[]	エラーに関する追加の詳細のリスト。
message	string	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

EffectiveRouteMapRoute

Object

接続リソースで構成された有効な RouteMap ルート。

名前	型	説明
asPath	string	このルートの ASPath。
bgpCommunities	string	ルートのBGPコミュニティ。
prefix	string	ルートのアドレスプレフィックス。

EffectiveRouteMapRouteList

Object

EffectiveRouteMapRoute リスト。

名前	型	説明
value	EffectiveRouteMapRoute[]	接続リソースに設定された有効な RouteMap ルートのリスト。

GetOutboundRoutesParameters

Object

送信ルートが要求される接続リソースを指定するパラメーター。

名前	型	説明
connectionType	string	ExpressRouteConnection、HubVirtualNetworkConnection、VpnConnection、P2SConnection など、指定された接続リソースの種類。
resourceUri	string	アウトバウンド・ルートが要求されている接続リソース。