你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Network vpnGateways
- 最新
- 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@2024-03-01' = {
location: 'string'
name: 'string'
properties: {
bgpSettings: {
asn: int
bgpPeeringAddress: 'string'
bgpPeeringAddresses: [
{
customBgpIpAddresses: [
'string'
]
ipconfigurationId: 'string'
}
]
peerWeight: int
}
connections: [
{
id: 'string'
name: 'string'
properties: {
connectionBandwidth: int
dpdTimeoutSeconds: int
enableBgp: bool
enableInternetSecurity: bool
enableRateLimiting: bool
ipsecPolicies: [
{
dhGroup: 'string'
ikeEncryption: 'string'
ikeIntegrity: 'string'
ipsecEncryption: 'string'
ipsecIntegrity: 'string'
pfsGroup: 'string'
saDataSizeKilobytes: int
saLifeTimeSeconds: int
}
]
remoteVpnSite: {
id: 'string'
}
routingConfiguration: {
associatedRouteTable: {
id: 'string'
}
inboundRouteMap: {
id: 'string'
}
outboundRouteMap: {
id: 'string'
}
propagatedRouteTables: {
ids: [
{
id: 'string'
}
]
labels: [
'string'
]
}
vnetRoutes: {
staticRoutes: [
{
addressPrefixes: [
'string'
]
name: 'string'
nextHopIpAddress: 'string'
}
]
staticRoutesConfig: {
vnetLocalRouteOverrideCriteria: 'string'
}
}
}
routingWeight: int
sharedKey: 'string'
trafficSelectorPolicies: [
{
localAddressRanges: [
'string'
]
remoteAddressRanges: [
'string'
]
}
]
useLocalAzureIpAddress: bool
usePolicyBasedTrafficSelectors: bool
vpnConnectionProtocolType: 'string'
vpnLinkConnections: [
{
id: 'string'
name: 'string'
properties: {
connectionBandwidth: int
dpdTimeoutSeconds: int
egressNatRules: [
{
id: 'string'
}
]
enableBgp: bool
enableRateLimiting: bool
ingressNatRules: [
{
id: 'string'
}
]
ipsecPolicies: [
{
dhGroup: 'string'
ikeEncryption: 'string'
ikeIntegrity: 'string'
ipsecEncryption: 'string'
ipsecIntegrity: 'string'
pfsGroup: 'string'
saDataSizeKilobytes: int
saLifeTimeSeconds: int
}
]
routingWeight: int
sharedKey: 'string'
useLocalAzureIpAddress: bool
usePolicyBasedTrafficSelectors: bool
vpnConnectionProtocolType: 'string'
vpnGatewayCustomBgpAddresses: [
{
customBgpIpAddress: 'string'
ipConfigurationId: 'string'
}
]
vpnLinkConnectionMode: 'string'
vpnSiteLink: {
id: 'string'
}
}
}
]
}
}
]
enableBgpRouteTranslationForNat: bool
isRoutingPreferenceInternet: bool
natRules: [
{
id: 'string'
name: 'string'
properties: {
externalMappings: [
{
addressSpace: 'string'
portRange: 'string'
}
]
internalMappings: [
{
addressSpace: 'string'
portRange: 'string'
}
]
ipConfigurationId: 'string'
mode: 'string'
type: 'string'
}
}
]
virtualHub: {
id: 'string'
}
vpnGatewayScaleUnit: int
}
tags: {
{customized property}: 'string'
}
}
属性值
BgpSettings
名字 | 描述 | 价值 |
---|---|---|
asn | BGP 扬声器的 ASN。 | int 约束: 最小值 = 0 最大值 = 4294967295 |
bgpPeeringAddress | 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 | 字符串 |
bgpPeeringAddresses | 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 | IPConfigurationBgpPeeringAddress[] |
peerWeight | 添加到从此 BGP 扬声器中学习的路由的权重。 | int |
GatewayCustomBgpIpAddressIpConfiguration
名字 | 描述 | 价值 |
---|---|---|
customBgpIpAddress | 属于 IpconfigurationId 的自定义 BgpPeeringAddress。 | string (必需) |
ipConfigurationId | 属于网关的 ipconfiguration 的 IpconfigurationId。 | string (必需) |
IPConfigurationBgpPeeringAddress
名字 | 描述 | 价值 |
---|---|---|
customBgpIpAddresses | 属于 IP 配置的自定义 BGP 对等互连地址的列表。 | string[] |
ipconfigurationId | 属于网关的 IP 配置的 ID。 | 字符串 |
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/vpnGateways
名字 | 描述 | 价值 |
---|---|---|
位置 | 资源位置。 | 字符串 |
名字 | 资源名称 | string (必需) |
性能 | VPN 网关的属性。 | VpnGatewayProperties |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
PropagatedRouteTable
名字 | 描述 | 价值 |
---|---|---|
ids | 所有 RouteTable 的资源 ID 列表。 | SubResource[] |
标签 | 标签列表。 | string[] |
ResourceTags
名字 | 描述 | 价值 |
---|
RoutingConfiguration
名字 | 描述 | 价值 |
---|---|---|
associatedRouteTable | 与此 RoutingConfiguration 关联的资源 ID RouteTable。 | SubResource |
inboundRouteMap | 与此 RoutingConfiguration 关联的 RouteMap 的资源 ID,用于入站学习的路由。 | SubResource |
outboundRouteMap | 与此 RoutingConfiguration 关联的RouteMap 的资源 ID,用于出站播发路由。 | SubResource |
propagatedRouteTables | 要向其播发路由的 RouteTable 列表。 | PropagatedRouteTable |
vnetRoutes | 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 | VnetRoute |
StaticRoute
名字 | 描述 | 价值 |
---|---|---|
addressPrefixes | 所有地址前缀的列表。 | string[] |
名字 | 在 VnetRoute 中唯一的 StaticRoute 的名称。 | 字符串 |
nextHopIpAddress | 下一跃点的 IP 地址。 | 字符串 |
StaticRoutesConfig
名字 | 描述 | 价值 |
---|---|---|
vnetLocalRouteOverrideCriteria | 参数,用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。 | “Contains” “Equal” |
SubResource
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
TrafficSelectorPolicy
名字 | 描述 | 价值 |
---|---|---|
localAddressRanges | CIDR 格式的本地地址空间的集合。 | string[] (必需) |
remoteAddressRanges | 采用 CIDR 格式的远程地址空间集合。 | string[] (必需) |
VnetRoute
名字 | 描述 | 价值 |
---|---|---|
staticRoutes | 所有静态路由的列表。 | StaticRoute[] |
staticRoutesConfig | 此 HubVnetConnection 上的静态路由的配置。 | StaticRoutesConfig |
VpnConnection
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VPN 连接的属性。 | VpnConnectionProperties |
VpnConnectionProperties
名字 | 描述 | 价值 |
---|---|---|
connectionBandwidth | 预期带宽(以 MBPS 为单位)。 | int |
dpdTimeoutSeconds | VPN 连接的 DPD 超时(以秒为单位)。 | int |
enableBgp | EnableBgp 标志。 | bool |
enableInternetSecurity | 启用 Internet 安全性。 | bool |
enableRateLimiting | EnableBgp 标志。 | bool |
ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
remoteVpnSite | 连接的 VPN 站点的 ID。 | SubResource |
routingConfiguration | 路由配置,指示此连接上关联的路由表和传播的路由表。 | RoutingConfiguration |
routingWeight | VPN 连接的路由权重。 | int |
sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
trafficSelectorPolicies | 此连接要考虑的流量选择器策略。 | TrafficSelectorPolicy[] |
useLocalAzureIpAddress | 使用本地 Azure IP 启动连接。 | bool |
usePolicyBasedTrafficSelectors | 启用基于策略的流量选择器。 | bool |
vpnConnectionProtocolType | 用于此连接的连接协议。 | “IKEv1” “IKEv2” |
vpnLinkConnections | 指向网关的所有 VPN 站点链接连接的列表。 | VpnSiteLinkConnection[] |
VpnGatewayNatRule
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VpnGateway NAT 规则的属性。 | VpnGatewayNatRuleProperties |
VpnGatewayNatRuleProperties
名字 | 描述 | 价值 |
---|---|---|
externalMappings | NAT 的专用 IP 地址外部映射。 | VpnNatRuleMapping[] |
internalMappings | NAT 的专用 IP 地址内部映射。 | VpnNatRuleMapping[] |
ipConfigurationId | 此 NAT 规则适用的 IP 配置 ID。 | 字符串 |
模式 | VPN NAT 的源 NAT 方向。 | “EgressSnat” “IngressSnat” |
类型 | VPN NAT 的 NAT 规则的类型。 | “Dynamic” “Static” |
VpnGatewayProperties
名字 | 描述 | 价值 |
---|---|---|
bgpSettings | 本地网络网关的 BGP 扬声器设置。 | BgpSettings |
连接 | 指向网关的所有 VPN 连接的列表。 | VpnConnection[] |
enableBgpRouteTranslationForNat | 在此 VpnGateway 上为 NAT 启用 BGP 路由转换。 | bool |
isRoutingPreferenceInternet | 为 VpnGateway 的公共 IP 接口启用路由首选项属性。 | bool |
natRules | 与网关关联的所有 nat 规则的列表。 | VpnGatewayNatRule[] |
virtualHub | 网关所属的 VirtualHub。 | SubResource |
vpnGatewayScaleUnit | 此 VPN 网关的缩放单元。 | int |
VpnNatRuleMapping
名字 | 描述 | 价值 |
---|---|---|
addressSpace | Vpn NatRule 映射的地址空间。 | 字符串 |
portRange | Vpn NatRule 映射的端口范围。 | 字符串 |
VpnSiteLinkConnection
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VPN 站点链接连接的属性。 | VpnSiteLinkConnectionProperties |
VpnSiteLinkConnectionProperties
名字 | 描述 | 价值 |
---|---|---|
connectionBandwidth | 预期带宽(以 MBPS 为单位)。 | int |
dpdTimeoutSeconds | VpnLink 连接的死对等检测超时(以秒为单位)。 | int |
egressNatRules | 出口 NatRules 列表。 | SubResource[] |
enableBgp | EnableBgp 标志。 | bool |
enableRateLimiting | EnableBgp 标志。 | bool |
ingressNatRules | 入口 NatRules 列表。 | SubResource[] |
ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
routingWeight | VPN 连接的路由权重。 | int |
sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
useLocalAzureIpAddress | 使用本地 Azure IP 启动连接。 | bool |
usePolicyBasedTrafficSelectors | 启用基于策略的流量选择器。 | bool |
vpnConnectionProtocolType | 用于此连接的连接协议。 | “IKEv1” “IKEv2” |
vpnGatewayCustomBgpAddresses | 此连接使用的 vpnGatewayCustomBgpAddresses。 | GatewayCustomBgpIpAddressIpConfiguration[] |
vpnLinkConnectionMode | Vpn 链接连接模式。 | “Default” “InitiatorOnly” “ResponderOnly” |
vpnSiteLink | 连接的 VPN 站点链接的 ID。 | SubResource |
快速入门示例
以下快速入门示例部署此资源类型。
Bicep 文件 | 描述 |
---|---|
创建虚拟 WAN 资源 | 使用此模板可以创建虚拟 WAN 资源,包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。 |
ARM 模板资源定义
可以使用目标操作部署 vpnGateways 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/vpnGateways 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/vpnGateways",
"apiVersion": "2024-03-01",
"name": "string",
"location": "string",
"properties": {
"bgpSettings": {
"asn": "int",
"bgpPeeringAddress": "string",
"bgpPeeringAddresses": [
{
"customBgpIpAddresses": [ "string" ],
"ipconfigurationId": "string"
}
],
"peerWeight": "int"
},
"connections": [
{
"id": "string",
"name": "string",
"properties": {
"connectionBandwidth": "int",
"dpdTimeoutSeconds": "int",
"enableBgp": "bool",
"enableInternetSecurity": "bool",
"enableRateLimiting": "bool",
"ipsecPolicies": [
{
"dhGroup": "string",
"ikeEncryption": "string",
"ikeIntegrity": "string",
"ipsecEncryption": "string",
"ipsecIntegrity": "string",
"pfsGroup": "string",
"saDataSizeKilobytes": "int",
"saLifeTimeSeconds": "int"
}
],
"remoteVpnSite": {
"id": "string"
},
"routingConfiguration": {
"associatedRouteTable": {
"id": "string"
},
"inboundRouteMap": {
"id": "string"
},
"outboundRouteMap": {
"id": "string"
},
"propagatedRouteTables": {
"ids": [
{
"id": "string"
}
],
"labels": [ "string" ]
},
"vnetRoutes": {
"staticRoutes": [
{
"addressPrefixes": [ "string" ],
"name": "string",
"nextHopIpAddress": "string"
}
],
"staticRoutesConfig": {
"vnetLocalRouteOverrideCriteria": "string"
}
}
},
"routingWeight": "int",
"sharedKey": "string",
"trafficSelectorPolicies": [
{
"localAddressRanges": [ "string" ],
"remoteAddressRanges": [ "string" ]
}
],
"useLocalAzureIpAddress": "bool",
"usePolicyBasedTrafficSelectors": "bool",
"vpnConnectionProtocolType": "string",
"vpnLinkConnections": [
{
"id": "string",
"name": "string",
"properties": {
"connectionBandwidth": "int",
"dpdTimeoutSeconds": "int",
"egressNatRules": [
{
"id": "string"
}
],
"enableBgp": "bool",
"enableRateLimiting": "bool",
"ingressNatRules": [
{
"id": "string"
}
],
"ipsecPolicies": [
{
"dhGroup": "string",
"ikeEncryption": "string",
"ikeIntegrity": "string",
"ipsecEncryption": "string",
"ipsecIntegrity": "string",
"pfsGroup": "string",
"saDataSizeKilobytes": "int",
"saLifeTimeSeconds": "int"
}
],
"routingWeight": "int",
"sharedKey": "string",
"useLocalAzureIpAddress": "bool",
"usePolicyBasedTrafficSelectors": "bool",
"vpnConnectionProtocolType": "string",
"vpnGatewayCustomBgpAddresses": [
{
"customBgpIpAddress": "string",
"ipConfigurationId": "string"
}
],
"vpnLinkConnectionMode": "string",
"vpnSiteLink": {
"id": "string"
}
}
}
]
}
}
],
"enableBgpRouteTranslationForNat": "bool",
"isRoutingPreferenceInternet": "bool",
"natRules": [
{
"id": "string",
"name": "string",
"properties": {
"externalMappings": [
{
"addressSpace": "string",
"portRange": "string"
}
],
"internalMappings": [
{
"addressSpace": "string",
"portRange": "string"
}
],
"ipConfigurationId": "string",
"mode": "string",
"type": "string"
}
}
],
"virtualHub": {
"id": "string"
},
"vpnGatewayScaleUnit": "int"
},
"tags": {
"{customized property}": "string"
}
}
属性值
BgpSettings
名字 | 描述 | 价值 |
---|---|---|
asn | BGP 扬声器的 ASN。 | int 约束: 最小值 = 0 最大值 = 4294967295 |
bgpPeeringAddress | 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 | 字符串 |
bgpPeeringAddresses | 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 | IPConfigurationBgpPeeringAddress[] |
peerWeight | 添加到从此 BGP 扬声器中学习的路由的权重。 | int |
GatewayCustomBgpIpAddressIpConfiguration
名字 | 描述 | 价值 |
---|---|---|
customBgpIpAddress | 属于 IpconfigurationId 的自定义 BgpPeeringAddress。 | string (必需) |
ipConfigurationId | 属于网关的 ipconfiguration 的 IpconfigurationId。 | string (必需) |
IPConfigurationBgpPeeringAddress
名字 | 描述 | 价值 |
---|---|---|
customBgpIpAddresses | 属于 IP 配置的自定义 BGP 对等互连地址的列表。 | string[] |
ipconfigurationId | 属于网关的 IP 配置的 ID。 | 字符串 |
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/vpnGateways
名字 | 描述 | 价值 |
---|---|---|
apiVersion | API 版本 | '2024-03-01' |
位置 | 资源位置。 | 字符串 |
名字 | 资源名称 | string (必需) |
性能 | VPN 网关的属性。 | VpnGatewayProperties |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
类型 | 资源类型 | “Microsoft.Network/vpnGateways” |
PropagatedRouteTable
名字 | 描述 | 价值 |
---|---|---|
ids | 所有 RouteTable 的资源 ID 列表。 | SubResource[] |
标签 | 标签列表。 | string[] |
ResourceTags
名字 | 描述 | 价值 |
---|
RoutingConfiguration
名字 | 描述 | 价值 |
---|---|---|
associatedRouteTable | 与此 RoutingConfiguration 关联的资源 ID RouteTable。 | SubResource |
inboundRouteMap | 与此 RoutingConfiguration 关联的 RouteMap 的资源 ID,用于入站学习的路由。 | SubResource |
outboundRouteMap | 与此 RoutingConfiguration 关联的RouteMap 的资源 ID,用于出站播发路由。 | SubResource |
propagatedRouteTables | 要向其播发路由的 RouteTable 列表。 | PropagatedRouteTable |
vnetRoutes | 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 | VnetRoute |
StaticRoute
名字 | 描述 | 价值 |
---|---|---|
addressPrefixes | 所有地址前缀的列表。 | string[] |
名字 | 在 VnetRoute 中唯一的 StaticRoute 的名称。 | 字符串 |
nextHopIpAddress | 下一跃点的 IP 地址。 | 字符串 |
StaticRoutesConfig
名字 | 描述 | 价值 |
---|---|---|
vnetLocalRouteOverrideCriteria | 参数,用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。 | “Contains” “Equal” |
SubResource
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
TrafficSelectorPolicy
名字 | 描述 | 价值 |
---|---|---|
localAddressRanges | CIDR 格式的本地地址空间的集合。 | string[] (必需) |
remoteAddressRanges | 采用 CIDR 格式的远程地址空间集合。 | string[] (必需) |
VnetRoute
名字 | 描述 | 价值 |
---|---|---|
staticRoutes | 所有静态路由的列表。 | StaticRoute[] |
staticRoutesConfig | 此 HubVnetConnection 上的静态路由的配置。 | StaticRoutesConfig |
VpnConnection
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VPN 连接的属性。 | VpnConnectionProperties |
VpnConnectionProperties
名字 | 描述 | 价值 |
---|---|---|
connectionBandwidth | 预期带宽(以 MBPS 为单位)。 | int |
dpdTimeoutSeconds | VPN 连接的 DPD 超时(以秒为单位)。 | int |
enableBgp | EnableBgp 标志。 | bool |
enableInternetSecurity | 启用 Internet 安全性。 | bool |
enableRateLimiting | EnableBgp 标志。 | bool |
ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
remoteVpnSite | 连接的 VPN 站点的 ID。 | SubResource |
routingConfiguration | 路由配置,指示此连接上关联的路由表和传播的路由表。 | RoutingConfiguration |
routingWeight | VPN 连接的路由权重。 | int |
sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
trafficSelectorPolicies | 此连接要考虑的流量选择器策略。 | TrafficSelectorPolicy[] |
useLocalAzureIpAddress | 使用本地 Azure IP 启动连接。 | bool |
usePolicyBasedTrafficSelectors | 启用基于策略的流量选择器。 | bool |
vpnConnectionProtocolType | 用于此连接的连接协议。 | “IKEv1” “IKEv2” |
vpnLinkConnections | 指向网关的所有 VPN 站点链接连接的列表。 | VpnSiteLinkConnection[] |
VpnGatewayNatRule
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VpnGateway NAT 规则的属性。 | VpnGatewayNatRuleProperties |
VpnGatewayNatRuleProperties
名字 | 描述 | 价值 |
---|---|---|
externalMappings | NAT 的专用 IP 地址外部映射。 | VpnNatRuleMapping[] |
internalMappings | NAT 的专用 IP 地址内部映射。 | VpnNatRuleMapping[] |
ipConfigurationId | 此 NAT 规则适用的 IP 配置 ID。 | 字符串 |
模式 | VPN NAT 的源 NAT 方向。 | “EgressSnat” “IngressSnat” |
类型 | VPN NAT 的 NAT 规则的类型。 | “Dynamic” “Static” |
VpnGatewayProperties
名字 | 描述 | 价值 |
---|---|---|
bgpSettings | 本地网络网关的 BGP 扬声器设置。 | BgpSettings |
连接 | 指向网关的所有 VPN 连接的列表。 | VpnConnection[] |
enableBgpRouteTranslationForNat | 在此 VpnGateway 上为 NAT 启用 BGP 路由转换。 | bool |
isRoutingPreferenceInternet | 为 VpnGateway 的公共 IP 接口启用路由首选项属性。 | bool |
natRules | 与网关关联的所有 nat 规则的列表。 | VpnGatewayNatRule[] |
virtualHub | 网关所属的 VirtualHub。 | SubResource |
vpnGatewayScaleUnit | 此 VPN 网关的缩放单元。 | int |
VpnNatRuleMapping
名字 | 描述 | 价值 |
---|---|---|
addressSpace | Vpn NatRule 映射的地址空间。 | 字符串 |
portRange | Vpn NatRule 映射的端口范围。 | 字符串 |
VpnSiteLinkConnection
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VPN 站点链接连接的属性。 | VpnSiteLinkConnectionProperties |
VpnSiteLinkConnectionProperties
名字 | 描述 | 价值 |
---|---|---|
connectionBandwidth | 预期带宽(以 MBPS 为单位)。 | int |
dpdTimeoutSeconds | VpnLink 连接的死对等检测超时(以秒为单位)。 | int |
egressNatRules | 出口 NatRules 列表。 | SubResource[] |
enableBgp | EnableBgp 标志。 | bool |
enableRateLimiting | EnableBgp 标志。 | bool |
ingressNatRules | 入口 NatRules 列表。 | SubResource[] |
ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
routingWeight | VPN 连接的路由权重。 | int |
sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
useLocalAzureIpAddress | 使用本地 Azure IP 启动连接。 | bool |
usePolicyBasedTrafficSelectors | 启用基于策略的流量选择器。 | bool |
vpnConnectionProtocolType | 用于此连接的连接协议。 | “IKEv1” “IKEv2” |
vpnGatewayCustomBgpAddresses | 此连接使用的 vpnGatewayCustomBgpAddresses。 | GatewayCustomBgpIpAddressIpConfiguration[] |
vpnLinkConnectionMode | Vpn 链接连接模式。 | “Default” “InitiatorOnly” “ResponderOnly” |
vpnSiteLink | 连接的 VPN 站点链接的 ID。 | SubResource |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
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@2024-03-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
bgpSettings = {
asn = int
bgpPeeringAddress = "string"
bgpPeeringAddresses = [
{
customBgpIpAddresses = [
"string"
]
ipconfigurationId = "string"
}
]
peerWeight = int
}
connections = [
{
id = "string"
name = "string"
properties = {
connectionBandwidth = int
dpdTimeoutSeconds = int
enableBgp = bool
enableInternetSecurity = bool
enableRateLimiting = bool
ipsecPolicies = [
{
dhGroup = "string"
ikeEncryption = "string"
ikeIntegrity = "string"
ipsecEncryption = "string"
ipsecIntegrity = "string"
pfsGroup = "string"
saDataSizeKilobytes = int
saLifeTimeSeconds = int
}
]
remoteVpnSite = {
id = "string"
}
routingConfiguration = {
associatedRouteTable = {
id = "string"
}
inboundRouteMap = {
id = "string"
}
outboundRouteMap = {
id = "string"
}
propagatedRouteTables = {
ids = [
{
id = "string"
}
]
labels = [
"string"
]
}
vnetRoutes = {
staticRoutes = [
{
addressPrefixes = [
"string"
]
name = "string"
nextHopIpAddress = "string"
}
]
staticRoutesConfig = {
vnetLocalRouteOverrideCriteria = "string"
}
}
}
routingWeight = int
sharedKey = "string"
trafficSelectorPolicies = [
{
localAddressRanges = [
"string"
]
remoteAddressRanges = [
"string"
]
}
]
useLocalAzureIpAddress = bool
usePolicyBasedTrafficSelectors = bool
vpnConnectionProtocolType = "string"
vpnLinkConnections = [
{
id = "string"
name = "string"
properties = {
connectionBandwidth = int
dpdTimeoutSeconds = int
egressNatRules = [
{
id = "string"
}
]
enableBgp = bool
enableRateLimiting = bool
ingressNatRules = [
{
id = "string"
}
]
ipsecPolicies = [
{
dhGroup = "string"
ikeEncryption = "string"
ikeIntegrity = "string"
ipsecEncryption = "string"
ipsecIntegrity = "string"
pfsGroup = "string"
saDataSizeKilobytes = int
saLifeTimeSeconds = int
}
]
routingWeight = int
sharedKey = "string"
useLocalAzureIpAddress = bool
usePolicyBasedTrafficSelectors = bool
vpnConnectionProtocolType = "string"
vpnGatewayCustomBgpAddresses = [
{
customBgpIpAddress = "string"
ipConfigurationId = "string"
}
]
vpnLinkConnectionMode = "string"
vpnSiteLink = {
id = "string"
}
}
}
]
}
}
]
enableBgpRouteTranslationForNat = bool
isRoutingPreferenceInternet = bool
natRules = [
{
id = "string"
name = "string"
properties = {
externalMappings = [
{
addressSpace = "string"
portRange = "string"
}
]
internalMappings = [
{
addressSpace = "string"
portRange = "string"
}
]
ipConfigurationId = "string"
mode = "string"
type = "string"
}
}
]
virtualHub = {
id = "string"
}
vpnGatewayScaleUnit = int
}
})
tags = {
{customized property} = "string"
}
}
属性值
BgpSettings
名字 | 描述 | 价值 |
---|---|---|
asn | BGP 扬声器的 ASN。 | int 约束: 最小值 = 0 最大值 = 4294967295 |
bgpPeeringAddress | 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 | 字符串 |
bgpPeeringAddresses | 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 | IPConfigurationBgpPeeringAddress[] |
peerWeight | 添加到从此 BGP 扬声器中学习的路由的权重。 | int |
GatewayCustomBgpIpAddressIpConfiguration
名字 | 描述 | 价值 |
---|---|---|
customBgpIpAddress | 属于 IpconfigurationId 的自定义 BgpPeeringAddress。 | string (必需) |
ipConfigurationId | 属于网关的 ipconfiguration 的 IpconfigurationId。 | string (必需) |
IPConfigurationBgpPeeringAddress
名字 | 描述 | 价值 |
---|---|---|
customBgpIpAddresses | 属于 IP 配置的自定义 BGP 对等互连地址的列表。 | string[] |
ipconfigurationId | 属于网关的 IP 配置的 ID。 | 字符串 |
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/vpnGateways
名字 | 描述 | 价值 |
---|---|---|
位置 | 资源位置。 | 字符串 |
名字 | 资源名称 | string (必需) |
性能 | VPN 网关的属性。 | VpnGatewayProperties |
标签 | 资源标记 | 标记名称和值的字典。 |
类型 | 资源类型 | “Microsoft.Network/vpnGateways@2024-03-01” |
PropagatedRouteTable
名字 | 描述 | 价值 |
---|---|---|
ids | 所有 RouteTable 的资源 ID 列表。 | SubResource[] |
标签 | 标签列表。 | string[] |
ResourceTags
名字 | 描述 | 价值 |
---|
RoutingConfiguration
名字 | 描述 | 价值 |
---|---|---|
associatedRouteTable | 与此 RoutingConfiguration 关联的资源 ID RouteTable。 | SubResource |
inboundRouteMap | 与此 RoutingConfiguration 关联的 RouteMap 的资源 ID,用于入站学习的路由。 | SubResource |
outboundRouteMap | 与此 RoutingConfiguration 关联的RouteMap 的资源 ID,用于出站播发路由。 | SubResource |
propagatedRouteTables | 要向其播发路由的 RouteTable 列表。 | PropagatedRouteTable |
vnetRoutes | 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 | VnetRoute |
StaticRoute
名字 | 描述 | 价值 |
---|---|---|
addressPrefixes | 所有地址前缀的列表。 | string[] |
名字 | 在 VnetRoute 中唯一的 StaticRoute 的名称。 | 字符串 |
nextHopIpAddress | 下一跃点的 IP 地址。 | 字符串 |
StaticRoutesConfig
名字 | 描述 | 价值 |
---|---|---|
vnetLocalRouteOverrideCriteria | 参数,用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。 | “Contains” “Equal” |
SubResource
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
TrafficSelectorPolicy
名字 | 描述 | 价值 |
---|---|---|
localAddressRanges | CIDR 格式的本地地址空间的集合。 | string[] (必需) |
remoteAddressRanges | 采用 CIDR 格式的远程地址空间集合。 | string[] (必需) |
VnetRoute
名字 | 描述 | 价值 |
---|---|---|
staticRoutes | 所有静态路由的列表。 | StaticRoute[] |
staticRoutesConfig | 此 HubVnetConnection 上的静态路由的配置。 | StaticRoutesConfig |
VpnConnection
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VPN 连接的属性。 | VpnConnectionProperties |
VpnConnectionProperties
名字 | 描述 | 价值 |
---|---|---|
connectionBandwidth | 预期带宽(以 MBPS 为单位)。 | int |
dpdTimeoutSeconds | VPN 连接的 DPD 超时(以秒为单位)。 | int |
enableBgp | EnableBgp 标志。 | bool |
enableInternetSecurity | 启用 Internet 安全性。 | bool |
enableRateLimiting | EnableBgp 标志。 | bool |
ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
remoteVpnSite | 连接的 VPN 站点的 ID。 | SubResource |
routingConfiguration | 路由配置,指示此连接上关联的路由表和传播的路由表。 | RoutingConfiguration |
routingWeight | VPN 连接的路由权重。 | int |
sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
trafficSelectorPolicies | 此连接要考虑的流量选择器策略。 | TrafficSelectorPolicy[] |
useLocalAzureIpAddress | 使用本地 Azure IP 启动连接。 | bool |
usePolicyBasedTrafficSelectors | 启用基于策略的流量选择器。 | bool |
vpnConnectionProtocolType | 用于此连接的连接协议。 | “IKEv1” “IKEv2” |
vpnLinkConnections | 指向网关的所有 VPN 站点链接连接的列表。 | VpnSiteLinkConnection[] |
VpnGatewayNatRule
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VpnGateway NAT 规则的属性。 | VpnGatewayNatRuleProperties |
VpnGatewayNatRuleProperties
名字 | 描述 | 价值 |
---|---|---|
externalMappings | NAT 的专用 IP 地址外部映射。 | VpnNatRuleMapping[] |
internalMappings | NAT 的专用 IP 地址内部映射。 | VpnNatRuleMapping[] |
ipConfigurationId | 此 NAT 规则适用的 IP 配置 ID。 | 字符串 |
模式 | VPN NAT 的源 NAT 方向。 | “EgressSnat” “IngressSnat” |
类型 | VPN NAT 的 NAT 规则的类型。 | “Dynamic” “Static” |
VpnGatewayProperties
名字 | 描述 | 价值 |
---|---|---|
bgpSettings | 本地网络网关的 BGP 扬声器设置。 | BgpSettings |
连接 | 指向网关的所有 VPN 连接的列表。 | VpnConnection[] |
enableBgpRouteTranslationForNat | 在此 VpnGateway 上为 NAT 启用 BGP 路由转换。 | bool |
isRoutingPreferenceInternet | 为 VpnGateway 的公共 IP 接口启用路由首选项属性。 | bool |
natRules | 与网关关联的所有 nat 规则的列表。 | VpnGatewayNatRule[] |
virtualHub | 网关所属的 VirtualHub。 | SubResource |
vpnGatewayScaleUnit | 此 VPN 网关的缩放单元。 | int |
VpnNatRuleMapping
名字 | 描述 | 价值 |
---|---|---|
addressSpace | Vpn NatRule 映射的地址空间。 | 字符串 |
portRange | Vpn NatRule 映射的端口范围。 | 字符串 |
VpnSiteLinkConnection
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID。 | 字符串 |
名字 | 资源组中唯一的资源的名称。 此名称可用于访问资源。 | 字符串 |
性能 | VPN 站点链接连接的属性。 | VpnSiteLinkConnectionProperties |
VpnSiteLinkConnectionProperties
名字 | 描述 | 价值 |
---|---|---|
connectionBandwidth | 预期带宽(以 MBPS 为单位)。 | int |
dpdTimeoutSeconds | VpnLink 连接的死对等检测超时(以秒为单位)。 | int |
egressNatRules | 出口 NatRules 列表。 | SubResource[] |
enableBgp | EnableBgp 标志。 | bool |
enableRateLimiting | EnableBgp 标志。 | bool |
ingressNatRules | 入口 NatRules 列表。 | SubResource[] |
ipsecPolicies | 此连接要考虑的 IPSec 策略。 | IpsecPolicy[] |
routingWeight | VPN 连接的路由权重。 | int |
sharedKey | 用于 VPN 连接的 SharedKey。 | 字符串 |
useLocalAzureIpAddress | 使用本地 Azure IP 启动连接。 | bool |
usePolicyBasedTrafficSelectors | 启用基于策略的流量选择器。 | bool |
vpnConnectionProtocolType | 用于此连接的连接协议。 | “IKEv1” “IKEv2” |
vpnGatewayCustomBgpAddresses | 此连接使用的 vpnGatewayCustomBgpAddresses。 | GatewayCustomBgpIpAddressIpConfiguration[] |
vpnLinkConnectionMode | Vpn 链接连接模式。 | “Default” “InitiatorOnly” “ResponderOnly” |
vpnSiteLink | 连接的 VPN 站点链接的 ID。 | SubResource |