你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
az network vpn-gateway
注意
此参考是 Azure CLI（版本 2.55.0 或更高版本）的虚拟 wan 扩展的一部分。 该扩展将在首次运行 az network vpn-gateway 命令时自动安装。 详细了解扩展。
管理站点到站点 VPN 网关。
命令
az network vpn-gateway create
创建站点到站点 VPN 网关。
az network vpn-gateway create --name
--resource-group
[--asn]
[--bgp-peering-address]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--peer-weight]
[--scale-unit]
[--tags]
[--vhub]示例
创建站点到站点 VPN 网关。
az network vpn-gateway create -n MyVPNGateway -g MyRG --vhub MyVHub -l westus必需参数
VPN 网关的名称。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
可选参数
BGP 扬声器的 ASN。
此 BGP 扬声器的对等互连地址和 BGP 标识符。
Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。 如果未指定，将使用资源组的位置。
不等待长时间运行的操作完成。
添加到从此 BGP 扬声器中学习的路由的权重。
此 VPN 网关的缩放单元。
空格分隔标记：key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。
虚拟中心的名称或 ID。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network vpn-gateway delete
删除站点到站点 VPN 网关。
az network vpn-gateway delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]示例
删除站点到站点 VPN 网关。
az network vpn-gateway delete -n MyVPNGateway -g MyRG可选参数
一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
VPN 网关的名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network vpn-gateway list
列出站点到站点 VPN 网关。
az network vpn-gateway list [--resource-group]示例
列出站点到站点 VPN 网关。
az network vpn-gateway list -g MyRG可选参数
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network vpn-gateway show
获取站点到站点 VPN 网关的详细信息。
az network vpn-gateway show [--ids]
[--name]
[--resource-group]
[--subscription]示例
获取站点到站点 VPN 网关的详细信息。
az network vpn-gateway show -n MyVPNGateway -g MyRG可选参数
一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
VPN 网关的名称。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network vpn-gateway update
更新站点到站点 VPN 网关的设置。
az network vpn-gateway update [--add]
[--asn]
[--bgp-peering-address]
[--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}]
[--peer-weight]
[--remove]
[--resource-group]
[--scale-unit]
[--set]
[--subscription]
[--tags]
[--vhub]示例
更新站点到站点 VPN 网关的设置。
az network vpn-gateway create -g MyRG --vhub MyVHub --name MyVPNGateway --tags foo=bar可选参数
通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value、string 或 JSON 字符串>。
BGP 扬声器的 ASN。
此 BGP 扬声器的对等互连地址和 BGP 标识符。
使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。
一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
VPN 网关的名称。
不等待长时间运行的操作完成。
添加到从此 BGP 扬声器中学习的路由的权重。
从列表中删除属性或元素。 示例：--remove property.list OR --remove propertyToRemove。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
此 VPN 网关的缩放单元。
通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
空格分隔标记：key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。
虚拟中心的名称或 ID。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network vpn-gateway wait
将 CLI 置于等待状态，直到满足条件。
az network vpn-gateway wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]可选参数
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。
等到删除为止。
等待资源存在。
一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
轮询间隔（以秒为单位）。
VPN 网关的名称。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
最大等待（以秒为单位）。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
