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

az network vpn-gateway connection

注意

此参考是 Azure CLI（版本 2.55.0 或更高版本）的虚拟 wan 扩展的一部分。 该扩展将在首次运行 az network vpn-gateway connection 命令时自动安装。 详细了解扩展。

管理站点到站点 VPN 网关连接。

命令

名称	说明	类型	Status
az network vpn-gateway connection create	创建站点到站点 VPN 网关连接。	扩展	GA
az network vpn-gateway connection delete	删除站点到站点 VPN 网关连接。	扩展	GA
az network vpn-gateway connection ipsec-policy	管理站点到站点 VPN 网关连接 IPSec 策略。	扩展	GA
az network vpn-gateway connection ipsec-policy add	将 IPSec 策略添加到站点到站点 VPN 网关连接。	扩展	GA
az network vpn-gateway connection ipsec-policy list	列出站点到站点 VPN 网关连接 IPSec 策略。	扩展	GA
az network vpn-gateway connection ipsec-policy remove	从站点到站点 VPN 网关连接中删除 IPSec 策略。	扩展	GA
az network vpn-gateway connection list	列出站点到站点 VPN 网关连接。	扩展	GA
az network vpn-gateway connection packet-capture	管理站点到站点 VPN 网关连接数据包捕获。	扩展	GA
az network vpn-gateway connection packet-capture start	在指定的资源组中的 Vpn 连接上启动数据包捕获。	扩展	GA
az network vpn-gateway connection show	获取站点到站点 VPN 网关连接的详细信息。	扩展	GA
az network vpn-gateway connection update	更新 VPN 网关连接的设置。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn	管理站点到站点 VPN 网关连接 VPN 站点链接连接。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn add	将 VPN 站点链接连接添加到站点到站点 VPN 网关连接。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy	管理站点到站点 VPN 网关连接 VPN 站点链接 IPSec 策略。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy add	将 IPSec 策略添加到站点到站点 VPN 网关连接 VPN 站点链接。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy list	列出站点到站点 VPN 网关连接 VPN 站点链接 IPSec 策略。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy remove	从站点到站点 VPN 网关连接 VPN 站点链接中删除 IPSec 策略。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn list	列出站点到站点 VPN 网关连接 VPN 站点链接连接。	扩展	GA
az network vpn-gateway connection vpn-site-link-conn remove	从站点到站点 VPN 网关连接中删除 VPN 站点链接连接。	扩展	GA
az network vpn-gateway connection wait	将 CLI 置于等待状态，直到满足站点到站点 VPN 网关连接的条件。	扩展	GA

az network vpn-gateway connection create

创建站点到站点 VPN 网关连接。

az network vpn-gateway connection create --gateway-name
                                         --name
                                         --remote-vpn-site
                                         --resource-group
                                         [--associated]
                                         [--associated-inbound-routemap]
                                         [--associated-outbound-routemap]
                                         [--connection-bandwidth]
                                         [--enable-bgp {false, true}]
                                         [--internet-security {false, true}]
                                         [--labels]
                                         [--no-wait]
                                         [--propagated]
                                         [--protocol-type {IKEv1, IKEv2}]
                                         [--rate-limiting {false, true}]
                                         [--routing-weight]
                                         [--shared-key]
                                         [--vpn-site-link]
                                         [--with-link {false, true}]

示例

创建站点到站点 VPN 网关连接

az network vpn-gateway connection create -g MyRG -n MyConnection --gateway-name MyGateway --remote-vpn-site /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/vpnSites/MyVPNSite --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

必需参数

--gateway-name

VPN 网关的名称。

--name -n

VPN 网关连接的名称。

--remote-vpn-site

远程 VPN 站点的 ID 名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--associated --associated-route-table

预览

与此路由配置关联的路由表的资源 ID。

--associated-inbound-routemap

此连接的路由配置的入站路由映射的资源 URI。

--associated-outbound-routemap

此连接的路由配置的出站路由映射的资源 URI。

--connection-bandwidth

预期带宽（以 Mbps 为单位）。

--enable-bgp

启用 BGP。

接受的值: false, true

--internet-security

启用 Internet 安全性。

接受的值: false, true

--labels

预览

传播的路由表的标签空间分隔列表。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--propagated --propagated-route-tables

预览

传播的路由表的资源 ID 的空间分隔列表。

--protocol-type

连接协议。

接受的值: IKEv1, IKEv2

--rate-limiting

启用速率限制。

接受的值: false, true

--routing-weight

路由权重。

--shared-key

共享密钥。

--vpn-site-link

VPN 站点链接的资源 ID。

--with-link

使用默认链接创建 Vpn连接ion。

接受的值: 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-gateway connection delete

删除站点到站点 VPN 网关连接。

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

示例

删除站点到站点 VPN 网关连接

az network vpn-gateway connection delete -g MyRG -n MyConnection --gateway-name MyGateway

可选参数

--gateway-name

VPN 网关的名称。

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

列出站点到站点 VPN 网关连接。

az network vpn-gateway connection list --gateway-name
                                       --resource-group

示例

列出给定站点到站点 VPN 网关的所有连接

az network vpn-gateway connection list -g MyRG --gateway-name MyGateway

必需参数

--gateway-name

VPN 网关的名称。

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

获取站点到站点 VPN 网关连接的详细信息。

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

示例

获取站点到站点 VPN 网关连接的详细信息

az network vpn-gateway connection show -g MyRG -n MyConnection --gateway-name MyGateway

可选参数

--gateway-name

VPN 网关的名称。

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

更新 VPN 网关连接的设置。

az network vpn-gateway connection update [--add]
                                         [--associated]
                                         [--associated-inbound-routemap]
                                         [--associated-outbound-routemap]
                                         [--force-string]
                                         [--gateway-name]
                                         [--ids]
                                         [--labels]
                                         [--name]
                                         [--no-wait]
                                         [--propagated]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]

示例

在路由配置下为传播的路由表添加标签。

az network vpn-gateway connection update -g MyRG -n MyConnection --gateway-name MyGateway --labels NewLabel1 NewLabels2

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

默认值: []

--associated --associated-route-table

预览

与此路由配置关联的路由表的资源 ID。

--associated-inbound-routemap

此连接的路由配置的入站路由映射的资源 URI。

--associated-outbound-routemap

此连接的路由配置的出站路由映射的资源 URI。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

默认值: False

--gateway-name

VPN 网关的名称。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--labels

预览

传播的路由表的标签空间分隔列表。

--name -n

VPN 网关连接的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--propagated --propagated-route-tables

预览

传播的路由表的资源 ID 的空间分隔列表。

--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

默认值: []

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

默认值: []

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

将 CLI 置于等待状态，直到满足站点到站点 VPN 网关连接的条件。

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

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--gateway-name

VPN 网关的名称。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name -n

VPN 网关连接的名称。

--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 获取完整的调试日志。