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

az network vnet-gateway vpn-client

  • 参考

下载通过点到站点连接到 Azure 所需的 VPN 客户端配置。

命令

名称 说明 类型 状态
az network vnet-gateway vpn-client generate

生成 VPN 客户端配置。

 核心 GA
az network vnet-gateway vpn-client ipsec-policy

管理虚拟网络网关的 P2S 客户端连接的 VPN 客户端连接 ipsec 策略。

 核心 GA
az network vnet-gateway vpn-client ipsec-policy set

根据虚拟网络网关的 P2S 客户端连接设置 VPN 客户端连接 ipsec 策略。

 核心 预览
az network vnet-gateway vpn-client ipsec-policy show

根据虚拟网络网关的 P2S 客户端连接获取 VPN 客户端连接 ipsec 策略。

 核心 预览版
az network vnet-gateway vpn-client ipsec-policy wait

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

 核心 GA
az network vnet-gateway vpn-client show-health

获取虚拟网络网关的每个 P2S 客户端连接的 VPN 客户端连接运行状况详细信息。

 核心 预览
az network vnet-gateway vpn-client show-url

检索预生成的 VPN 客户端配置。

 核心 GA

az network vnet-gateway vpn-client generate

编辑

生成 VPN 客户端配置。

该命令将 URL 输出到生成的 VPN 客户端配置的 zip 文件。

az network vnet-gateway vpn-client generate [--authentication-method {EAPMSCHAPv2, EAPTLS}]
                                            [--client-root-certificates]
                                            [--ids]
                                            [--name]
                                            [--processor-architecture {Amd64, X86}]
                                            [--radius-server-auth-certificate]
                                            [--resource-group]
                                            [--subscription]
                                            [--use-legacy {false, true}]

示例

使用 EAP-MSCHAV2 身份验证为 RADIUS 创建 VPN 客户端配置。

az network vnet-gateway vpn-client generate -g MyResourceGroup -n MyVnetGateway --authentication-method EAPMSCHAPv2

为 AMD64 体系结构创建 VPN 客户端配置。

az network vnet-gateway vpn-client generate -g MyResourceGroup -n MyVnetGateway --processor-architecture Amd64

生成 VPN 客户端配置。 （自动生成）

az network vnet-gateway vpn-client generate --name MyVnetGateway --processor-architecture Amd64 --resource-group MyResourceGroup --subscription MySubscription

可选参数

--authentication-method

用于对生成的客户端进行身份验证的方法。

接受的值: EAPMSCHAPv2, EAPTLS
--client-root-certificates

以 Base-64 格式分隔的客户端根证书公共证书数据的空间分隔列表。 对于使用 EAPTLS 进行基于外部 Radius 的身份验证，可选。

--ids

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

--name -n

VNet 网关的名称。

--processor-architecture

目标系统的处理器体系结构。

接受的值: Amd64, X86
--radius-server-auth-certificate

Radius 服务器身份验证证书的公共证书数据（采用 Base-64 格式）。 仅当已使用 EAPTLS 身份验证配置外部 Radius 身份验证时才是必需的。

--resource-group -g

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

--subscription

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

--use-legacy

使用旧实现生成 VPN 客户端包。

接受的值: false, true
默认值: 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 获取完整的调试日志。

az network vnet-gateway vpn-client show-health

编辑
预览

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

获取虚拟网络网关的每个 P2S 客户端连接的 VPN 客户端连接运行状况详细信息。

az network vnet-gateway vpn-client show-health [--ids]
                                               [--name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

示例

获取虚拟网络网关的每个 P2S 客户端连接的 VPN 客户端连接运行状况详细信息。

az network vnet-gateway vpn-client show-health -g MyResourceGroup -n MyVnetGateway

可选参数

--ids

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

--name -n

VNet 网关的名称。

--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 vnet-gateway vpn-client show-url

编辑

检索预生成的 VPN 客户端配置。

az network vnet-gateway vpn-client show-url [--ids]
                                            [--name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]

示例

获取虚拟网络网关的预生成的点到站点 VPN 客户端。

az network vnet-gateway vpn-client show-url -g MyResourceGroup -n MyVnetGateway

可选参数

--ids

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

--name -n

VNet 网关的名称。

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