你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az network vpn-site

参考

注意

此参考是 Azure CLI（版本 2.55.0 或更高版本）的虚拟 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	提供 SAS URL 以下载 VPN 站点的配置。	扩展	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

一个或多个资源 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

提供 SAS URL 以下载 VPN 站点的配置。

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

必需参数

--request

提供用于下载 vpn 站点配置的参数。是模型类型或 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

一个或多个资源 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

一个或多个资源 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 获取完整的调试日志。

通过

az network vpn-site

命令

az network vpn-site create

必需参数

可选参数

az network vpn-site delete

可选参数

az network vpn-site download

必需参数

az network vpn-site list

可选参数

az network vpn-site show

可选参数

az network vpn-site update

可选参数

其他资源