az network vhub connection

Note

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

仮想ハブの VNet 接続を管理します。

コマンド

名前	説明	型	Status
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 connection create

仮想ハブ VNet 接続を作成します。

az network vhub connection create --name
                                  --remote-vnet
                                  --resource-group
                                  --vhub-name
                                  [--address-prefixes]
                                  [--associated]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--internet-security {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--labels]
                                  [--next-hop]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--propagated]
                                  [--remote-vnet-transit {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--route-name]
                                  [--use-hub-vnet-gateways {0, 1, f, false, n, no, t, true, y, yes}]

例

ルーティング構成なしで仮想ハブ VNet 接続を作成します。

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet

ルーティング構成を使用して仮想ハブ VNet 接続を作成します。

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable2 --labels label1 label2 --route-name route1 --next-hop 70.0.0.2 --address-prefixes 10.80.0.0/16 10.90.0.0/16

必須のパラメーター

--name -n

接続の名前。

--remote-vnet

接続先のリモート VNet の ID の名前。

--resource-group -g

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

--vhub-name

仮想ハブの名前。

省略可能のパラメーター

--address-prefixes

プレビュー

すべてのアドレス プレフィックスのスペース区切りリスト。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--associated --associated-route-table

プレビュー

このルーティング構成に関連付けられているルート テーブルのリソース ID。

--associated-inbound-routemap

この接続のルーティング構成の受信ルートマップのリソース URI。

--associated-outbound-routemap

この接続のルーティング構成の送信ルートマップのリソース URI。

--internet-security

インターネット セキュリティを有効にし、既定値を有効にします。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

既定値: True

--labels

プレビュー

伝達されたルート テーブルのラベルのスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--next-hop

プレビュー

次ホップの IP アドレス。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--propagated --propagated-route-tables

プレビュー

伝達されたルート テーブルのリソース ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--remote-vnet-transit

非推奨: ハブからリモート VNet への転送を有効にします。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--route-name

プレビュー

VNet ルート内で一意である静的ルートの名前。

--use-hub-vnet-gateways

非推奨: リモート VNet でハブの VNet ゲートウェイを使用できるようにします。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

グローバル パラメーター

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

仮想ハブ VNet 接続を削除します。

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

例

仮想ハブ VNet 接続を削除します。

az network vhub connection delete -n MyConnection --vhub-name MyHub -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 を使用して、既定のサブスクリプションを構成できます。

--vhub-name

仮想ハブの名前。

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

仮想ハブの VNet 接続を一覧表示します。

az network vhub connection list --resource-group
                                --vhub-name
                                [--max-items]
                                [--next-token]

例

特定の仮想ハブ内の VNet 接続を一覧表示します。

az network vhub connection list --vhub-name MyHub -g MyRG

必須のパラメーター

--resource-group -g

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

--vhub-name

仮想ハブの名前。

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

グローバル パラメーター

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

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

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

例

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

az network vhub connection show -n MyConnection --vhub-name MyHub -g MyRG

省略可能のパラメーター

--ids

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

--name -n

接続の名前。

--resource-group -g

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

--subscription

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

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

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

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

例

ルーティング構成の下で、伝達されたルート テーブルのラベルを追加します。

az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --labels Newlabel1 Newlabel2

省略可能のパラメーター

--add

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

--associated --associated-route-table

プレビュー

このルーティング構成に関連付けられているルート テーブルのリソース ID。

--associated-inbound-routemap

この接続のルーティング構成の受信ルートマップのリソース URI。

--associated-outbound-routemap

この接続のルーティング構成の送信ルートマップのリソース URI。

--force-string

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--labels

プレビュー

伝達されたルート テーブルのラベルのスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--name -n

接続の名前。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--propagated --propagated-route-tables

プレビュー

伝達されたルート テーブルのリソース ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--remove

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

--resource-group -g

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

--set

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

--subscription

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

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

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

az network vhub connection wait [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--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 -n

接続の名前。

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

仮想ハブの名前。

グローバル パラメーター

--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 を使います。