az network vpn-connection

VPN 接続を管理します。

サイト間接続の詳細については、 https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cliを参照してください。 Vnet 間接続の詳細については、 https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-vnet-vnet-cliを参照してください。

コマンド

名前	説明	型	状態
az network vpn-connection create	VPN 接続を作成する。	Core	GA
az network vpn-connection delete	VPN 接続を削除します。	Core	GA
az network vpn-connection ipsec-policy	VPN 接続 IPSec ポリシーを管理します。	Core	GA
az network vpn-connection ipsec-policy add	VPN 接続 IPSec ポリシーを追加します。	Core	GA
az network vpn-connection ipsec-policy clear	VPN 接続上のすべての IPsec ポリシーを削除します。	Core	GA
az network vpn-connection ipsec-policy list	VPN 接続に関連付けられている IPSec ポリシーを一覧表示します。	Core	GA
az network vpn-connection ipsec-policy wait	条件が満たされるまで CLI を待機状態にします。	Core	GA
az network vpn-connection list	すべての VPN 接続を一覧表示します。	Core	GA
az network vpn-connection list-ike-sas	VPN 接続の IKE セキュリティアソシエーションを一覧表示します。	Core	Preview
az network vpn-connection packet-capture	VPN 接続でパケットキャプチャを管理します。	Core	GA
az network vpn-connection packet-capture start	VPN 接続でパケットキャプチャを開始します。	Core	GA
az network vpn-connection packet-capture stop	VPN 接続でパケットキャプチャを停止します。	Core	Preview
az network vpn-connection packet-capture wait	条件が満たされるまで CLI を待機状態にします。	Core	GA
az network vpn-connection shared-key	VPN 共有キーを管理します。	Core	GA
az network vpn-connection shared-key reset	VPN 接続の共有キーをリセットします。	Core	GA
az network vpn-connection shared-key show	VPN 接続の共有キーを取得します。	Core	GA
az network vpn-connection shared-key update	VPN 接続の共有キーを更新します。	Core	GA
az network vpn-connection show	VPN 接続の詳細を取得します。	Core	GA
az network vpn-connection show-device-config-script	VPN 接続デバイス構成スクリプトの XML 形式表現を取得します。	Core	Preview
az network vpn-connection update	VPN 接続を更新します。	Core	GA
az network vpn-connection wait	条件が満たされるまで CLI を待機状態にします。	Core	GA

az network vpn-connection create

編集

VPN 接続を作成する。

VPN ゲートウェイとローカルネットワークゲートウェイの間の接続を作成する前に、VPN ゲートウェイとローカルネットワークゲートウェイをプロビジョニングする必要があります。

az network vpn-connection create --name
                                 --resource-group
                                 --vnet-gateway1
                                 [--authorization-key]
                                 [--egress-nat-rule]
                                 [--enable-bgp]
                                 [--express-route-circuit2]
                                 [--express-route-gateway-bypass {false, true}]
                                 [--ingress-nat-rule]
                                 [--local-gateway2]
                                 [--location]
                                 [--routing-weight]
                                 [--shared-key]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {false, true}]
                                 [--validate]
                                 [--vnet-gateway2]

例

Azure 仮想ネットワークとオンプレミスのローカルネットワークゲートウェイの間にサイト間接続を作成します。

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123

--ingress-nat-rule を使用して VPN 接続を作成します。

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123 --ingress-nat-rule /subscriptions/000/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/gwx/natRules/nat

VPN 接続を作成する。 (autogenerated)

az network vpn-connection create --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway --vnet-gateway2 /subscriptions/{subscriptionID}/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/VNet1GW

VPN 接続を作成する。 (autogenerated)

az network vpn-connection create --local-gateway2 MyLocalGateway --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway

必須のパラメーター

--name -n

Connection name.

--resource-group -g

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

--vnet-gateway1

ソース仮想ネットワークゲートウェイの名前または ID。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--authorization-key

VPN 接続の承認キー。

--egress-nat-rule

プレビュー

エグレス NatRules の一覧。

--enable-bgp

この VPN 接続に対して BGP を有効にします。

プロパティ	値
規定値:	False

--express-route-circuit2

"ExpressRoute" 接続を使用して接続する宛先 ExpressRoute の名前または ID。

プロパティ	値
Parameter group:	Destination Arguments

--express-route-gateway-bypass

データ転送のために ExpressRoute ゲートウェイをバイパスします。

プロパティ	値
指定可能な値:	false, true

--ingress-nat-rule

プレビュー

イングレス NatRules の一覧。

--local-gateway2

"IPSec" 接続を使用して接続する宛先ローカルネットワークゲートウェイの名前または ID。

プロパティ	値
Parameter group:	Destination Arguments

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--routing-weight

接続ルーティングの重み。

プロパティ	値
規定値:	10

--shared-key

共有 IPSec キー。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--use-policy-based-traffic-selectors

ポリシーベースのトラフィックセレクターを有効にします。

プロパティ	値
規定値:	False
指定可能な値:	false, true

--validate

ARM テンプレートを表示して検証しますが、リソースは作成しません。

プロパティ	値
規定値:	False

--vnet-gateway2

"Vnet2Vnet" 接続を使用して接続する宛先仮想ネットワークゲートウェイの名前または ID。

プロパティ	値
Parameter group:	Destination Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az network vpn-connection delete

編集

VPN 接続を削除します。

az network vpn-connection delete [--ids]
                                 [--name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--subscription]

例

VPN 接続を削除します。

az network vpn-connection delete -g MyResourceGroup -n MyConnection

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

Connection name.

プロパティ	値
Parameter group:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az network vpn-connection list

編集

すべての VPN 接続を一覧表示します。

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

例

リソースグループ内のすべての VPN 接続を一覧表示します。

az network vpn-connection list -g MyResourceGroup

仮想ネットワークゲートウェイ内のすべての VPN 接続を一覧表示します。

az network vpn-connection list -g MyResourceGroup --vnet-gateway MyVnetGateway

必須のパラメーター

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--vnet-gateway

VNet ゲートウェイの名前。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az network vpn-connection list-ike-sas

編集

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

VPN 接続の IKE セキュリティアソシエーションを一覧表示します。

az network vpn-connection list-ike-sas [--ids]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

例

VPN 接続の IKE セキュリティアソシエーションを一覧表示します。

az network vpn-connection list-ike-sas -g MyResourceGroup -n MyConnection

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

Connection name.

プロパティ	値
Parameter group:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az network vpn-connection show

編集

VPN 接続の詳細を取得します。

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

例

VPN 接続の詳細を表示します。

az network vpn-connection show -g MyResourceGroup -n MyConnection

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

Connection name.

プロパティ	値
Parameter group:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az network vpn-connection show-device-config-script

編集

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

VPN 接続デバイス構成スクリプトの XML 形式表現を取得します。

az network vpn-connection show-device-config-script --device-family
                                                    --firmware-version
                                                    --vendor
                                                    [--ids]
                                                    [--name]
                                                    [--resource-group]
                                                    [--subscription]

例

VPN 接続デバイス構成スクリプトの XML 形式表現を取得します。

az network vpn-connection show-device-config-script -g MyResourceGroup -n MyConnection --vendor "Cisco" --device-family "Cisco-ISR(IOS)" --firmware-version "Cisco-ISR-15.x-- IKEv2+BGP"

必須のパラメーター

--device-family

VPN デバイスのデバイスファミリ。

--firmware-version

VPN デバイスのファームウェアバージョン。

--vendor

VPN デバイスのベンダー。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

Connection name.

プロパティ	値
Parameter group:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az network vpn-connection update

編集

VPN 接続を更新します。

az network vpn-connection update [--add]
                                 [--enable-bgp {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--express-route-gateway-bypass {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--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}]
                                 [--remove]
                                 [--resource-group]
                                 [--routing-weight]
                                 [--set]
                                 [--shared-key]
                                 [--subscription]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {0, 1, f, false, n, no, t, true, y, yes}]

例

既存の接続に BGP を追加します。

az network vpn-connection update -g MyResourceGroup -n MyConnection --enable-bgp True

VPN 接続を更新します。

az network vpn-connection update --name MyConnection --resource-group MyResourceGroup --use-policy-based-traffic-selectors true

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

プロパティ	値
Parameter group:	Generic Update Arguments

--enable-bgp

BGP (ボーダーゲートウェイプロトコル) を有効にします。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--express-route-gateway-bypass

データ転送のために ExpressRoute ゲートウェイをバイパスします。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--force-string

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

プロパティ	値
Parameter group:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--ids

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

Connection name.

プロパティ	値
Parameter group:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--remove

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

プロパティ	値
Parameter group:	Generic Update Arguments

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--routing-weight

接続ルーティングの重み。

--set

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

プロパティ	値
Parameter group:	Generic Update Arguments

--shared-key

共有 IPSec キー。

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

--tags

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

--use-policy-based-traffic-selectors

ポリシーベースのトラフィックセレクターを有効にします。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az network vpn-connection wait

編集

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

az network vpn-connection wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

リソースが存在するまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--ids

プロパティ	値
Parameter group:	Resource Id Arguments

--interval

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--name -n

Connection name.

プロパティ	値
Parameter group:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

--timeout

最大待機時間 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

az network vpn-connection

コマンド

az network vpn-connection create

例

必須のパラメーター

省略可能のパラメーター

az network vpn-connection delete

例

省略可能のパラメーター

az network vpn-connection list

例

必須のパラメーター

省略可能のパラメーター

az network vpn-connection list-ike-sas

例

省略可能のパラメーター

az network vpn-connection show

例

省略可能のパラメーター

az network vpn-connection show-device-config-script

例

必須のパラメーター

省略可能のパラメーター

az network vpn-connection update

例

省略可能のパラメーター

az network vpn-connection wait

省略可能のパラメーター

フィードバック