az network vnet-gateway

リファレンス

Azure Virtual Network ゲートウェイを使用して、安全なクロスプレミス接続を確立します。

Azure Virtual Network ゲートウェイの詳細については、次を参照してください https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli。

コマンド

名前	説明	型	状態
az network vnet-gateway aad	仮想ネットワークゲートウェイの AAD (Azure Active Directory) 認証を管理します。	コア	GA
az network vnet-gateway aad assign	AAD (Azure Active Directory) 認証を仮想ネットワークゲートウェイに割り当てる/更新します。	コア	GA
az network vnet-gateway aad remove	仮想ネットワークゲートウェイから AAD (Azure Active Directory) 認証を削除します。	コア	GA
az network vnet-gateway aad show	仮想ネットワークゲートウェイの AAD (Azure Active Directory) 認証を表示します。	コア	GA
az network vnet-gateway aad wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network vnet-gateway create	仮想ネットワークゲートウェイを作成します。	コア	GA
az network vnet-gateway delete	仮想ネットワークゲートウェイを削除します。	コア	GA
az network vnet-gateway disconnect-vpn-connections	仮想ネットワークゲートウェイの VPN 接続を切断します。	コア	プレビュー
az network vnet-gateway ipsec-policy	仮想ネットワークゲートウェイの IPSec ポリシーを管理します。	コア	GA
az network vnet-gateway ipsec-policy add	仮想ネットワークゲートウェイの IPSec ポリシーを追加します。	コア	GA
az network vnet-gateway ipsec-policy clear	仮想ネットワークゲートウェイ上のすべての IPsec ポリシーを削除します。	コア	GA
az network vnet-gateway ipsec-policy list	仮想ネットワークゲートウェイに関連付けられている IPSec ポリシーを一覧表示します。	コア	GA
az network vnet-gateway ipsec-policy wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network vnet-gateway list	仮想ネットワークゲートウェイを一覧表示します。	コア	GA
az network vnet-gateway list-advertised-routes	指定したピアにアドバタイズされた仮想ネットワークゲートウェイのルートを一覧表示します。	コア	GA
az network vnet-gateway list-bgp-peer-status	BGP ピアの状態を取得します。	コア	GA
az network vnet-gateway list-learned-routes	この操作では、BGP ピアから学習されたルートなど、仮想ネットワークゲートウェイが学習したルートの一覧を取得します。	コア	GA
az network vnet-gateway nat-rule	仮想ネットワークゲートウェイで nat 規則を管理します。	コア	GA
az network vnet-gateway nat-rule add	仮想ネットワークゲートウェイに nat 規則を追加します。	コア	プレビュー
az network vnet-gateway nat-rule list	仮想ネットワークゲートウェイの nat 規則を一覧表示します。	コア	プレビュー
az network vnet-gateway nat-rule remove	仮想ネットワークゲートウェイから nat 規則を削除します。	コア	プレビュー
az network vnet-gateway nat-rule wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network vnet-gateway packet-capture	仮想ネットワークゲートウェイでパケットキャプチャを管理します。	コア	GA
az network vnet-gateway packet-capture start	仮想ネットワークゲートウェイでパケットキャプチャを開始します。	コア	プレビュー
az network vnet-gateway packet-capture stop	仮想ネットワークゲートウェイでのパケットキャプチャを停止します。	コア	プレビュー
az network vnet-gateway packet-capture wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network vnet-gateway reset	仮想ネットワークゲートウェイをリセットします。	コア	GA
az network vnet-gateway revoked-cert	仮想ネットワークゲートウェイで失効した証明書を管理します。この証明書を使用しているマシンがこのゲートウェイを介して Azure にアクセスできないようにします。	コア	GA
az network vnet-gateway revoked-cert create	証明書を失効させます。	コア	GA
az network vnet-gateway revoked-cert delete	失効した証明書を削除します。	コア	GA
az network vnet-gateway revoked-cert wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network vnet-gateway root-cert	仮想ネットワークゲートウェイのルート証明書を管理します。	コア	GA
az network vnet-gateway root-cert create	ルート証明書をアップロードします。	コア	GA
az network vnet-gateway root-cert delete	ルート証明書を削除します。	コア	GA
az network vnet-gateway root-cert wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network vnet-gateway show	仮想ネットワークゲートウェイの詳細を取得します。	コア	GA
az network vnet-gateway show-supported-devices	サポートされている VPN デバイスの XML 形式表現を取得します。	コア	プレビュー
az network vnet-gateway update	仮想ネットワークゲートウェイを更新します。	コア	GA
az network vnet-gateway vpn-client	ポイント対サイト経由で Azure に接続するために必要な VPN クライアント構成をダウンロードします。	コア	GA
az network vnet-gateway vpn-client generate	VPN クライアント構成を生成します。	コア	GA
az network vnet-gateway vpn-client ipsec-policy	仮想ネットワークゲートウェイの P2S クライアント接続の VPN クライアント接続 ipsec-policy を管理します。	コア	GA
az network vnet-gateway vpn-client ipsec-policy set	仮想ネットワークゲートウェイの P2S クライアント接続ごとに VPN クライアント接続 ipsec ポリシーを設定します。	コア	プレビュー
az network vnet-gateway vpn-client ipsec-policy show	仮想ネットワークゲートウェイの P2S クライアント接続ごとの VPN クライアント接続 ipsec ポリシーを取得します。	コア	プレビュー
az network vnet-gateway vpn-client ipsec-policy wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network vnet-gateway vpn-client show-health	仮想ネットワークゲートウェイの P2S クライアント接続ごとの VPN クライアント接続の正常性の詳細を取得します。	コア	プレビュー
az network vnet-gateway vpn-client show-url	事前に生成された VPN クライアント構成を取得します。	コア	GA
az network vnet-gateway wait	条件が満たされるまで CLI を待機状態にします。	コア	GA

az network vnet-gateway create

編集

仮想ネットワークゲートウェイを作成します。

az network vnet-gateway create --name
                               --resource-group
                               --vnet
                               [--aad-audience]
                               [--aad-issuer]
                               [--aad-tenant]
                               [--address-prefix]
                               [--allow-remote-vnet-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--allow-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--asn]
                               [--bgp-peering-address]
                               [--client-protocol]
                               [--custom-routes]
                               [--edge-zone]
                               [--edge-zone-vnet-id]
                               [--enable-private-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--gateway-default-site]
                               [--gateway-type {ExpressRoute, LocalGateway, Vpn}]
                               [--location]
                               [--max-scale-unit]
                               [--min-scale-unit]
                               [--nat-rule]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-weight]
                               [--public-ip-address]
                               [--radius-secret]
                               [--radius-server]
                               [--root-cert-data]
                               [--root-cert-name]
                               [--sku {Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ}]
                               [--tags]
                               [--vpn-auth-type]
                               [--vpn-gateway-generation {Generation1, Generation2, None}]
                               [--vpn-type {PolicyBased, RouteBased}]

例

サイト間接続用の基本的な仮想ネットワークゲートウェイを作成します。

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --no-wait

RADIUS サーバーで構成されているものと一致する RADIUS シークレットを使用してポイント対サイト接続を提供する基本的な仮想ネットワークゲートウェイを作成します。

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 SSTP --radius-secret 111_aaa --radius-server 30.1.1.15 --vpn-gateway-generation Generation1

マルチ認証を使用して基本的な仮想ネットワークゲートウェイを作成する

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --address-prefixes 40.1.0.0/24 --client-protocol OpenVPN --radius-secret 111_aaa --radius-server 30.1.1.15 --aad-issuer https://sts.windows.net/00000-000000-00000-0000-000/ --aad-tenant https://login.microsoftonline.com/000 --aad-audience 0000-000 --root-cert-name root-cert --root-cert-data "root-cert.cer" --vpn-auth-type AAD Certificate Radius

仮想ネットワークゲートウェイを作成します。

az network vnet-gateway create --gateway-type Vpn --location westus2 --name MyVnetGateway --no-wait --public-ip-addresses myVGPublicIPAddress --resource-group MyResourceGroup --sku Basic --vnet MyVnet --vpn-type PolicyBased

必須のパラメーター

--name -n

VNet ゲートウェイの名前。

--resource-group -g

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

--vnet

"GatewaySubnet" という名前のサブネットを持つ既存の仮想ネットワークの名前または ID。

省略可能のパラメーター

--aad-audience

VirtualNetworkGateway の AADAudience ID。

--aad-issuer

VirtualNetworkGateway の AAD 発行者 URI。

--aad-tenant

VirtualNetworkGateway の AAD テナント URI。

--address-prefix --address-prefixes

P2S Vpnclient のアドレス空間を表す CIDR プレフィックスのスペース区切りリスト。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。単数形フラグ: --address-prefix.

--allow-remote-vnet-traffic

他の Azure 仮想ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。この構成では、Azure Virtual WAN への接続はサポートされていません。

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

--allow-vwan-traffic

リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。

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

--asn

BGP 設定に使用する自律システム番号。

--bgp-peering-address

BGP ピアリングに使用する IP アドレス。

--client-protocol

接続に使用するプロトコル。使用できる値: IkeV2、OpenVPN、SSTP。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--custom-routes

VpnClient 用に顧客によって指定されたカスタムルートアドレス空間を表す CIDR プレフィックスのスペース区切りのリスト。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--edge-zone

エッジゾーンの名前。

--edge-zone-vnet-id

ローカルゲートウェイの拡張 vnet リソース ID。

--enable-private-ip

接続のためにこのゲートウェイでプライベート IP を有効にする必要があるかどうか。

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

--gateway-default-site

既定のルートを持つローカルネットワークサイトを表すローカルネットワークゲートウェイの名前または ID。

--gateway-type

ゲートウェイの種類。

指定可能な値: ExpressRoute, LocalGateway, Vpn

規定値: Vpn

--location -l

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

--max-scale-unit

自動スケール構成の最大スケールユニット数。

--min-scale-unit

自動スケール構成の最小スケールユニット。

--nat-rule --nat-rules

VirtualNetworkGatewayNatRule リソース。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。単数形フラグ: --nat-rule.

--no-wait

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

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

--peer-weight

BGP ピアリングを通じて学習されたルートに加えられた重み (0 から 100)。

--public-ip-address --public-ip-addresses

アクティブ/スタンバイゲートウェイの 1 つのパブリック IP (名前または ID) を指定します。アクティブ/アクティブゲートウェイに 2 つのスペース区切りのパブリック IP を指定します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--radius-secret

認証に使用する Radius シークレット。

--radius-server

接続先の Radius サーバーアドレス。

--root-cert-data

ルート証明書ファイルまたはファイルパスの Base64 コンテンツ。

--root-cert-name

ルート証明書名。

--sku

VNet ゲートウェイ SKU。

指定可能な値: Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ

規定値: Basic

--tags

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

--vpn-auth-type

仮想ネットワークゲートウェイに対して有効になっている VPN 認証の種類。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--vpn-gateway-generation

仮想ネットワークゲートウェイの世代。 gateway_typeが Vpn でない場合は、vpn_gateway_generationを指定しないでください。

指定可能な値: Generation1, Generation2, None

--vpn-type

VPN ルーティングの種類。

指定可能な値: PolicyBased, RouteBased

規定値: RouteBased

グローバルパラメーター

--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 vnet-gateway delete

編集

仮想ネットワークゲートウェイを削除します。

仮想ネットワークゲートウェイを削除するには、まず、ゲートウェイに接続されている Azure 内のすべての接続オブジェクトを削除する必要があります。ゲートウェイを削除した後、使用されていない他のリソースの削除に進みます。詳細については、このページ https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-delete-vnet-gateway-portalの指示の順序に従ってください。

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

例

仮想ネットワークゲートウェイを削除します。

az network vnet-gateway delete -g MyResourceGroup -n MyVnetGateway

省略可能のパラメーター

--ids

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

--name -n

VNet ゲートウェイの名前。

--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 vnet-gateway disconnect-vpn-connections

編集

プレビュー

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

仮想ネットワークゲートウェイの VPN 接続を切断します。

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

例

仮想ネットワークゲートウェイの VPN 接続を切断します。

az network vnet-gateway disconnect-vpn-connections -g MyResourceGroup -n MyVnetGateway --vpn-connections MyConnetion1ByName MyConnection2ByID

省略可能のパラメーター

--ids

--name -n

VNet ゲートウェイの名前。

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

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 vnet-gateway list

編集

仮想ネットワークゲートウェイを一覧表示します。

az network vnet-gateway list --resource-group
                             [--max-items]
                             [--next-token]

例

リソースグループ内の仮想ネットワークゲートウェイを一覧表示します。

az network vnet-gateway list -g MyResourceGroup

必須のパラメーター

--resource-group -g

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

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。これは、以前に切り捨てられた応答からのトークン値です。

グローバルパラメーター

--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 vnet-gateway list-advertised-routes

編集

指定したピアにアドバタイズされた仮想ネットワークゲートウェイのルートを一覧表示します。

az network vnet-gateway list-advertised-routes --peer
                                               [--ids]
                                               [--name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

例

指定したピアにアドバタイズされた仮想ネットワークゲートウェイのルートを一覧表示します。

az network vnet-gateway list-advertised-routes -g MyResourceGroup -n MyVnetGateway --peer 23.10.10.9

必須のパラメーター

--peer

ピアの IP アドレス。

省略可能のパラメーター

--ids

--name -n

VNet ゲートウェイの名前。

--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 vnet-gateway list-bgp-peer-status

編集

BGP ピアの状態を取得します。

az network vnet-gateway list-bgp-peer-status [--ids]
                                             [--name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--peer]
                                             [--resource-group]
                                             [--subscription]

例

BGP ピアの状態を取得します。

az network vnet-gateway list-bgp-peer-status -g MyResourceGroup -n MyVnetGateway --peer 23.10.10.9

省略可能のパラメーター

--ids

--name -n

VNet ゲートウェイの名前。

--no-wait

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

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

--peer

状態を取得するピアの IP アドレス。既定値は None です。

--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 vnet-gateway list-learned-routes

編集

この操作では、BGP ピアから学習されたルートなど、仮想ネットワークゲートウェイが学習したルートの一覧を取得します。

az network vnet-gateway list-learned-routes [--ids]
                                            [--name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]

例

学習したルートの一覧を取得します。

az network vnet-gateway list-learned-routes -g MyResourceGroup -n MyVnetGateway

省略可能のパラメーター

--ids

--name -n

VNet ゲートウェイの名前。

--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 vnet-gateway reset

編集

仮想ネットワークゲートウェイをリセットします。

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

例

仮想ネットワークゲートウェイをリセットします。

az network vnet-gateway reset -g MyResourceGroup -n MyVnetGateway

アクティブ/アクティブ機能が有効になっている仮想ネットワークゲートウェイをリセットします。

az network vnet-gateway reset -g MyResourceGroup -n MyVnetGateway --gateway-vip MyGatewayIP

省略可能のパラメーター

--gateway-vip

アクティブ/アクティブ機能が有効なゲートウェイのリセット開始に指定された仮想ネットワークゲートウェイ vip アドレス。

規定値: None

--ids

--name -n

VNet ゲートウェイの名前。

--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 vnet-gateway show

編集

仮想ネットワークゲートウェイの詳細を取得します。

az network vnet-gateway show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

例

仮想ネットワークゲートウェイの詳細を取得します。

az network vnet-gateway show -g MyResourceGroup -n MyVnetGateway

省略可能のパラメーター

--ids

--name -n

VNet ゲートウェイの名前。

--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 vnet-gateway show-supported-devices

編集

プレビュー

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

サポートされている VPN デバイスの XML 形式表現を取得します。

az network vnet-gateway show-supported-devices [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]

例

サポートされている VPN デバイスの XML 形式表現を取得します。

az network vnet-gateway show-supported-devices -g MyResourceGroup -n MyVnetGateway

省略可能のパラメーター

--ids

--name -n

VNet ゲートウェイの名前。

--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 vnet-gateway update

編集

仮想ネットワークゲートウェイを更新します。

az network vnet-gateway update [--aad-audience]
                               [--aad-issuer]
                               [--aad-tenant]
                               [--add]
                               [--address-prefix]
                               [--allow-remote-vnet-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--allow-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--asn]
                               [--bgp-peering-address]
                               [--client-protocol]
                               [--custom-routes]
                               [--enable-bgp {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enable-private-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--gateway-default-site]
                               [--gateway-type {ExpressRoute, LocalGateway, Vpn}]
                               [--ids]
                               [--max-scale-unit]
                               [--min-scale-unit]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-weight]
                               [--public-ip-address]
                               [--radius-secret]
                               [--radius-server]
                               [--remove]
                               [--resource-group]
                               [--root-cert-data]
                               [--root-cert-name]
                               [--set]
                               [--sku {Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ}]
                               [--subscription]
                               [--tags]
                               [--vnet]
                               [--vpn-auth-type]
                               [--vpn-type {PolicyBased, RouteBased}]

例

仮想ネットワークゲートウェイの SKU を変更します。

az network vnet-gateway update -g MyResourceGroup -n MyVnetGateway --sku VpnGw2

仮想ネットワークゲートウェイを更新します。

az network vnet-gateway update --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 --name MyVnetGateway --resource-group MyResourceGroup

省略可能のパラメーター

--aad-audience

VirtualNetworkGateway の AADAudience ID。

--aad-issuer

VirtualNetworkGateway の AAD 発行者 URI。

--aad-tenant

VirtualNetworkGateway の AAD テナント URI。

--add

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

--address-prefix --address-prefixes

--allow-remote-vnet-traffic

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

--allow-vwan-traffic

リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。

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

--asn

BGP 設定に使用する自律システム番号。

--bgp-peering-address

BGP ピアリングに使用する IP アドレス。

--client-protocol

--custom-routes

--enable-bgp

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

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

--enable-private-ip

接続のためにこのゲートウェイでプライベート IP を有効にする必要があるかどうか。

指定可能な値: 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

--gateway-default-site

既定のルートを持つローカルネットワークサイトを表すローカルネットワークゲートウェイの名前または ID。

--gateway-type

ゲートウェイの種類。

指定可能な値: ExpressRoute, LocalGateway, Vpn

--ids

--max-scale-unit

自動スケール構成の最大スケールユニット数。

--min-scale-unit

自動スケール構成の最小スケールユニット。

--name -n

VNet ゲートウェイの名前。

--no-wait

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

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

--peer-weight

BGP ピアリングを通じて学習されたルートに加えられた重み (0 から 100)。

--public-ip-address --public-ip-addresses

--radius-secret

認証に使用する Radius シークレット。

--radius-server

接続先の Radius サーバーアドレス。

--remove

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

--resource-group -g

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

--root-cert-data

ルート証明書ファイルまたはファイルパスの Base64 コンテンツ。

--root-cert-name

ルート証明書名。

--set

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

--sku

VNet ゲートウェイ SKU。

指定可能な値: Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ

--subscription

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

--tags

--vnet

"GatewaySubnet" という名前のサブネットを持つ既存の仮想ネットワークの名前または ID。

--vpn-auth-type

--vpn-type

VPN ルーティングの種類。

指定可能な値: PolicyBased, RouteBased

グローバルパラメーター

--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 vnet-gateway wait

編集

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

az network vnet-gateway 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

VNet ゲートウェイの名前。

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

コマンド

az network vnet-gateway create

例

必須のパラメーター

省略可能のパラメーター

az network vnet-gateway delete

例

省略可能のパラメーター

az network vnet-gateway disconnect-vpn-connections

例

省略可能のパラメーター

az network vnet-gateway list

例

必須のパラメーター

省略可能のパラメーター

az network vnet-gateway list-advertised-routes

例

必須のパラメーター

省略可能のパラメーター

az network vnet-gateway list-bgp-peer-status

例

省略可能のパラメーター

az network vnet-gateway list-learned-routes

例

省略可能のパラメーター

az network vnet-gateway reset

例

省略可能のパラメーター

az network vnet-gateway show

例

省略可能のパラメーター

az network vnet-gateway show-supported-devices

例

省略可能のパラメーター

az network vnet-gateway update

例

省略可能のパラメーター

az network vnet-gateway wait

省略可能のパラメーター

その他のリソース