az network vpn-site

Note

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

VPN サイト構成を管理します。

コマンド

名前	説明	型	Status
az network vpn-site create	VPN サイト構成を作成します。	拡張子	GA
az network vpn-site delete	VPN サイト構成を削除します。	拡張子	GA
az network vpn-site download	VPN サイトの構成をダウンロードするための SAS URL を指定します。	拡張子	GA
az network vpn-site link	VPN サイト のリンクを管理します。	拡張子	GA
az network vpn-site link add	VPN サイトの構成に VPN サイト リンクを追加します。	拡張子	GA
az network vpn-site link list	VPN サイト構成の VPN サイト リンクを一覧表示します。	拡張子	GA
az network vpn-site link remove	VPN サイト構成から VPN サイト リンクを削除します。	拡張子	GA
az network vpn-site list	VPN サイトの構成を一覧表示します。	拡張子	GA
az network vpn-site show	VPN サイト構成の詳細を取得します。	拡張子	GA
az network vpn-site update	VPN サイト構成の設定を更新します。	拡張子	GA

az network vpn-site create

VPN サイト構成を作成します。

az network vpn-site create --ip-address
                           --name
                           --resource-group
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--device-model]
                           [--device-vendor]
                           [--link-speed]
                           [--location]
                           [--no-wait]
                           [--peer-weight]
                           [--security-site {false, true}]
                           [--site-key]
                           [--tags]
                           [--virtual-wan]
                           [--with-link {false, true}]

必須のパラメーター

--ip-address

VPN サイトの IP アドレス。

--name -n

VPN サイト構成の名前。

--resource-group -g

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

省略可能のパラメーター

--address-prefixes

CIDR アドレス プレフィックスのスペース区切りの一覧。

--asn

BGP スピーカーの ASN。

--bgp-peering-address

この BGP スピーカーのピアリング アドレスと BGP 識別子。

--device-model

デバイスのモデル。

--device-vendor

デバイス ベンダーの名前。

--link-speed

リンク速度 (Mbps)。

--location -l

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

--no-wait

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

既定値: False

--peer-weight

この BGP スピーカーから学習したルートに追加された重み。

--security-site

VPN サイトがセキュリティに関連しているかどうか。

承認された値: false, true

--site-key

接続に使用できる VPN サイトのキー。

--tags

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

--virtual-wan

仮想 WAN の名前または ID。

--with-link

既定のリンクを使用して VPN サイトを作成します。

承認された値: 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-site delete

VPN サイト構成を削除します。

az network vpn-site delete [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

省略可能のパラメーター

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

VPN サイトの構成をダウンロードするための SAS URL を指定します。

az network vpn-site download --request
                             --resource-group
                             --vwan-name

必須のパラメーター

--request

vpn-sites 構成をダウンロードするために指定されたパラメーター。 モデル型または IO 型のいずれかです。 必須。

--resource-group -g

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

--vwan-name

仮想 WAN の名前。

グローバル パラメーター

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

VPN サイトの構成を一覧表示します。

az network vpn-site 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 vpn-site show

VPN サイト構成の詳細を取得します。

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

省略可能のパラメーター

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

VPN サイト構成の設定を更新します。

az network vpn-site update [--add]
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--device-model]
                           [--device-vendor]
                           [--force-string]
                           [--ids]
                           [--ip-address]
                           [--link-speed]
                           [--name]
                           [--no-wait]
                           [--peer-weight]
                           [--remove]
                           [--resource-group]
                           [--security-site {false, true}]
                           [--set]
                           [--site-key]
                           [--subscription]
                           [--tags]
                           [--virtual-wan]

省略可能のパラメーター

--add

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

既定値: []

--address-prefixes

CIDR アドレス プレフィックスのスペース区切りの一覧。

--asn

BGP スピーカーの ASN。

--bgp-peering-address

この BGP スピーカーのピアリング アドレスと BGP 識別子。

--device-model

デバイスのモデル。

--device-vendor

デバイス ベンダーの名前。

--force-string

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

既定値: False

--ids

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

--ip-address

VPN サイトの IP アドレス。

--link-speed

リンク速度 (Mbps)。

--name -n

VPN サイト構成の名前。

--no-wait

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

既定値: False

--peer-weight

この BGP スピーカーから学習したルートに追加された重み。

--remove

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

既定値: []

--resource-group -g

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

--security-site

VPN サイトがセキュリティに関連しているかどうか。

承認された値: false, true

--set

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

既定値: []

--site-key

接続に使用できる VPN サイトのキー。

--subscription

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

--tags

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

--virtual-wan

仮想 WAN の名前または 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 を使います。