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 ゲートウェイ接続を作成します。	拡張子	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 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

必須のパラメーター

--gateway-name

VPN ゲートウェイの名前。

--name -n

VPN ゲートウェイ接続の名前。

--remote-vpn-site

リモート VPN サイトの ID の名前。

--resource-group -g

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

省略可能のパラメーター

--associated --associated-route-table

プレビュー

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

--associated-inbound-routemap

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

--associated-outbound-routemap

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

--connection-bandwidth

予想される帯域幅 (Mbps)。

--enable-bgp

BGP を有効にします。

指定可能な値: false, true

--internet-security

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

指定可能な値: false, true

--labels

プレビュー

伝達されたルートテーブルのラベルのスペース区切りの一覧。

--no-wait

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

規定値: False

--propagated --propagated-route-tables

プレビュー

伝達されたルートテーブルのリソース ID のスペース区切りの一覧。

--protocol-type

接続プロトコル。

指定可能な値: IKEv1, IKEv2

--rate-limiting

レート制限を有効にします。

指定可能な値: false, true

--routing-weight

ルーティングの重み。

--shared-key

共有キー。

--vpn-site-link

VPN サイトリンクのリソース ID。

--with-link

既定のリンクを使用して VpnConnection を作成します。

指定可能な値: false, true

グローバルパラメーター

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

省略可能のパラメーター

--gateway-name

VPN ゲートウェイの名前。

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

必須のパラメーター

--gateway-name

VPN ゲートウェイの名前。

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

省略可能のパラメーター

--gateway-name

VPN ゲートウェイの名前。

--ids

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

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

規定値: []

--associated --associated-route-table

プレビュー

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

--associated-inbound-routemap

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

--associated-outbound-routemap

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

--force-string

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

規定値: False

--gateway-name

VPN ゲートウェイの名前。

--ids

--labels

プレビュー

伝達されたルートテーブルのラベルのスペース区切りの一覧。

--name -n

VPN ゲートウェイ接続の名前。

--no-wait

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

規定値: False

--propagated --propagated-route-tables

プレビュー

伝達されたルートテーブルのリソース ID のスペース区切りの一覧。

--remove

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

規定値: []

--resource-group -g

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

--set

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

規定値: []

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

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

az network vpn-gateway connection wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--gateway-name]
                                       [--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

--gateway-name

VPN ゲートウェイの名前。

--ids

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

次の方法で共有

az network vpn-gateway connection

コマンド

az network vpn-gateway connection create

例

必須のパラメーター

省略可能のパラメーター

az network vpn-gateway connection delete

例

省略可能のパラメーター

az network vpn-gateway connection list

例

必須のパラメーター

az network vpn-gateway connection show

例

省略可能のパラメーター

az network vpn-gateway connection update

例

省略可能のパラメーター

az network vpn-gateway connection wait

省略可能のパラメーター

その他のリソース