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

az network vpn-connection

管理 VPN 连接。

有关站点到站点连接的详细信息,请访问 https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli。 有关 Vnet 到 Vnet 连接的详细信息,请访问 https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-vnet-vnet-cli

命令

名称 说明 类型 状态
az network vpn-connection create

创建 VPN 连接。

核心 GA
az network vpn-connection delete

删除 VPN 连接。

核心 GA
az network vpn-connection ipsec-policy

管理 VPN 连接 IPSec 策略。

核心 GA
az network vpn-connection ipsec-policy add

添加 VPN 连接 IPSec 策略。

核心 GA
az network vpn-connection ipsec-policy clear

删除 VPN 连接上的所有 IPsec 策略。

核心 GA
az network vpn-connection ipsec-policy list

列出与 VPN 连接关联的 IPSec 策略。

核心 GA
az network vpn-connection ipsec-policy wait

将 CLI 置于等待状态,直到满足条件。

核心 GA
az network vpn-connection list

列出所有 VPN 连接。

核心 GA
az network vpn-connection list-ike-sas

列出 VPN 连接的 IKE 安全关联。

核心 预览
az network vpn-connection packet-capture

在 VPN 连接上管理数据包捕获。

核心 GA
az network vpn-connection packet-capture start

在 VPN 连接上启动数据包捕获。

核心 GA
az network vpn-connection packet-capture stop

在 VPN 连接上停止数据包捕获。

核心 预览
az network vpn-connection packet-capture wait

将 CLI 置于等待状态,直到满足条件。

核心 GA
az network vpn-connection shared-key

管理 VPN 共享密钥。

核心 GA
az network vpn-connection shared-key reset

重置 VPN 连接共享密钥。

核心 GA
az network vpn-connection shared-key show

检索 VPN 连接共享密钥。

核心 GA
az network vpn-connection shared-key update

更新 VPN 连接共享密钥。

核心 GA
az network vpn-connection show

获取 VPN 连接的详细信息。

核心 GA
az network vpn-connection show-device-config-script

获取 VPN 连接设备配置脚本的 XML 格式表示形式。

核心 预览版
az network vpn-connection update

更新 VPN 连接。

核心 GA
az network vpn-connection wait

将 CLI 置于等待状态,直到满足条件。

核心 GA

az network vpn-connection create

创建 VPN 连接。

必须先预配VPN 网关和本地网络网关,然后才能在它们之间创建连接。

az network vpn-connection create --name
                                 --resource-group
                                 --vnet-gateway1
                                 [--authorization-key]
                                 [--egress-nat-rule]
                                 [--enable-bgp]
                                 [--express-route-circuit2]
                                 [--express-route-gateway-bypass {false, true}]
                                 [--ingress-nat-rule]
                                 [--local-gateway2]
                                 [--location]
                                 [--routing-weight]
                                 [--shared-key]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {false, true}]
                                 [--validate]
                                 [--vnet-gateway2]

示例

在 Azure 虚拟网络和本地本地网络网关之间创建站点到站点连接。

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123

使用 --ingress-nat-rule 创建 VPN 连接。

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123 --ingress-nat-rule /subscriptions/000/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/gwx/natRules/nat

创建 VPN 连接。 (自动生成)

az network vpn-connection create --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway --vnet-gateway2 /subscriptions/{subscriptionID}/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/VNet1GW

创建 VPN 连接。 (自动生成)

az network vpn-connection create --local-gateway2 MyLocalGateway --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway

必需参数

--name -n

连接名称。

--resource-group -g

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

--vnet-gateway1

源虚拟网络网关的名称或 ID。

可选参数

--authorization-key

VPN 连接的授权密钥。

--egress-nat-rule
预览

出口 NatRules 列表。

--enable-bgp

为此 VPN 连接启用 BGP。

默认值: False
--express-route-circuit2

使用“ExpressRoute”连接连接到的目标 ExpressRoute 的名称或 ID。

--express-route-gateway-bypass

绕过 ExpressRoute 网关进行数据转发。

接受的值: false, true
--ingress-nat-rule
预览

入口 NatRules 列表。

--local-gateway2

使用“IPSec”连接连接到的目标本地网络网关的名称或 ID。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--routing-weight

连接路由权重。

默认值: 10
--shared-key

共享 IPSec 密钥。

--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。

--use-policy-based-traffic-selectors

启用基于策略的流量选择器。

接受的值: false, true
默认值: False
--validate

显示并验证 ARM 模板,但不创建任何资源。

默认值: False
--vnet-gateway2

使用“Vnet2Vnet”连接连接到的目标虚拟网络网关的名称或 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-connection delete

删除 VPN 连接。

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

示例

删除 VPN 连接。

az network vpn-connection delete -g MyResourceGroup -n MyConnection

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

连接名称。

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

列出所有 VPN 连接。

az network vpn-connection list --resource-group
                               [--vnet-gateway]

示例

列出资源组中的所有 VPN 连接。

az network vpn-connection list -g MyResourceGroup

列出虚拟网络网关中的所有 VPN 连接。

az network vpn-connection list -g MyResourceGroup --vnet-gateway MyVnetGateway

必需参数

--resource-group -g

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

可选参数

--vnet-gateway

VNet 网关的名称。

全局参数
--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-connection list-ike-sas

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

列出 VPN 连接的 IKE 安全关联。

az network vpn-connection list-ike-sas [--ids]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

示例

列出 VPN 连接的 IKE 安全关联。

az network vpn-connection list-ike-sas -g MyResourceGroup -n MyConnection

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

连接名称。

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

获取 VPN 连接的详细信息。

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

示例

查看 VPN 连接的详细信息。

az network vpn-connection show -g MyResourceGroup -n MyConnection

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

连接名称。

--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-connection show-device-config-script

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

获取 VPN 连接设备配置脚本的 XML 格式表示形式。

az network vpn-connection show-device-config-script --device-family
                                                    --firmware-version
                                                    --vendor
                                                    [--ids]
                                                    [--name]
                                                    [--resource-group]
                                                    [--subscription]

示例

获取 VPN 连接设备配置脚本的 XML 格式表示形式。

az network vpn-connection show-device-config-script -g MyResourceGroup -n MyConnection --vendor "Cisco" --device-family "Cisco-ISR(IOS)" --firmware-version "Cisco-ISR-15.x-- IKEv2+BGP"

必需参数

--device-family

VPN 设备的设备系列。

--firmware-version

VPN 设备的固件版本。

--vendor

VPN 设备的供应商。

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

连接名称。

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

更新 VPN 连接。

az network vpn-connection update [--add]
                                 [--enable-bgp {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--express-route-gateway-bypass {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--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}]
                                 [--remove]
                                 [--resource-group]
                                 [--routing-weight]
                                 [--set]
                                 [--shared-key]
                                 [--subscription]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {0, 1, f, false, n, no, t, true, y, yes}]

示例

将 BGP 添加到现有连接。

az network vpn-connection update -g MyResourceGroup -n MyConnection --enable-bgp True

更新 VPN 连接。

az network vpn-connection update --name MyConnection --resource-group MyResourceGroup --use-policy-based-traffic-selectors true

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。

--enable-bgp

启用 BGP(边界网关协议)。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--express-route-gateway-bypass

绕过 ExpressRoute 网关进行数据转发。

接受的值: 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
--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

连接名称。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

--resource-group -g

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

--routing-weight

连接路由权重。

--set

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

--shared-key

共享 IPSec 密钥。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--use-policy-based-traffic-selectors

启用基于策略的流量选择器。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--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-connection wait

将 CLI 置于等待状态,直到满足条件。

az network vpn-connection wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--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
--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔(以秒为单位)。

默认值: 30
--name -n

连接名称。

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