az network vhub connection
Note
このリファレンスは、Azure CLI (バージョン 2.55.0 以降) の virtual-wan 拡張機能の一部です。 拡張機能は、az network vhub connection コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
仮想ハブの VNet 接続を管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az network vhub connection create |
仮想ハブ VNet 接続を作成します。 |
Extension | GA |
| az network vhub connection delete |
仮想ハブ VNet 接続を削除します。 |
Extension | GA |
| az network vhub connection list |
仮想ハブの VNet 接続を一覧表示します。 |
Extension | GA |
| az network vhub connection show |
仮想ハブ VNet 接続の詳細を取得します。 |
Extension | GA |
| az network vhub connection update |
仮想ハブ接続の設定を更新します。 |
Extension | GA |
| az network vhub connection wait |
条件が満たされるまで CLI を待機状態にします。 |
Extension | GA |
az network vhub connection create
仮想ハブ VNet 接続を作成します。
az network vhub connection create --name
--remote-vnet
--resource-group
--vhub-name
[--address-prefixes]
[--associated --associated-route-table]
[--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 --propagated-route-tables]
[--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
必須のパラメーター
接続の名前。
接続先のリモート VNet の ID の名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
仮想ハブの名前。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
すべてのアドレス プレフィックスのスペース区切りリスト。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
このルーティング構成に関連付けられているルート テーブルのリソース ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
この接続のルーティング構成の受信ルートマップのリソース URI。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
この接続のルーティング構成の送信ルートマップのリソース URI。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
インターネット セキュリティを有効にし、既定値を有効にします。
| プロパティ | 値 |
|---|---|
| 規定値: | True |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
伝達されたルート テーブルのラベルのスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
次ホップの IP アドレス。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
伝達されたルート テーブルのリソース ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
非推奨: ハブからリモート VNet への転送を有効にします。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
VNet ルート内で一意である静的ルートの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
非推奨: リモート VNet でハブの VNet ゲートウェイを使用できるようにします。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
接続の名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
仮想ハブの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
確認を求めないでください。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
仮想ハブの名前。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
接続の名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
仮想ハブの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network vhub connection update
仮想ハブ接続の設定を更新します。
az network vhub connection update [--add]
[--associated --associated-route-table]
[--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 --propagated-route-tables]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--vhub-name]
例
ルーティング構成の下で、伝達されたルート テーブルのラベルを追加します。
az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --labels Newlabel1 Newlabel2
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
このルーティング構成に関連付けられているルート テーブルのリソース ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
この接続のルーティング構成の受信ルートマップのリソース URI。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
この接続のルーティング構成の送信ルートマップのリソース URI。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
伝達されたルート テーブルのラベルのスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
接続の名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
伝達されたルート テーブルのリソース ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Routing Configuration Arguments |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
仮想ハブの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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]
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
接続の名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
最大待機時間 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
仮想ハブの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |