az network vhub route-map

注

このリファレンスは、Azure CLI (バージョン 2.55.0 以降) の virtual-wan 拡張機能の一部です。 拡張機能は、az network vhub route-map コマンド 初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

ルート マップを管理します。

コマンド

名前	説明	型	状態
az network vhub route-map create	ルート マップを作成します。	拡張	GA
az network vhub route-map delete	ルート マップを削除します。	拡張	GA
az network vhub route-map get-inbound-routes	特定の接続で仮想ハブ用に構成された受信ルートを取得します。	拡張	GA
az network vhub route-map get-outbound-routes	特定の接続で仮想ハブ用に構成された送信ルートを取得します。	拡張	GA
az network vhub route-map list	リソース グループ別に routem マップを一覧表示します。	拡張	GA
az network vhub route-map rule	ルート マップ ルールを管理します。	拡張	GA
az network vhub route-map rule add	ルート マップ ルールを追加します。	拡張	GA
az network vhub route-map rule delete	ルート マップ ルールを削除します。	拡張	GA
az network vhub route-map rule list	ルート マップ ルールを一覧表示します。	拡張	GA
az network vhub route-map rule show	ルート マップ ルールを表示します。	拡張	GA
az network vhub route-map rule wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA
az network vhub route-map show	ルート マップの詳細を表示します。	拡張	GA
az network vhub route-map update	ルート マップを更新します。	拡張	GA
az network vhub route-map wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA

az network vhub route-map create

ルート マップを作成します。

az network vhub route-map create --name --route-map-name
                                 --resource-group
                                 --vhub-name
                                 [--inbound-connection]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--outbound-connections]
                                 [--rules]

例

ルート マップを作成する

az network vhub route-map create -n route-map-name -g rg --vhub-name vhub-name

必須のパラメーター

--name --route-map-name -n

RouteMap の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--vhub-name

RouteMap を含む VirtualHub の名前。

省略可能のパラメーター

--inbound-connection

この RoutMap が受信トラフィックに関連付けられている接続の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--outbound-connections

この RoutMap が送信トラフィックに関連付けられている接続の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--rules

適用する RouteMap ルールの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az network vhub route-map delete

ルート マップを削除します。

az network vhub route-map delete [--ids]
                                 [--name --route-map-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--subscription]
                                 [--vhub-name]
                                 [--yes]

例

ルート マップの削除

az network vhub route-map delete -n route-map-name -g rg --vhub-name vhub-name

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --route-map-name -n

RouteMap の名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--vhub-name

RouteMap を含む VirtualHub の名前。

--yes -y

確認を求めないでください。

規定値: False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az network vhub route-map get-inbound-routes

特定の接続で仮想ハブ用に構成された受信ルートを取得します。

az network vhub route-map get-inbound-routes [--connection-type]
                                             [--ids]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--resource-group]
                                             [--resource-uri]
                                             [--subscription]
                                             [--vhub-name]

例

受信ルートを取得する

az network vhub route-map get-inbound-routes -g rg --vhub-name vhub-name --connection-type ExpressRouteConnection --resource-uri /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1

省略可能のパラメーター

--connection-type

ExpressRouteConnection、HubVirtualNetworkConnection、VpnConnection、P2SConnection などの指定された接続リソースの種類。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--resource-uri

受信ルートが要求されている接続リソース。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--vhub-name

VirtualHub の名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az network vhub route-map get-outbound-routes

特定の接続で仮想ハブ用に構成された送信ルートを取得します。

az network vhub route-map get-outbound-routes [--connection-type]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--resource-uri]
                                              [--subscription]
                                              [--vhub-name]

例

送信ルートを取得する

az network vhub route-map get-outbound-routes -g rg --vhub-name vhub-name --connection-type ExpressRouteConnection --resource-uri /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1

省略可能のパラメーター

--connection-type

ExpressRouteConnection、HubVirtualNetworkConnection、VpnConnection、P2SConnection などの指定された接続リソースの種類。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--resource-uri

送信ルートが要求されている接続リソース。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--vhub-name

VirtualHub の名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az network vhub route-map list

リソース グループ別に routem マップを一覧表示します。

az network vhub route-map list --resource-group
                               --vhub-name

例

リソース グループ別にルート マップを一覧表示する

az network vhub route-map list -g rg --vhub-name vhub-name

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--vhub-name

RouteMap を含む VirtualHub の名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az network vhub route-map show

ルート マップの詳細を表示します。

az network vhub route-map show [--ids]
                               [--name --route-map-name]
                               [--resource-group]
                               [--subscription]
                               [--vhub-name]

例

ルート マップを表示する

az network vhub route-map show -n route-map-name -g rg --vhub-name vhub-name

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --route-map-name -n

RouteMap の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--vhub-name

RouteMap を含む VirtualHub の名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az network vhub route-map update

ルート マップを更新します。

az network vhub route-map update [--add]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--ids]
                                 [--inbound-connection]
                                 [--name --route-map-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--outbound-connections]
                                 [--remove]
                                 [--resource-group]
                                 [--rules]
                                 [--set]
                                 [--subscription]
                                 [--vhub-name]

例

ルート マップの更新

az network vhub route-map update -n route-map-name -g rg --vhub-name vhub-name --rules "[{name:rule1,matchCriteria:[{matchCondition:Contains,routePrefix:[10.0.0.0/8]}],actions:[{type:Add,parameters:[{asPath:[22334]}]}]}]"

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--inbound-connection

この RoutMap が受信トラフィックに関連付けられている接続の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--name --route-map-name -n

RouteMap の名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--outbound-connections

この RoutMap が送信トラフィックに関連付けられている接続の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--rules

適用する RouteMap ルールの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--vhub-name

RouteMap を含む VirtualHub の名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az network vhub route-map wait

条件が満たされるまで CLI を待機状態にします。

az network vhub route-map wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name --route-map-name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]
                               [--vhub-name]

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--name --route-map-name -n

RouteMap の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False

--vhub-name

RouteMap を含む VirtualHub の名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。