az network vhub

リファレンス

Note

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

仮想ハブを管理します。

コマンド

名前	説明	型	状態
az network vhub bgpconnection	仮想ハブの bgpconnection を管理します。	拡張子	GA
az network vhub bgpconnection create	仮想ハブ bgpconnection を作成します。	拡張子	GA
az network vhub bgpconnection delete	仮想ハブ bgpconnection を削除します。	拡張子	GA
az network vhub bgpconnection list	仮想ハブの bgpconnection を一覧表示します。	拡張子	GA
az network vhub bgpconnection show	仮想ハブ bgpconnection の詳細を取得します。	拡張子	GA
az network vhub bgpconnection update	仮想ハブ bgpconnection の設定を更新します。	拡張子	GA
az network vhub bgpconnection wait	仮想ハブ bgpconnection の条件が満たされるまで、CLI を待機状態にします。	拡張子	GA
az network vhub connection	仮想ハブの VNet 接続を管理します。	拡張子	GA
az network vhub connection create	仮想ハブ VNet 接続を作成します。	拡張子	GA
az network vhub connection delete	仮想ハブ VNet 接続を削除します。	拡張子	GA
az network vhub connection list	仮想ハブの VNet 接続を一覧表示します。	拡張子	GA
az network vhub connection show	仮想ハブ VNet 接続の詳細を取得します。	拡張子	GA
az network vhub connection update	仮想ハブ接続の設定を更新します。	拡張子	GA
az network vhub connection wait	条件が満たされるまで CLI を待機状態にします。	拡張子	GA
az network vhub create	仮想ハブを作成します。	拡張子	GA
az network vhub delete	仮想ハブを削除します。	拡張子	GA
az network vhub get-effective-routes	仮想ハブリソースまたは指定されたリソース用に構成された有効なルートを取得します。	拡張子	GA
az network vhub list	仮想ハブを一覧表示します。	拡張子	GA
az network vhub route	仮想ハブルートテーブルのエントリを管理します。	拡張子	非推奨
az network vhub route-map	ルートマップを管理します。	拡張子	GA
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-table	仮想ハブのルートテーブルを管理します。	拡張子	GA
az network vhub route-table create	仮想ハブにルートテーブルを作成します。	拡張子	GA
az network vhub route-table delete	仮想ハブ内のルートテーブルを削除します。	拡張子	GA
az network vhub route-table list	仮想ハブ内のすべてのルートテーブルを一覧表示します。	拡張子	GA
az network vhub route-table route	仮想ハブ内のルートテーブルのルートを管理します。	拡張子	GA
az network vhub route-table route add	仮想ハブのルートテーブルにルートを追加します。	拡張子	GA
az network vhub route-table route list	仮想ハブルートテーブル内のルートを一覧表示します。	拡張子	GA
az network vhub route-table route remove	仮想ハブのルートテーブルからルートを削除します。	拡張子	GA
az network vhub route-table show	仮想ハブにルートテーブルを表示します。	拡張子	GA
az network vhub route-table update	仮想ハブのルートテーブルを更新します。	拡張子	GA
az network vhub route-table wait	vhub route-table の条件が満たされるまで、CLI を待機状態にします。	拡張子	GA
az network vhub route add	仮想ハブルートテーブルにルートを追加します。	拡張子	非推奨
az network vhub route list	仮想ハブルートテーブル内のルートを一覧表示します。	拡張子	非推奨
az network vhub route remove	仮想ハブルートテーブルからルートを削除します。	拡張子	非推奨
az network vhub route reset	ルートの状態が失敗したときに仮想ハブルートをリセットします。	拡張子	非推奨
az network vhub routing-intent	仮想ハブでルーティングインテントを管理します。	拡張子	プレビュー
az network vhub routing-intent create	仮想ハブにルーティングインテントを作成します。	拡張子	プレビュー
az network vhub routing-intent delete	仮想ハブ内のルーティング意図を削除します。	拡張子	プレビュー
az network vhub routing-intent list	仮想ハブのすべてのルーティング意図リソースの詳細を取得します。	拡張子	プレビュー
az network vhub routing-intent show	ルーティング意図の詳細を取得します。	拡張子	プレビュー
az network vhub routing-intent update	仮想ハブのルーティング意図を更新します。	拡張子	プレビュー
az network vhub routing-intent wait	条件が満たされるまで CLI を待機状態にします。	拡張子	プレビュー
az network vhub show	仮想ハブの詳細を取得します。	拡張子	GA
az network vhub update	仮想ハブの設定を更新します。	拡張子	GA
az network vhub wait	条件が満たされるまで CLI を待機状態にします。	拡張子	GA

az network vhub create

仮想ハブを作成します。

az network vhub create --name
                       --resource-group
                       [--address-prefix]
                       [--allow-b2b-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                       [--asn]
                       [--auto-scale-config]
                       [--hub-routing-preference {ASPath, ExpressRoute, VpnGateway}]
                       [--location]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--sku]
                       [--tags]
                       [--vwan]

例

仮想ハブを作成します。

az network vhub create -g MyRG -n MyVHub --vwan MyVWan --address-prefix 10.0.0.0/24 -l SouthCentralUS --sku Standard

必須のパラメーター

--name -n

仮想ハブの名前。

--resource-group -g

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

省略可能のパラメーター

--address-prefix

仮想ハブの CIDR アドレスプレフィックス。

--allow-b2b-traffic

VirtualRouter ハブのブランチ間トラフィックを制御するためのフラグ。

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

--asn

VirtualRouter ASN。

--auto-scale-config

VirtualHub ルーターの自動スケール構成。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--hub-routing-preference

ハブルーティング優先ゲートウェイの種類。

指定可能な値: ASPath, ExpressRoute, VpnGateway

--location -l

Location。値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。指定しない場合は、リソースグループの場所が使用されます。

--no-wait

実行時間の長い操作の終了を待機しません。

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

--sku

VirtualHub の SKU。使用できる値: Basic、Standard。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--vwan

仮想 WAN の名前または ID。

グローバルパラメーター

--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 delete

仮想ハブを削除します。

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

例

仮想ハブを削除します。

az network vhub delete -n MyVHub -g MyRG

省略可能のパラメーター

--ids

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

--name -n

仮想ハブの名前。

--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 を使用して、既定のサブスクリプションを構成できます。

--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 get-effective-routes

仮想ハブリソースまたは指定されたリソース用に構成された有効なルートを取得します。

az network vhub get-effective-routes [--ids]
                                     [--name]
                                     [--no-wait]
                                     [--resource-group]
                                     [--resource-id]
                                     [--resource-type]
                                     [--subscription]

例

仮想ハブのルートテーブル用に構成された有効なルートを取得します。

az network vhub get-effective-routes --resource-type RouteTable --resource-id /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable -g MyRG -n MyHub

仮想ハブで P2S 接続用に構成された有効なルートを取得します。

az network vhub get-effective-routes --resource-type P2SConnection --resource-id /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/p2sVpnGateways/MyGateway/p2sConnectionConfigurations/MyConnection -g MyRG -n MyHub

省略可能のパラメーター

--ids

--name -n

仮想ハブの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

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

--resource-id

有効なルートが要求されているリソース。

--resource-type

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

--subscription

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

グローバルパラメーター

--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 list

仮想ハブを一覧表示します。

az network vhub list [--resource-group]

例

仮想ハブを一覧表示します。

az network vhub list -g MyRG

省略可能のパラメーター

--resource-group -g

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

グローバルパラメーター

--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 show

仮想ハブの詳細を取得します。

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

例

仮想ハブの詳細を取得します。

az network vhub show -n MyVHub -g MyRG

省略可能のパラメーター

--ids

--name -n

仮想ハブの名前。

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 update

仮想ハブの設定を更新します。

az network vhub update [--add]
                       [--address-prefix]
                       [--allow-b2b-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                       [--asn]
                       [--auto-scale-config]
                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                       [--hub-routing-preference {ASPath, ExpressRoute, VpnGateway}]
                       [--ids]
                       [--name]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--remove]
                       [--resource-group]
                       [--set]
                       [--sku]
                       [--subscription]
                       [--tags]
                       [--vwan]

例

仮想ハブの設定を更新します。

az network vhub update -g MyRG -n MyVHub --sku Basic --hub-routing-preference VpnGateway

省略可能のパラメーター

--add

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

--address-prefix

仮想ハブの CIDR アドレスプレフィックス。

--allow-b2b-traffic

VirtualRouter ハブのブランチ間トラフィックを制御するためのフラグ。

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

--asn

VirtualRouter ASN。

--auto-scale-config

VirtualHub ルーターの自動スケール構成。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--force-string

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

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

--hub-routing-preference

ハブルーティング優先ゲートウェイの種類。

指定可能な値: ASPath, ExpressRoute, VpnGateway

--ids

--name -n

仮想ハブの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

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

--remove

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

--resource-group -g

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

--set

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

--sku

VirtualHub の SKU。

--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--vwan

仮想 WAN の名前または ID。

グローバルパラメーター

--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 wait

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

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

省略可能のパラメーター

--created

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

規定値: False

--custom

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

--deleted

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

規定値: False

--exists

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

規定値: False

--ids

--interval

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

規定値: 30

--name -n

仮想ハブの名前。

--resource-group -g

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

--subscription

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

--timeout

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

規定値: 3600

--updated

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

規定値: 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

コマンド

az network vhub create

例

必須のパラメーター

省略可能のパラメーター

az network vhub delete

例

省略可能のパラメーター

az network vhub get-effective-routes

例

省略可能のパラメーター

az network vhub list

例

省略可能のパラメーター

az network vhub show

例

省略可能のパラメーター

az network vhub update

例

省略可能のパラメーター

az network vhub wait

省略可能のパラメーター

その他のリソース