az network vpn-gateway connection
Note
このリファレンスは、Azure CLI (バージョン 2.55.0 以降) の virtual-wan 拡張機能の一部です。 拡張機能は、az network vpn-gateway 接続コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
サイト間 VPN ゲートウェイ接続を管理します。
コマンド
az network vpn-gateway connection create
サイト間 VPN ゲートウェイ接続を作成します。
az network vpn-gateway connection create --gateway-name
--name
--remote-vpn-site
--resource-group
[--associated]
[--associated-inbound-routemap]
[--associated-outbound-routemap]
[--connection-bandwidth]
[--enable-bgp {false, true}]
[--internet-security {false, true}]
[--labels]
[--no-wait]
[--propagated]
[--protocol-type {IKEv1, IKEv2}]
[--rate-limiting {false, true}]
[--routing-weight]
[--shared-key]
[--vpn-site-link]
[--with-link {false, true}]例
サイト間 VPN ゲートウェイ接続を作成する
az network vpn-gateway connection create -g MyRG -n MyConnection --gateway-name MyGateway --remote-vpn-site /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/vpnSites/MyVPNSite --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable2 --labels label1 label2必須のパラメーター
VPN ゲートウェイの名前。
VPN ゲートウェイ接続の名前。
リモート VPN サイトの ID の名前。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
省略可能のパラメーター
このルーティング構成に関連付けられているルート テーブルのリソース ID。
この接続のルーティング構成の受信ルートマップのリソース URI。
この接続のルーティング構成の送信ルートマップのリソース URI。
予想される帯域幅 (Mbps)。
BGP を有効にします。
インターネット セキュリティを有効にします。
伝達されたルート テーブルのラベルのスペース区切りの一覧。
実行時間の長い操作の終了を待機しません。
伝達されたルート テーブルのリソース ID のスペース区切りの一覧。
接続プロトコル。
レート制限を有効にします。
ルーティングの重み。
共有キー。
VPN サイト リンクのリソース ID。
既定のリンクを使用して VpnConnection を作成します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az network vpn-gateway connection delete
サイト間 VPN ゲートウェイ接続を削除します。
az network vpn-gateway connection delete [--gateway-name]
[--ids]
[--name]
[--resource-group]
[--subscription]例
サイト間 VPN ゲートウェイ接続を削除する
az network vpn-gateway connection delete -g MyRG -n MyConnection --gateway-name MyGateway省略可能のパラメーター
VPN ゲートウェイの名前。
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 connection list
サイト間 VPN ゲートウェイ接続を一覧表示します。
az network vpn-gateway connection list --gateway-name
--resource-group例
特定のサイト間 VPN ゲートウェイのすべての接続を一覧表示する
az network vpn-gateway connection list -g MyRG --gateway-name MyGateway必須のパラメーター
VPN ゲートウェイの名前。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az network vpn-gateway connection show
サイト間 VPN ゲートウェイ接続の詳細を取得します。
az network vpn-gateway connection show [--gateway-name]
[--ids]
[--name]
[--resource-group]
[--subscription]例
サイト間 VPN ゲートウェイ接続の詳細を取得する
az network vpn-gateway connection show -g MyRG -n MyConnection --gateway-name MyGateway省略可能のパラメーター
VPN ゲートウェイの名前。
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 connection update
VPN ゲートウェイ接続の設定を更新します。
az network vpn-gateway connection update [--add]
[--associated]
[--associated-inbound-routemap]
[--associated-outbound-routemap]
[--force-string]
[--gateway-name]
[--ids]
[--labels]
[--name]
[--no-wait]
[--propagated]
[--remove]
[--resource-group]
[--set]
[--subscription]例
ルーティング構成の下で、伝達されたルート テーブルのラベルを追加します。
az network vpn-gateway connection update -g MyRG -n MyConnection --gateway-name MyGateway --labels NewLabel1 NewLabels2省略可能のパラメーター
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。
このルーティング構成に関連付けられているルート テーブルのリソース ID。
この接続のルーティング構成の受信ルートマップのリソース URI。
この接続のルーティング構成の送信ルートマップのリソース URI。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
VPN ゲートウェイの名前。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
伝達されたルート テーブルのラベルのスペース区切りの一覧。
VPN ゲートウェイ接続の名前。
実行時間の長い操作の終了を待機しません。
伝達されたルート テーブルのリソース ID のスペース区切りの一覧。
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove.
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。
サブスクリプションの名前または 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 connection wait
サイト間 VPN ゲートウェイ接続の条件が満たされるまで、CLI を待機状態にします。
az network vpn-gateway connection wait [--created]
[--custom]
[--deleted]
[--exists]
[--gateway-name]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
VPN ゲートウェイの名前。
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 を使います。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示