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

az network vpn-server-config

注意

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

管理 VPN 服务器配置。

命令

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

创建 VPN 服务器配置。

扩展 GA
az network vpn-server-config delete

删除 VPN 服务器配置。

扩展 GA
az network vpn-server-config ipsec-policy

管理 VPN 服务器配置 IPSec 策略。

扩展 GA
az network vpn-server-config ipsec-policy add

将 IPSec 策略添加到 VPN 服务器配置。

扩展 GA
az network vpn-server-config ipsec-policy list

列出 VPN 服务器配置 IPSec 策略。

扩展 GA
az network vpn-server-config ipsec-policy remove

从 VPN 服务器配置中删除 IPSec 策略。

扩展 GA
az network vpn-server-config ipsec-policy wait

将 CLI 置于等待状态,直到满足 VPN 服务器配置的 IPSec 策略的条件。

扩展 GA
az network vpn-server-config list

列出所有 VPN 服务器配置。

扩展 GA
az network vpn-server-config set

设置 VPN 服务器配置的设置。

扩展 GA
az network vpn-server-config show

显示 VPN 服务器配置的详细信息。

扩展 GA
az network vpn-server-config wait

将 CLI 置于等待状态,直到满足 VPN 服务器配置的条件。

扩展 GA

az network vpn-server-config create

创建 VPN 服务器配置。

az network vpn-server-config create --name
                                    --resource-group
                                    [--aad-audience]
                                    [--aad-issuer]
                                    [--aad-tenant]
                                    [--auth-types {AAD, Certificate, Radius}]
                                    [--location]
                                    [--no-wait]
                                    [--protocols {IkeV2, OpenVPN}]
                                    [--radius-client-root-certs]
                                    [--radius-server-root-certs]
                                    [--radius-servers]
                                    [--vpn-client-revoked-certs]
                                    [--vpn-client-root-certs]

示例

使用 VPN 身份验证类型创建 VPN 服务器配置

az network vpn-server-config create -n MyVPNServerConfig -g MyRG --vpn-client-root-certs "ApplicationGatewayAuthCert.cer" --vpn-client-revoked-certs "ApplicationGatewayAuthCert.pem"

必需参数

--name -n

Vpn 服务器配置的名称。

--resource-group -g

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

可选参数

--aad-audience

AAD Vpn 身份验证参数 AAD 受众。

--aad-issuer

AAD Vpn 身份验证参数 AAD 颁发者。

--aad-tenant

AAD Vpn 身份验证参数 AAD 租户。

--auth-types

VpnServerConfiguration 的 VPN 身份验证类型列表。

接受的值: AAD, Certificate, Radius
--location -l

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

--no-wait

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

默认值: False
--protocols

VpnServerConfiguration 的 VPN 协议。

接受的值: IkeV2, OpenVPN
--radius-client-root-certs

Radius 客户端根证书文件路径的列表。

--radius-server-root-certs

Radius 服务器根证书文件路径的列表。

--radius-servers

Radius Server 配置。

--vpn-client-revoked-certs

VPN 客户端吊销证书文件路径的列表。

--vpn-client-root-certs

VPN 客户端根证书文件路径的列表。

全局参数
--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-server-config delete

删除 VPN 服务器配置。

az network vpn-server-config delete --name
                                    --resource-group
                                    [--yes]

必需参数

--name -n

Vpn 服务器配置的名称。

--resource-group -g

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

可选参数

--yes -y

不提示确认。

默认值: 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 vpn-server-config list

列出所有 VPN 服务器配置。

az network vpn-server-config 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-server-config set

设置 VPN 服务器配置的设置。

az network vpn-server-config set --name
                                 --resource-group
                                 [--aad-audience]
                                 [--aad-issuer]
                                 [--aad-tenant]
                                 [--auth-types {AAD, Certificate, Radius}]
                                 [--location]
                                 [--no-wait]
                                 [--protocols {IkeV2, OpenVPN}]
                                 [--radius-client-root-certs]
                                 [--radius-server-root-certs]
                                 [--radius-servers]
                                 [--vpn-client-revoked-certs]
                                 [--vpn-client-root-certs]

示例

使用 Radius 身份验证类型设置 VPN 服务器配置

az network vpn-server-config set -n MyVPNServerConfig -g MyRG --radius-client-root-certs "ApplicationGatewayAuthCert.cer" --radius-server-root-certs "ApplicationGatewayAuthCert.pem" --radius-servers address=test1 secret=clitest score=10 --radius-servers address=test2 secret=clitest score=10

必需参数

--name -n

Vpn 服务器配置的名称。

--resource-group -g

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

可选参数

--aad-audience

AAD Vpn 身份验证参数 AAD 受众。

--aad-issuer

AAD Vpn 身份验证参数 AAD 颁发者。

--aad-tenant

AAD Vpn 身份验证参数 AAD 租户。

--auth-types

VpnServerConfiguration 的 VPN 身份验证类型列表。

接受的值: AAD, Certificate, Radius
--location -l

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

--no-wait

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

默认值: False
--protocols

VpnServerConfiguration 的 VPN 协议。

接受的值: IkeV2, OpenVPN
--radius-client-root-certs

Radius 客户端根证书文件路径的列表。

--radius-server-root-certs

Radius 服务器根证书文件路径的列表。

--radius-servers

Radius Server 配置。

--vpn-client-revoked-certs

VPN 客户端吊销证书文件路径的列表。

--vpn-client-root-certs

VPN 客户端根证书文件路径的列表。

全局参数
--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-server-config show

显示 VPN 服务器配置的详细信息。

az network vpn-server-config show --name
                                  --resource-group

必需参数

--name -n

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-server-config wait

将 CLI 置于等待状态,直到满足 VPN 服务器配置的条件。

az network vpn-server-config wait --name
                                  --resource-group
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--interval]
                                  [--timeout]
                                  [--updated]

必需参数

--name -n

Vpn 服务器配置的名称。

--resource-group -g

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

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--interval

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

默认值: 30
--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 获取完整的调试日志。