az network vpn-gateway

Note

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

サイト間 VPN ゲートウェイを管理します。

コマンド

名前 説明 Status
az network vpn-gateway connection

サイト間 VPN ゲートウェイ接続を管理します。

拡張子 GA
az network vpn-gateway connection create

サイト間 VPN ゲートウェイ接続を作成します。

拡張子 GA
az network vpn-gateway connection delete

サイト間 VPN ゲートウェイ接続を削除します。

拡張子 GA
az network vpn-gateway connection ipsec-policy

サイト間 VPN ゲートウェイ接続 IPSec ポリシーを管理します。

拡張子 GA
az network vpn-gateway connection ipsec-policy add

サイト間 VPN ゲートウェイ接続に IPSec ポリシーを追加します。

拡張子 GA
az network vpn-gateway connection ipsec-policy list

サイト間 VPN ゲートウェイ接続 IPSec ポリシーを一覧表示します。

拡張子 GA
az network vpn-gateway connection ipsec-policy remove

サイト間 VPN ゲートウェイ接続から IPSec ポリシーを削除します。

拡張子 GA
az network vpn-gateway connection list

サイト間 VPN ゲートウェイ接続を一覧表示します。

拡張子 GA
az network vpn-gateway connection packet-capture

サイト間 VPN ゲートウェイ接続のパケット キャプチャを管理します。

拡張子 GA
az network vpn-gateway connection packet-capture start

指定したリソース グループ内の Vpn 接続でパケット キャプチャを開始します。

拡張子 GA
az network vpn-gateway connection show

サイト間 VPN ゲートウェイ接続の詳細を取得します。

拡張子 GA
az network vpn-gateway connection update

VPN ゲートウェイ接続の設定を更新します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn

サイト間 VPN ゲートウェイ接続 VPN サイト リンク接続を管理します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn add

サイト間 VPN ゲートウェイ接続に VPN サイト リンク接続を追加します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy

サイト間 VPN ゲートウェイ接続 VPN サイト リンク IPSec ポリシーを管理します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy add

サイト間 VPN ゲートウェイ接続 VPN サイト リンクに IPSec ポリシーを追加します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy list

サイト間 VPN ゲートウェイ接続 VPN サイト リンク IPSec ポリシーを一覧表示します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy remove

サイト間 VPN ゲートウェイ接続 VPN サイト リンクから IPSec ポリシーを削除します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn list

サイト間 VPN ゲートウェイ接続 VPN サイト リンク接続を一覧表示します。

拡張子 GA
az network vpn-gateway connection vpn-site-link-conn remove

サイト間 VPN ゲートウェイ接続から VPN サイト リンク接続を削除します。

拡張子 GA
az network vpn-gateway connection wait

サイト間 VPN ゲートウェイ接続の条件が満たされるまで、CLI を待機状態にします。

拡張子 GA
az network vpn-gateway create

サイト間 VPN ゲートウェイを作成します。

拡張子 GA
az network vpn-gateway delete

サイト間 VPN ゲートウェイを削除します。

拡張子 GA
az network vpn-gateway list

サイト間 VPN ゲートウェイを一覧表示します。

拡張子 GA
az network vpn-gateway nat-rule

サイト間 VPN ゲートウェイ NAT 規則を管理します。

拡張子 GA
az network vpn-gateway nat-rule create

スケーラブルな VPN ゲートウェイが存在しない場合は、nat 規則を作成して既存の nat 規則を更新します。

拡張子 GA
az network vpn-gateway nat-rule delete

nat 規則を削除します。

拡張子 GA
az network vpn-gateway nat-rule list

特定の仮想 WAN VPN ゲートウェイのすべての nat 規則を一覧表示します。

拡張子 GA
az network vpn-gateway nat-rule show

nat ruleGet の詳細を取得します。

拡張子 GA
az network vpn-gateway nat-rule update

nat 規則が存在しない場合は、スケーラブルな VPN ゲートウェイに更新し、それ以外の場合は既存の nat 規則を更新します。

拡張子 GA
az network vpn-gateway nat-rule wait

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

拡張子 GA
az network vpn-gateway show

サイト間 VPN ゲートウェイの詳細を取得します。

拡張子 GA
az network vpn-gateway update

サイト間 VPN ゲートウェイの設定を更新します。

拡張子 GA
az network vpn-gateway wait

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

拡張子 GA

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

必須のパラメーター

--name -n

VPN ゲートウェイの名前。

--resource-group -g

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

省略可能のパラメーター

--asn

BGP スピーカーの ASN。

--bgp-peering-address

この BGP スピーカーのピアリング アドレスと BGP 識別子。

--location -l

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

--no-wait

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

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

この BGP スピーカーから学習したルートに追加された重み。

--scale-unit

この VPN ゲートウェイのスケール ユニット。

--tags

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

--vhub

仮想ハブの名前または 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 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

省略可能のパラメーター

--ids

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

--name -n

VPN ゲートウェイの名前。

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

グローバル パラメーター
--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 vpn-gateway list

サイト間 VPN ゲートウェイを一覧表示します。

az network vpn-gateway list [--resource-group]

サイト間 VPN ゲートウェイを一覧表示します。

az network vpn-gateway 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 vpn-gateway show

サイト間 VPN ゲートウェイの詳細を取得します。

az network vpn-gateway show [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

サイト間 VPN ゲートウェイの詳細を取得します。

az network vpn-gateway show -n MyVPNGateway -g MyRG

省略可能のパラメーター

--ids

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

--name -n

VPN ゲートウェイの名前。

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

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

--asn

BGP スピーカーの ASN。

--bgp-peering-address

この BGP スピーカーのピアリング アドレスと BGP 識別子。

--force-string

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

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

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

--name -n

VPN ゲートウェイの名前。

--no-wait

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

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

この BGP スピーカーから学習したルートに追加された重み。

--remove

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

--resource-group -g

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

--scale-unit

この VPN ゲートウェイのスケール ユニット。

--set

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

--subscription

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

--tags

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

--vhub

仮想ハブの名前または 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 vpn-gateway wait

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

az network vpn-gateway 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

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

--interval

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

既定値: 30
--name -n

VPN ゲートウェイの名前。

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