az network vpn-connection

リファレンス

VPN 接続を管理します。

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

コマンド

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

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 接続を作成します。 (自動生成)

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

必須のパラメーター

--name -n

接続名。

--resource-group -g

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

--vnet-gateway1

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

省略可能のパラメーター

--authorization-key

VPN 接続の承認キー。

--egress-nat-rule

プレビュー

エグレス NatRules の一覧。

--enable-bgp

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

規定値: False

--express-route-circuit2

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

--express-route-gateway-bypass

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

指定可能な値: false, true

--ingress-nat-rule

プレビュー

イングレス NatRules の一覧。

--local-gateway2

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

--location -l

場所。値のソース: 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, true

規定値: False

--validate

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

規定値: False

--vnet-gateway2

"Vnet2Vnet" 接続を使用して接続する宛先仮想ネットワークゲートウェイの名前または 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-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

省略可能のパラメーター

--ids

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

--name -n

接続名。

--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-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> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--vnet-gateway

VNet ゲートウェイの名前。

グローバルパラメーター

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

省略可能のパラメーター

--ids

--name -n

接続名。

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

編集

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

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

例

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

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

省略可能のパラメーター

--ids

--name -n

接続名。

--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-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 デバイスのベンダー。

省略可能のパラメーター

--ids

--name -n

接続名。

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

省略可能のパラメーター

--add

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

--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 に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

--name -n

接続名。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--remove

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

--resource-group -g

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

--routing-weight

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

--set

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

--shared-key

共有 IPSec キー。

--subscription

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

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

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

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

編集

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

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

--interval

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

規定値: 30

--name -n

接続名。

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

省略可能のパラメーター

その他のリソース