你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Network vpnServerConfigurations 2019-09-01
- 最新
- 2024-05-01
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
Bicep 资源定义
可以使用目标操作部署 vpnServerConfigurations 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/vpnServerConfigurations 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/vpnServerConfigurations@2019-09-01' = {
location: 'string'
name: 'string'
properties: {
aadAuthenticationParameters: {
aadAudience: 'string'
aadIssuer: 'string'
aadTenant: 'string'
}
name: 'string'
radiusClientRootCertificates: [
{
name: 'string'
thumbprint: 'string'
}
]
radiusServerAddress: 'string'
radiusServerRootCertificates: [
{
name: 'string'
publicCertData: 'string'
}
]
radiusServerSecret: 'string'
vpnAuthenticationTypes: [
'string'
]
vpnClientIpsecPolicies: [
{
dhGroup: 'string'
ikeEncryption: 'string'
ikeIntegrity: 'string'
ipsecEncryption: 'string'
ipsecIntegrity: 'string'
pfsGroup: 'string'
saDataSizeKilobytes: int
saLifeTimeSeconds: int
}
]
vpnClientRevokedCertificates: [
{
name: 'string'
thumbprint: 'string'
}
]
vpnClientRootCertificates: [
{
name: 'string'
publicCertData: 'string'
}
]
vpnProtocols: [
'string'
]
}
tags: {
{customized property}: 'string'
}
}
属性值
AadAuthenticationParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| aadAudience | AAD Vpn 身份验证参数 AAD 受众。 | 字符串 |
| aadIssuer | AAD Vpn 身份验证参数 AAD 颁发者。 | 字符串 |
| aadTenant | AAD Vpn 身份验证参数 AAD 租户。 | 字符串 |
IpsecPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| dhGroup | IKE 阶段 1 中用于初始 SA 的 DH 组。 | “DHGroup1” “DHGroup14” “DHGroup2” “DHGroup2048” “DHGroup24” “ECP256” “ECP384” “无”（必需） |
| ikeEncryption | IKE 加密算法（IKE 阶段 2）。 | “AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES256”（必需） |
| ikeIntegrity | IKE 完整性算法（IKE 阶段 2）。 | “GCMAES128” “GCMAES256” “MD5” “SHA1” “SHA256” “SHA384”（必需） |
| ipsecEncryption | IPSec 加密算法（IKE 阶段 1）。 | “AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES192” “GCMAES256” “无”（必需） |
| ipsecIntegrity | IPSec 完整性算法（IKE 阶段 1）。 | “GCMAES128” “GCMAES192” “GCMAES256” “MD5” “SHA1” “SHA256”（必需） |
| pfsGroup | IKE 阶段 2 中使用的 Pfs 组用于新的子 SA。 | “ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需） |
| saDataSizeKilobytes | IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。 | int （必需） |
| saLifeTimeSeconds | 站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。 | int （必需） |
Microsoft.Network/vpnServerConfigurations
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源位置。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | P2SVpnServer 配置的属性。 | VpnServerConfigurationProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
VpnServerConfigRadiusClientRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| 指纹 | Radius 客户端根证书指纹。 | 字符串 |
VpnServerConfigRadiusServerRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| publicCertData | 证书公共数据。 | 字符串 |
VpnServerConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| aadAuthenticationParameters | aad vpn 身份验证参数集。 | AadAuthenticationParameters |
| 名字 | 资源组中唯一的 VpnServerConfiguration 的名称。 | 字符串 |
| radiusClientRootCertificates | VpnServerConfiguration 的 Radius 客户端根证书。 | VpnServerConfigRadiusClientRootCertificate[] |
| radiusServerAddress | 用于点到站点客户端连接的 VpnServerConfiguration 资源的 radius 服务器地址属性。 | 字符串 |
| radiusServerRootCertificates | VpnServerConfiguration 的 Radius 服务器根证书。 | VpnServerConfigRadiusServerRootCertificate[] |
| radiusServerSecret | 用于点到站点客户端连接的 VpnServerConfiguration 资源的 radius 机密属性。 | 字符串 |
| vpnAuthenticationTypes | VpnServerConfiguration 的 VPN 身份验证类型。 | 包含任一项的字符串数组： “AAD” “Certificate” “Radius” |
| vpnClientIpsecPolicies | VpnServerConfiguration 的 VpnClientIpsecPolicies。 | IpsecPolicy[] |
| vpnClientRevokedCertificates | VPN 客户端吊销的 VpnServerConfiguration 证书。 | VpnServerConfigVpnClientRevokedCertificate[] |
| vpnClientRootCertificates | VpnServerConfiguration 的 VPN 客户端根证书。 | VpnServerConfigVpnClientRootCertificate[] |
| vpnProtocols | VpnServerConfiguration 的 VPN 协议。 | 包含任一项的字符串数组： “IkeV2” “OpenVPN” |
VpnServerConfigVpnClientRevokedCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| 指纹 | 吊销的 VPN 客户端证书指纹。 | 字符串 |
VpnServerConfigVpnClientRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| publicCertData | 证书公共数据。 | 字符串 |
ARM 模板资源定义
可以使用目标操作部署 vpnServerConfigurations 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/vpnServerConfigurations 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/vpnServerConfigurations",
"apiVersion": "2019-09-01",
"name": "string",
"location": "string",
"properties": {
"aadAuthenticationParameters": {
"aadAudience": "string",
"aadIssuer": "string",
"aadTenant": "string"
},
"name": "string",
"radiusClientRootCertificates": [
{
"name": "string",
"thumbprint": "string"
}
],
"radiusServerAddress": "string",
"radiusServerRootCertificates": [
{
"name": "string",
"publicCertData": "string"
}
],
"radiusServerSecret": "string",
"vpnAuthenticationTypes": [ "string" ],
"vpnClientIpsecPolicies": [
{
"dhGroup": "string",
"ikeEncryption": "string",
"ikeIntegrity": "string",
"ipsecEncryption": "string",
"ipsecIntegrity": "string",
"pfsGroup": "string",
"saDataSizeKilobytes": "int",
"saLifeTimeSeconds": "int"
}
],
"vpnClientRevokedCertificates": [
{
"name": "string",
"thumbprint": "string"
}
],
"vpnClientRootCertificates": [
{
"name": "string",
"publicCertData": "string"
}
],
"vpnProtocols": [ "string" ]
},
"tags": {
"{customized property}": "string"
}
}
属性值
AadAuthenticationParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| aadAudience | AAD Vpn 身份验证参数 AAD 受众。 | 字符串 |
| aadIssuer | AAD Vpn 身份验证参数 AAD 颁发者。 | 字符串 |
| aadTenant | AAD Vpn 身份验证参数 AAD 租户。 | 字符串 |
IpsecPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| dhGroup | IKE 阶段 1 中用于初始 SA 的 DH 组。 | “DHGroup1” “DHGroup14” “DHGroup2” “DHGroup2048” “DHGroup24” “ECP256” “ECP384” “无”（必需） |
| ikeEncryption | IKE 加密算法（IKE 阶段 2）。 | “AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES256”（必需） |
| ikeIntegrity | IKE 完整性算法（IKE 阶段 2）。 | “GCMAES128” “GCMAES256” “MD5” “SHA1” “SHA256” “SHA384”（必需） |
| ipsecEncryption | IPSec 加密算法（IKE 阶段 1）。 | “AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES192” “GCMAES256” “无”（必需） |
| ipsecIntegrity | IPSec 完整性算法（IKE 阶段 1）。 | “GCMAES128” “GCMAES192” “GCMAES256” “MD5” “SHA1” “SHA256”（必需） |
| pfsGroup | IKE 阶段 2 中使用的 Pfs 组用于新的子 SA。 | “ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需） |
| saDataSizeKilobytes | IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。 | int （必需） |
| saLifeTimeSeconds | 站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。 | int （必需） |
Microsoft.Network/vpnServerConfigurations
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2019-09-01' |
| 位置 | 资源位置。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | P2SVpnServer 配置的属性。 | VpnServerConfigurationProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.Network/vpnServerConfigurations” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
VpnServerConfigRadiusClientRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| 指纹 | Radius 客户端根证书指纹。 | 字符串 |
VpnServerConfigRadiusServerRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| publicCertData | 证书公共数据。 | 字符串 |
VpnServerConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| aadAuthenticationParameters | aad vpn 身份验证参数集。 | AadAuthenticationParameters |
| 名字 | 资源组中唯一的 VpnServerConfiguration 的名称。 | 字符串 |
| radiusClientRootCertificates | VpnServerConfiguration 的 Radius 客户端根证书。 | VpnServerConfigRadiusClientRootCertificate[] |
| radiusServerAddress | 用于点到站点客户端连接的 VpnServerConfiguration 资源的 radius 服务器地址属性。 | 字符串 |
| radiusServerRootCertificates | VpnServerConfiguration 的 Radius 服务器根证书。 | VpnServerConfigRadiusServerRootCertificate[] |
| radiusServerSecret | 用于点到站点客户端连接的 VpnServerConfiguration 资源的 radius 机密属性。 | 字符串 |
| vpnAuthenticationTypes | VpnServerConfiguration 的 VPN 身份验证类型。 | 包含任一项的字符串数组： “AAD” “Certificate” “Radius” |
| vpnClientIpsecPolicies | VpnServerConfiguration 的 VpnClientIpsecPolicies。 | IpsecPolicy[] |
| vpnClientRevokedCertificates | VPN 客户端吊销的 VpnServerConfiguration 证书。 | VpnServerConfigVpnClientRevokedCertificate[] |
| vpnClientRootCertificates | VpnServerConfiguration 的 VPN 客户端根证书。 | VpnServerConfigVpnClientRootCertificate[] |
| vpnProtocols | VpnServerConfiguration 的 VPN 协议。 | 包含任一项的字符串数组： “IkeV2” “OpenVPN” |
VpnServerConfigVpnClientRevokedCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| 指纹 | 吊销的 VPN 客户端证书指纹。 | 字符串 |
VpnServerConfigVpnClientRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| publicCertData | 证书公共数据。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
Azure 虚拟 WAN （vWAN） 多中心部署
|
使用此模板可以创建 Azure 虚拟 WAN（vWAN）多中心部署，包括所有网关和 VNET 连接。 |
| 使用自定义路由表 Azure vWAN 多中心部署
|
使用此模板可以创建 Azure 虚拟 WAN（vWAN）多中心部署，包括所有网关和 VNET 连接，并演示路由表用于自定义路由的用法。 |
| 使用多地址池和用户组 vWAN P2S 部署
|
此模板部署具有配置多个地址池和用户组的 P2S 的 Azure 虚拟 WAN （vWAN） |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 vpnServerConfigurations 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/vpnServerConfigurations 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnServerConfigurations@2019-09-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
aadAuthenticationParameters = {
aadAudience = "string"
aadIssuer = "string"
aadTenant = "string"
}
name = "string"
radiusClientRootCertificates = [
{
name = "string"
thumbprint = "string"
}
]
radiusServerAddress = "string"
radiusServerRootCertificates = [
{
name = "string"
publicCertData = "string"
}
]
radiusServerSecret = "string"
vpnAuthenticationTypes = [
"string"
]
vpnClientIpsecPolicies = [
{
dhGroup = "string"
ikeEncryption = "string"
ikeIntegrity = "string"
ipsecEncryption = "string"
ipsecIntegrity = "string"
pfsGroup = "string"
saDataSizeKilobytes = int
saLifeTimeSeconds = int
}
]
vpnClientRevokedCertificates = [
{
name = "string"
thumbprint = "string"
}
]
vpnClientRootCertificates = [
{
name = "string"
publicCertData = "string"
}
]
vpnProtocols = [
"string"
]
}
})
}
属性值
AadAuthenticationParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| aadAudience | AAD Vpn 身份验证参数 AAD 受众。 | 字符串 |
| aadIssuer | AAD Vpn 身份验证参数 AAD 颁发者。 | 字符串 |
| aadTenant | AAD Vpn 身份验证参数 AAD 租户。 | 字符串 |
IpsecPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| dhGroup | IKE 阶段 1 中用于初始 SA 的 DH 组。 | “DHGroup1” “DHGroup14” “DHGroup2” “DHGroup2048” “DHGroup24” “ECP256” “ECP384” “无”（必需） |
| ikeEncryption | IKE 加密算法（IKE 阶段 2）。 | “AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES256”（必需） |
| ikeIntegrity | IKE 完整性算法（IKE 阶段 2）。 | “GCMAES128” “GCMAES256” “MD5” “SHA1” “SHA256” “SHA384”（必需） |
| ipsecEncryption | IPSec 加密算法（IKE 阶段 1）。 | “AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES192” “GCMAES256” “无”（必需） |
| ipsecIntegrity | IPSec 完整性算法（IKE 阶段 1）。 | “GCMAES128” “GCMAES192” “GCMAES256” “MD5” “SHA1” “SHA256”（必需） |
| pfsGroup | IKE 阶段 2 中使用的 Pfs 组用于新的子 SA。 | “ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需） |
| saDataSizeKilobytes | IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。 | int （必需） |
| saLifeTimeSeconds | 站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。 | int （必需） |
Microsoft.Network/vpnServerConfigurations
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源位置。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | P2SVpnServer 配置的属性。 | VpnServerConfigurationProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.Network/vpnServerConfigurations@2019-09-01” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
VpnServerConfigRadiusClientRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| 指纹 | Radius 客户端根证书指纹。 | 字符串 |
VpnServerConfigRadiusServerRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| publicCertData | 证书公共数据。 | 字符串 |
VpnServerConfigurationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| aadAuthenticationParameters | aad vpn 身份验证参数集。 | AadAuthenticationParameters |
| 名字 | 资源组中唯一的 VpnServerConfiguration 的名称。 | 字符串 |
| radiusClientRootCertificates | VpnServerConfiguration 的 Radius 客户端根证书。 | VpnServerConfigRadiusClientRootCertificate[] |
| radiusServerAddress | 用于点到站点客户端连接的 VpnServerConfiguration 资源的 radius 服务器地址属性。 | 字符串 |
| radiusServerRootCertificates | VpnServerConfiguration 的 Radius 服务器根证书。 | VpnServerConfigRadiusServerRootCertificate[] |
| radiusServerSecret | 用于点到站点客户端连接的 VpnServerConfiguration 资源的 radius 机密属性。 | 字符串 |
| vpnAuthenticationTypes | VpnServerConfiguration 的 VPN 身份验证类型。 | 包含任一项的字符串数组： “AAD” “Certificate” “Radius” |
| vpnClientIpsecPolicies | VpnServerConfiguration 的 VpnClientIpsecPolicies。 | IpsecPolicy[] |
| vpnClientRevokedCertificates | VPN 客户端吊销的 VpnServerConfiguration 证书。 | VpnServerConfigVpnClientRevokedCertificate[] |
| vpnClientRootCertificates | VpnServerConfiguration 的 VPN 客户端根证书。 | VpnServerConfigVpnClientRootCertificate[] |
| vpnProtocols | VpnServerConfiguration 的 VPN 协议。 | 包含任一项的字符串数组： “IkeV2” “OpenVPN” |
VpnServerConfigVpnClientRevokedCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| 指纹 | 吊销的 VPN 客户端证书指纹。 | 字符串 |
VpnServerConfigVpnClientRootCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 证书名称。 | 字符串 |
| publicCertData | 证书公共数据。 | 字符串 |