你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Network vpnGateways 2018-11-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
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
- 2018-07-01
- 2018-06-01
- 2018-04-01
Bicep 资源定义
可以使用目标操作部署 vpnGateways 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/vpnGateways 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/vpnGateways@2018-11-01' = {
location: 'string'
name: 'string'
properties: {
bgpSettings: {
asn: int
bgpPeeringAddress: 'string'
peerWeight: int
}
connections: [
{
id: 'string'
name: 'string'
properties: {
connectionBandwidth: int
enableBgp: bool
enableInternetSecurity: bool
enableRateLimiting: bool
ipsecPolicies: [
{
dhGroup: 'string'
ikeEncryption: 'string'
ikeIntegrity: 'string'
ipsecEncryption: 'string'
ipsecIntegrity: 'string'
pfsGroup: 'string'
saDataSizeKilobytes: int
saLifeTimeSeconds: int
}
]
provisioningState: 'string'
remoteVpnSite: {
id: 'string'
}
routingWeight: int
sharedKey: 'string'
vpnConnectionProtocolType: 'string'
}
}
]
provisioningState: 'string'
virtualHub: {
id: 'string'
}
vpnGatewayScaleUnit: int
}
tags: {
{customized property}: 'string'
}
}
属性值
BgpSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| asn | BGP 扬声器的 ASN。 | int |
| bgpPeeringAddress | 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 | 字符串 |
| peerWeight | 添加到从此 BGP 扬声器中学习的路由的权重。 | int |
IpsecPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| dhGroup | IKE 阶段 1 中使用的 DH 组用于初始 SA。 | “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 中用于新子 SA 的 Pfs 组。 | “ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需） |
| saDataSizeKilobytes | IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。 | int （必需） |
| saLifeTimeSeconds | 站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。 | int （必需） |
Microsoft.Network/vpnGateways
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源位置。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | VpnGateway 的参数 | VpnGatewayProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SubResource
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID。 | 字符串 |
VpnConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID。 | 字符串 |
| 名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
| 性能 | VpnConnection 的参数 | VpnConnectionProperties |
VpnConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| connectionBandwidth | 预期带宽（以 MBPS 为单位）。 | int |
| enableBgp | EnableBgp 标志 | bool |
| enableInternetSecurity | 启用 Internet 安全性 | bool |
| enableRateLimiting | EnableBgp 标志 | bool |
| ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
| provisioningState | 资源的预配状态。 | “删除” “Failed” “Succeeded” “正在更新” |
| remoteVpnSite | 连接的 VPN 站点的 ID。 | SubResource |
| routingWeight | VPN 连接的路由权重。 | int |
| sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
| vpnConnectionProtocolType | 用于此连接的连接协议 | “IKEv1” “IKEv2” |
VpnGatewayProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bgpSettings | 本地网络网关的 BGP 扬声器设置。 | BgpSettings |
| 连接 | 指向网关的所有 VPN 连接的列表。 | VpnConnection[] |
| provisioningState | 资源的预配状态。 | “删除” “Failed” “Succeeded” “正在更新” |
| virtualHub | 网关所属的 VirtualHub | SubResource |
| vpnGatewayScaleUnit | 此 VPN 网关的缩放单元。 | int |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 创建虚拟 WAN 资源 | 使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。 |
ARM 模板资源定义
可以使用目标操作部署 vpnGateways 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/vpnGateways 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/vpnGateways",
"apiVersion": "2018-11-01",
"name": "string",
"location": "string",
"properties": {
"bgpSettings": {
"asn": "int",
"bgpPeeringAddress": "string",
"peerWeight": "int"
},
"connections": [
{
"id": "string",
"name": "string",
"properties": {
"connectionBandwidth": "int",
"enableBgp": "bool",
"enableInternetSecurity": "bool",
"enableRateLimiting": "bool",
"ipsecPolicies": [
{
"dhGroup": "string",
"ikeEncryption": "string",
"ikeIntegrity": "string",
"ipsecEncryption": "string",
"ipsecIntegrity": "string",
"pfsGroup": "string",
"saDataSizeKilobytes": "int",
"saLifeTimeSeconds": "int"
}
],
"provisioningState": "string",
"remoteVpnSite": {
"id": "string"
},
"routingWeight": "int",
"sharedKey": "string",
"vpnConnectionProtocolType": "string"
}
}
],
"provisioningState": "string",
"virtualHub": {
"id": "string"
},
"vpnGatewayScaleUnit": "int"
},
"tags": {
"{customized property}": "string"
}
}
属性值
BgpSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| asn | BGP 扬声器的 ASN。 | int |
| bgpPeeringAddress | 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 | 字符串 |
| peerWeight | 添加到从此 BGP 扬声器中学习的路由的权重。 | int |
IpsecPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| dhGroup | IKE 阶段 1 中使用的 DH 组用于初始 SA。 | “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 中用于新子 SA 的 Pfs 组。 | “ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需） |
| saDataSizeKilobytes | IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。 | int （必需） |
| saLifeTimeSeconds | 站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。 | int （必需） |
Microsoft.Network/vpnGateways
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-11-01' |
| 位置 | 资源位置。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | VpnGateway 的参数 | VpnGatewayProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.Network/vpnGateways” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SubResource
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID。 | 字符串 |
VpnConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID。 | 字符串 |
| 名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
| 性能 | VpnConnection 的参数 | VpnConnectionProperties |
VpnConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| connectionBandwidth | 预期带宽（以 MBPS 为单位）。 | int |
| enableBgp | EnableBgp 标志 | bool |
| enableInternetSecurity | 启用 Internet 安全性 | bool |
| enableRateLimiting | EnableBgp 标志 | bool |
| ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
| provisioningState | 资源的预配状态。 | “删除” “Failed” “Succeeded” “正在更新” |
| remoteVpnSite | 连接的 VPN 站点的 ID。 | SubResource |
| routingWeight | VPN 连接的路由权重。 | int |
| sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
| vpnConnectionProtocolType | 用于此连接的连接协议 | “IKEv1” “IKEv2” |
VpnGatewayProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bgpSettings | 本地网络网关的 BGP 扬声器设置。 | BgpSettings |
| 连接 | 指向网关的所有 VPN 连接的列表。 | VpnConnection[] |
| provisioningState | 资源的预配状态。 | “删除” “Failed” “Succeeded” “正在更新” |
| virtualHub | 网关所属的 VirtualHub | SubResource |
| vpnGatewayScaleUnit | 此 VPN 网关的缩放单元。 | int |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
Azure 虚拟 WAN （vWAN） 多中心部署
|
使用此模板可以创建 Azure 虚拟 WAN（vWAN）多中心部署，包括所有网关和 VNET 连接。 |
| 使用自定义路由表 Azure vWAN 多中心部署
|
使用此模板可以创建 Azure 虚拟 WAN（vWAN）多中心部署，包括所有网关和 VNET 连接，并演示路由表用于自定义路由的用法。 |
|
创建虚拟 WAN 资源
|
使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 vpnGateways 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/vpnGateways 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnGateways@2018-11-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
bgpSettings = {
asn = int
bgpPeeringAddress = "string"
peerWeight = int
}
connections = [
{
id = "string"
name = "string"
properties = {
connectionBandwidth = int
enableBgp = bool
enableInternetSecurity = bool
enableRateLimiting = bool
ipsecPolicies = [
{
dhGroup = "string"
ikeEncryption = "string"
ikeIntegrity = "string"
ipsecEncryption = "string"
ipsecIntegrity = "string"
pfsGroup = "string"
saDataSizeKilobytes = int
saLifeTimeSeconds = int
}
]
provisioningState = "string"
remoteVpnSite = {
id = "string"
}
routingWeight = int
sharedKey = "string"
vpnConnectionProtocolType = "string"
}
}
]
provisioningState = "string"
virtualHub = {
id = "string"
}
vpnGatewayScaleUnit = int
}
})
tags = {
{customized property} = "string"
}
}
属性值
BgpSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| asn | BGP 扬声器的 ASN。 | int |
| bgpPeeringAddress | 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 | 字符串 |
| peerWeight | 添加到从此 BGP 扬声器中学习的路由的权重。 | int |
IpsecPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| dhGroup | IKE 阶段 1 中使用的 DH 组用于初始 SA。 | “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 中用于新子 SA 的 Pfs 组。 | “ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需） |
| saDataSizeKilobytes | IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。 | int （必需） |
| saLifeTimeSeconds | 站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。 | int （必需） |
Microsoft.Network/vpnGateways
| 名字 | 描述 | 价值 |
|---|---|---|
| 位置 | 资源位置。 | 字符串 |
| 名字 | 资源名称 | string （必需） |
| 性能 | VpnGateway 的参数 | VpnGatewayProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.Network/vpnGateways@2018-11-01” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SubResource
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID。 | 字符串 |
VpnConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID。 | 字符串 |
| 名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
| 性能 | VpnConnection 的参数 | VpnConnectionProperties |
VpnConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| connectionBandwidth | 预期带宽（以 MBPS 为单位）。 | int |
| enableBgp | EnableBgp 标志 | bool |
| enableInternetSecurity | 启用 Internet 安全性 | bool |
| enableRateLimiting | EnableBgp 标志 | bool |
| ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
| provisioningState | 资源的预配状态。 | “删除” “Failed” “Succeeded” “正在更新” |
| remoteVpnSite | 连接的 VPN 站点的 ID。 | SubResource |
| routingWeight | VPN 连接的路由权重。 | int |
| sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
| vpnConnectionProtocolType | 用于此连接的连接协议 | “IKEv1” “IKEv2” |
VpnGatewayProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bgpSettings | 本地网络网关的 BGP 扬声器设置。 | BgpSettings |
| 连接 | 指向网关的所有 VPN 连接的列表。 | VpnConnection[] |
| provisioningState | 资源的预配状态。 | “删除” “Failed” “Succeeded” “正在更新” |
| virtualHub | 网关所属的 VirtualHub | SubResource |
| vpnGatewayScaleUnit | 此 VPN 网关的缩放单元。 | int |