az network p2s-vpn-gateway

リファレンス

Note

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

ポイント対サイト VPN ゲートウェイを管理します。

コマンド

名前	説明	型	状態
az network p2s-vpn-gateway connection	ポイント対サイト VPN ゲートウェイ接続を管理します。	拡張子	プレビュー
az network p2s-vpn-gateway connection list	特定のポイント対サイト VPN ゲートウェイのすべての接続を一覧表示します。	拡張子	プレビュー
az network p2s-vpn-gateway connection show	ポイント対サイト VPN ゲートウェイ接続の詳細を表示します。	拡張子	プレビュー
az network p2s-vpn-gateway create	ポイント対サイト VPN ゲートウェイを作成します。	拡張子	GA
az network p2s-vpn-gateway delete	ポイント対サイト VPN ゲートウェイを削除します。	拡張子	GA
az network p2s-vpn-gateway disconnect	指定されたリソースグループ内の仮想 WAN P2SVpnGateway の P2S vpn 接続を切断します。	拡張子	GA
az network p2s-vpn-gateway list	すべてのポイント対サイト VPN ゲートウェイを一覧表示します。	拡張子	GA
az network p2s-vpn-gateway reset	指定したリソースグループ内の p2s VPN ゲートウェイのプライマリをリセットします。	拡張子	GA
az network p2s-vpn-gateway show	ポイント対サイト VPN ゲートウェイの詳細を表示します。	拡張子	GA
az network p2s-vpn-gateway update	ポイント対サイト VPN ゲートウェイの設定を更新します。	拡張子	GA
az network p2s-vpn-gateway vpn-client	ポイント対サイト経由で Azure に接続するために必要な VPN クライアント構成をダウンロードします。	拡張子	GA
az network p2s-vpn-gateway vpn-client generate	指定したリソースグループ内の P2SVpnGateway の P2S クライアントの VPN プロファイルを生成します。	拡張子	GA
az network p2s-vpn-gateway wait	ポイント対サイト VPN ゲートウェイの条件が満たされるまで、CLI を待機状態にします。	拡張子	GA

az network p2s-vpn-gateway create

ポイント対サイト VPN ゲートウェイを作成します。

az network p2s-vpn-gateway create --name
                                  --resource-group
                                  --scale-unit
                                  --vhub
                                  [--address-space]
                                  [--associated]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--config-name]
                                  [--labels]
                                  [--location]
                                  [--no-wait]
                                  [--propagated]
                                  [--tags]
                                  [--vpn-server-config]

例

ポイント対サイト VPN ゲートウェイを作成します。

az network p2s-vpn-gateway create -g MyRG -n MyP2SVPNGateway --scale-unit 2 --vhub MyVhub --vpn-server-config MyVPNServerConfig --address-space 10.0.0.0/24 11.0.0.0/24

ルーティング構成を使用してポイント対サイト VPN ゲートウェイを作成します。

az network p2s-vpn-gateway create -g MyRG -n MyP2SVPNGateway --scale-unit 2 --vhub MyVhub --vpn-server-config MyVPNServerConfig --address-space 10.0.0.0/24 11.0.0.0/24 --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

必須のパラメーター

--name -n

P2S Vpn Gateway の名前。

--resource-group -g

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

--scale-unit

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

--vhub

仮想ハブの名前または ID。

省略可能のパラメーター

--address-space

P2S VpnClient のアドレス空間。 IP アドレス範囲のスペース区切りの一覧。

--associated --associated-route-table

プレビュー

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

--associated-inbound-routemap

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

--associated-outbound-routemap

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

--config-name

名前または p2s 接続の構成。

規定値: P2SConnectionConfigDefault

--labels

プレビュー

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

--location -l

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

--no-wait

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

規定値: False

--propagated --propagated-route-tables

プレビュー

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

--tags

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

--vpn-server-config

VPN サーバー構成の名前または 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 p2s-vpn-gateway delete

ポイント対サイト VPN ゲートウェイを削除します。

az network p2s-vpn-gateway delete --name
                                  --resource-group
                                  [--yes]

必須のパラメーター

--name -n

P2S Vpn Gateway の名前。

--resource-group -g

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

省略可能のパラメーター

--yes -y

確認のダイアログを表示しません。

規定値: 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 p2s-vpn-gateway disconnect

指定されたリソースグループ内の仮想 WAN P2SVpnGateway の P2S vpn 接続を切断します。

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

例

P2S VPN 接続を切断します。

az network p2s-vpn-gateway disconnect -g MyResourceGroup -n MyP2sGateway --vpn-connection-ids "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/p2sVpnGateways/MyP2sGateway/p2sConnectionConfigurations/P2SConnectionConfigDefault"

省略可能のパラメーター

--ids

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

--name -n

P2S Vpn Gateway の名前。

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

--vpn-connection-ids

p2s vpn 接続 ID の一覧。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

グローバルパラメーター

--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 p2s-vpn-gateway list

すべてのポイント対サイト VPN ゲートウェイを一覧表示します。

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

省略可能のパラメーター

--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 p2s-vpn-gateway reset

指定したリソースグループ内の p2s VPN ゲートウェイのプライマリをリセットします。

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

例

p2s VPN ゲートウェイのプライマリをリセットします。

az network p2s-vpn-gateway reset -g MyResourceGroup -n MyP2sGateway

省略可能のパラメーター

--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 p2s-vpn-gateway show

ポイント対サイト VPN ゲートウェイの詳細を表示します。

az network p2s-vpn-gateway show --name
                                --resource-group

必須のパラメーター

--name -n

P2S Vpn Gateway の名前。

--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 p2s-vpn-gateway update

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

az network p2s-vpn-gateway update --name
                                  --resource-group
                                  [--add]
                                  [--address-space]
                                  [--associated]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--config-name]
                                  [--force-string]
                                  [--labels]
                                  [--no-wait]
                                  [--propagated]
                                  [--remove]
                                  [--scale-unit]
                                  [--set]
                                  [--tags]
                                  [--vpn-server-config]

例

ルーティング構成の下で、伝達されたルートテーブルのラベルを追加します。

az network p2s-vpn-gateway update -g MyRG -n MyP2SVPNGateway --labels Newlabel1 Newlabel2 Newlabel3

必須のパラメーター

--name -n

P2S Vpn Gateway の名前。

--resource-group -g

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

省略可能のパラメーター

--add

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

規定値: []

--address-space

P2S VpnClient のアドレス空間。 IP アドレス範囲のスペース区切りの一覧。

--associated --associated-route-table

プレビュー

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

--associated-inbound-routemap

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

--associated-outbound-routemap

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

--config-name

名前または p2s 接続の構成。

--force-string

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

規定値: False

--labels

プレビュー

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

--no-wait

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

規定値: False

--propagated --propagated-route-tables

プレビュー

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

--remove

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

規定値: []

--scale-unit

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

--set

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

規定値: []

--tags

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

--vpn-server-config

VPN サーバー構成の名前または 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 p2s-vpn-gateway wait

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

az network p2s-vpn-gateway wait --name
                                --resource-group
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--interval]
                                [--timeout]
                                [--updated]

必須のパラメーター

--name -n

P2S Vpn Gateway の名前。

--resource-group -g

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

省略可能のパラメーター

--created

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

規定値: False

--custom

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

--deleted

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

規定値: False

--exists

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

規定値: False

--interval

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

規定値: 30

--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 p2s-vpn-gateway

コマンド

az network p2s-vpn-gateway create

例

必須のパラメーター

省略可能のパラメーター

az network p2s-vpn-gateway delete

必須のパラメーター

省略可能のパラメーター

az network p2s-vpn-gateway disconnect

例

省略可能のパラメーター

az network p2s-vpn-gateway list

省略可能のパラメーター

az network p2s-vpn-gateway reset

例

省略可能のパラメーター

az network p2s-vpn-gateway show

必須のパラメーター

az network p2s-vpn-gateway update

例

必須のパラメーター

省略可能のパラメーター

az network p2s-vpn-gateway wait

必須のパラメーター

省略可能のパラメーター

その他のリソース