az network vpn-gateway
Note
このリファレンスは、Azure CLI (バージョン 2.55.0 以降) の virtual-wan 拡張機能の一部です。 拡張機能は、az network vpn-gateway コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
サイト間 VPN ゲートウェイを管理します。
コマンド
az network vpn-gateway create
サイト間 VPN ゲートウェイを作成します。
az network vpn-gateway create --name
--resource-group
[--asn]
[--bgp-peering-address]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--peer-weight]
[--scale-unit]
[--tags]
[--vhub]例
サイト間 VPN ゲートウェイを作成します。
az network vpn-gateway create -n MyVPNGateway -g MyRG --vhub MyVHub -l westus必須のパラメーター
VPN ゲートウェイの名前。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
省略可能のパラメーター
BGP スピーカーの ASN。
この BGP スピーカーのピアリング アドレスと BGP 識別子。
Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。 指定しない場合は、リソース グループの場所が使用されます。
実行時間の長い操作の終了を待機しません。
この BGP スピーカーから学習したルートに追加された重み。
この VPN ゲートウェイのスケール ユニット。
スペース区切りのタグ: key[=value] [key[=value] ...]短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
仮想ハブの名前または ID。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az network vpn-gateway delete
サイト間 VPN ゲートウェイを削除します。
az network vpn-gateway delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]例
サイト間 VPN ゲートウェイを削除します。
az network vpn-gateway delete -n MyVPNGateway -g MyRG省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
VPN ゲートウェイの名前。
実行時間の長い操作の終了を待機しません。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az network vpn-gateway list
サイト間 VPN ゲートウェイを一覧表示します。
az network vpn-gateway list [--resource-group]例
サイト間 VPN ゲートウェイを一覧表示します。
az network vpn-gateway list -g MyRG省略可能のパラメーター
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az network vpn-gateway show
サイト間 VPN ゲートウェイの詳細を取得します。
az network vpn-gateway show [--ids]
[--name]
[--resource-group]
[--subscription]例
サイト間 VPN ゲートウェイの詳細を取得します。
az network vpn-gateway show -n MyVPNGateway -g MyRG省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
VPN ゲートウェイの名前。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az network vpn-gateway update
サイト間 VPN ゲートウェイの設定を更新します。
az network vpn-gateway update [--add]
[--asn]
[--bgp-peering-address]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--peer-weight]
[--remove]
[--resource-group]
[--scale-unit]
[--set]
[--subscription]
[--tags]
[--vhub]例
サイト間 VPN ゲートウェイの設定を更新します。
az network vpn-gateway create -g MyRG --vhub MyVHub --name MyVPNGateway --tags foo=bar省略可能のパラメーター
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。
BGP スピーカーの ASN。
この BGP スピーカーのピアリング アドレスと BGP 識別子。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
VPN ゲートウェイの名前。
実行時間の長い操作の終了を待機しません。
この BGP スピーカーから学習したルートに追加された重み。
リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
この VPN ゲートウェイのスケール ユニット。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
スペース区切りのタグ: key[=value] [key[=value] ...]短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
仮想ハブの名前または ID。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az network vpn-gateway wait
条件が満たされるまで CLI を待機状態にします。
az network vpn-gateway wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
ポーリング間隔 (秒単位)。
VPN ゲートウェイの名前。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
最大待機時間 (秒単位)。
provisioningState が 'Succeeded' で更新されるまで待ちます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI