通过

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

Microsoft.网络连接 2023-04-01

  • 项目

Bicep 资源定义

可以使用目标操作部署连接资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/connections 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/connections@2023-04-01' = {
  location: 'string'
  name: 'string'
  properties: {
    authorizationKey: 'string'
    connectionMode: 'string'
    connectionProtocol: 'string'
    connectionType: 'string'
    dpdTimeoutSeconds: int
    egressNatRules: [
      {
        id: 'string'
      }
    ]
    enableBgp: bool
    enablePrivateLinkFastPath: bool
    expressRouteGatewayBypass: bool
    gatewayCustomBgpIpAddresses: [
      {
        customBgpIpAddress: 'string'
        ipConfigurationId: 'string'
      }
    ]
    ingressNatRules: [
      {
        id: 'string'
      }
    ]
    ipsecPolicies: [
      {
        dhGroup: 'string'
        ikeEncryption: 'string'
        ikeIntegrity: 'string'
        ipsecEncryption: 'string'
        ipsecIntegrity: 'string'
        pfsGroup: 'string'
        saDataSizeKilobytes: int
        saLifeTimeSeconds: int
      }
    ]
    localNetworkGateway2: {
      id: 'string'
      location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          bgpPeeringAddresses: [
            {
              customBgpIpAddresses: [
                'string'
              ]
              ipconfigurationId: 'string'
            }
          ]
          peerWeight: int
        }
        fqdn: 'string'
        gatewayIpAddress: 'string'
        localNetworkAddressSpace: {
          addressPrefixes: [
            'string'
          ]
        }
      }
      tags: {
        {customized property}: 'string'
      }
    }
    peer: {
      id: 'string'
    }
    routingWeight: int
    sharedKey: 'string'
    trafficSelectorPolicies: [
      {
        localAddressRanges: [
          'string'
        ]
        remoteAddressRanges: [
          'string'
        ]
      }
    ]
    useLocalAzureIpAddress: bool
    usePolicyBasedTrafficSelectors: bool
    virtualNetworkGateway1: {
      extendedLocation: {
        name: 'string'
        type: 'string'
      }
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        adminState: 'string'
        allowRemoteVnetTraffic: bool
        allowVirtualWanTraffic: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          bgpPeeringAddresses: [
            {
              customBgpIpAddresses: [
                'string'
              ]
              ipconfigurationId: 'string'
            }
          ]
          peerWeight: int
        }
        customRoutes: {
          addressPrefixes: [
            'string'
          ]
        }
        disableIPSecReplayProtection: bool
        enableBgp: bool
        enableBgpRouteTranslationForNat: bool
        enableDnsForwarding: bool
        enablePrivateIpAddress: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        natRules: [
          {
            id: 'string'
            name: 'string'
            properties: {
              externalMappings: [
                {
                  addressSpace: 'string'
                  portRange: 'string'
                }
              ]
              internalMappings: [
                {
                  addressSpace: 'string'
                  portRange: 'string'
                }
              ]
              ipConfigurationId: 'string'
              mode: 'string'
              type: 'string'
            }
          }
        ]
        sku: {
          name: 'string'
          tier: 'string'
        }
        virtualNetworkGatewayPolicyGroups: [
          {
            id: 'string'
            name: 'string'
            properties: {
              isDefault: bool
              policyMembers: [
                {
                  attributeType: 'string'
                  attributeValue: 'string'
                  name: 'string'
                }
              ]
              priority: int
            }
          }
        ]
        vNetExtendedLocationResourceId: 'string'
        vpnClientConfiguration: {
          aadAudience: 'string'
          aadIssuer: 'string'
          aadTenant: 'string'
          radiusServerAddress: 'string'
          radiusServers: [
            {
              radiusServerAddress: 'string'
              radiusServerScore: int
              radiusServerSecret: 'string'
            }
          ]
          radiusServerSecret: 'string'
          vngClientConnectionConfigurations: [
            {
              id: 'string'
              name: 'string'
              properties: {
                virtualNetworkGatewayPolicyGroups: [
                  {
                    id: 'string'
                  }
                ]
                vpnClientAddressPool: {
                  addressPrefixes: [
                    'string'
                  ]
                }
              }
            }
          ]
          vpnAuthenticationTypes: [
            'string'
          ]
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientIpsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          vpnClientProtocols: [
            'string'
          ]
          vpnClientRevokedCertificates: [
            {
              id: 'string'
              name: 'string'
              properties: {
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              id: 'string'
              name: 'string'
              properties: {
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnGatewayGeneration: 'string'
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    virtualNetworkGateway2: {
      extendedLocation: {
        name: 'string'
        type: 'string'
      }
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        adminState: 'string'
        allowRemoteVnetTraffic: bool
        allowVirtualWanTraffic: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          bgpPeeringAddresses: [
            {
              customBgpIpAddresses: [
                'string'
              ]
              ipconfigurationId: 'string'
            }
          ]
          peerWeight: int
        }
        customRoutes: {
          addressPrefixes: [
            'string'
          ]
        }
        disableIPSecReplayProtection: bool
        enableBgp: bool
        enableBgpRouteTranslationForNat: bool
        enableDnsForwarding: bool
        enablePrivateIpAddress: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        natRules: [
          {
            id: 'string'
            name: 'string'
            properties: {
              externalMappings: [
                {
                  addressSpace: 'string'
                  portRange: 'string'
                }
              ]
              internalMappings: [
                {
                  addressSpace: 'string'
                  portRange: 'string'
                }
              ]
              ipConfigurationId: 'string'
              mode: 'string'
              type: 'string'
            }
          }
        ]
        sku: {
          name: 'string'
          tier: 'string'
        }
        virtualNetworkGatewayPolicyGroups: [
          {
            id: 'string'
            name: 'string'
            properties: {
              isDefault: bool
              policyMembers: [
                {
                  attributeType: 'string'
                  attributeValue: 'string'
                  name: 'string'
                }
              ]
              priority: int
            }
          }
        ]
        vNetExtendedLocationResourceId: 'string'
        vpnClientConfiguration: {
          aadAudience: 'string'
          aadIssuer: 'string'
          aadTenant: 'string'
          radiusServerAddress: 'string'
          radiusServers: [
            {
              radiusServerAddress: 'string'
              radiusServerScore: int
              radiusServerSecret: 'string'
            }
          ]
          radiusServerSecret: 'string'
          vngClientConnectionConfigurations: [
            {
              id: 'string'
              name: 'string'
              properties: {
                virtualNetworkGatewayPolicyGroups: [
                  {
                    id: 'string'
                  }
                ]
                vpnClientAddressPool: {
                  addressPrefixes: [
                    'string'
                  ]
                }
              }
            }
          ]
          vpnAuthenticationTypes: [
            'string'
          ]
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientIpsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          vpnClientProtocols: [
            'string'
          ]
          vpnClientRevokedCertificates: [
            {
              id: 'string'
              name: 'string'
              properties: {
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              id: 'string'
              name: 'string'
              properties: {
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnGatewayGeneration: 'string'
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AddressSpace

名字 描述 价值
addressPrefixes CIDR 表示法中为此虚拟网络保留的地址块列表。 string[]

BgpSettings

名字 描述 价值
asn BGP 扬声器的 ASN。 int

约束：
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 字符串
bgpPeeringAddresses 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 IPConfigurationBgpPeeringAddress[]
peerWeight 添加到从此 BGP 扬声器中学习的路由的权重。 int

ExtendedLocation

名字 描述 价值
名字 扩展位置的名称。 字符串
类型 扩展位置的类型。 “EdgeZone”

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 （必需）

LocalNetworkGateway

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 本地网络网关的属性。 LocalNetworkGatewayPropertiesFormat （必需）
标签 资源标记。 ResourceTags

LocalNetworkGatewayPropertiesFormat

名字 描述 价值
bgpSettings 本地网络网关的 BGP 扬声器设置。 BgpSettings
fqdn 本地网关的 FQDN。 字符串
gatewayIpAddress 本地网络网关的 IP 地址。 字符串
localNetworkAddressSpace 本地网络站点地址空间。 AddressSpace

Microsoft.Network/connections

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 string （必需）
性能 虚拟网络网关连接的属性。 VirtualNetworkGatewayConnectionPropertiesFormat （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

RadiusServer

名字 描述 价值
radiusServerAddress 此半径服务器的地址。 string （必需）
radiusServerScore 分配给此半径服务器的初始分数。 int
radiusServerSecret 用于此半径服务器的机密。 字符串

ResourceTags

名字 描述 价值

ResourceTags

名字 描述 价值

ResourceTags

名字 描述 价值

SubResource

名字 描述 价值
id 资源 ID。 字符串

TrafficSelectorPolicy

名字 描述 价值
localAddressRanges CIDR 格式的本地地址空间的集合。 string[] （必需）
remoteAddressRanges 采用 CIDR 格式的远程地址空间集合。 string[] （必需）

VirtualNetworkGateway

名字 描述 价值
extendedLocation 本地虚拟网络网关类型的扩展位置。 ExtendedLocation
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 虚拟网络网关的属性。 VirtualNetworkGatewayPropertiesFormat （必需）
标签 资源标记。 ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字 描述 价值
authorizationKey authorizationKey。 字符串
connectionMode 此连接的连接模式。 “Default”
“InitiatorOnly”
“ResponderOnly”
connectionProtocol 用于此连接的连接协议。 “IKEv1”
“IKEv2”
connectionType 网关连接类型。 “ExpressRoute”
“IPsec”
“Vnet2Vnet”
“VPNClient”（必需）
dpdTimeoutSeconds 此连接的死对等检测超时（以秒为单位）。 int
egressNatRules 出口 NatRules 列表。 SubResource[]
enableBgp EnableBgp 标志。 bool
enablePrivateLinkFastPath 访问专用链接时绕过 ExpressRoute 网关。 必须启用 ExpressRoute FastPath （expressRouteGatewayBypass）。 bool
expressRouteGatewayBypass 绕过 ExpressRoute 网关进行数据转发。 bool
gatewayCustomBgpIpAddresses 用于虚拟网络网关连接的 GatewayCustomBgpIpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
ingressNatRules 入口 NatRules 列表。 SubResource[]
ipsecPolicies 此连接要考虑的 IPSec 策略。 IpsecPolicy[]
localNetworkGateway2 对本地网络网关资源的引用。 LocalNetworkGateway
同辈 对等互连资源的引用。 SubResource
routingWeight 路由权重。 int
sharedKey IPSec 共享密钥。 字符串
trafficSelectorPolicies 此连接要考虑的流量选择器策略。 TrafficSelectorPolicy[]
useLocalAzureIpAddress 将专用本地 Azure IP 用于连接。 bool
usePolicyBasedTrafficSelectors 启用基于策略的流量选择器。 bool
virtualNetworkGateway1 对虚拟网络网关资源的引用。 VirtualNetworkGateway （必需）
virtualNetworkGateway2 对虚拟网络网关资源的引用。 VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 虚拟网络网关 IP 配置的属性。 VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字 描述 价值
privateIPAllocationMethod 专用 IP 地址分配方法。 “Dynamic”
“Static”
publicIPAddress 对公共 IP 资源的引用。 SubResource
子 对子网资源的引用。 SubResource

VirtualNetworkGatewayNatRule

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 虚拟网络网关 NAT 规则的属性。 VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

名字 描述 价值
externalMappings NAT 的专用 IP 地址外部映射。 VpnNatRuleMapping[]
internalMappings NAT 的专用 IP 地址内部映射。 VpnNatRuleMapping[]
ipConfigurationId 此 NAT 规则适用的 IP 配置 ID。 字符串
模式 VPN NAT 的源 NAT 方向。 “EgressSnat”
“IngressSnat”
类型 VPN NAT 的 NAT 规则的类型。 “Dynamic”
“Static”

VirtualNetworkGatewayPolicyGroup

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 tVirtualNetworkGatewayPolicyGroup 的属性。 VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPolicyGroupMember

名字 描述 价值
attributeType Vpn Policy 成员属性类型。 “AADGroupId”
“CertificateGroupId”
“RadiusAzureGroupId”
attributeValue 用于此 VirtualNetworkGatewayPolicyGroupMember 的属性的值。 字符串
名字 VirtualNetworkGatewayPolicyGroupMember 的名称。 字符串

VirtualNetworkGatewayPolicyGroupProperties

名字 描述 价值
isDefault 显示这是否为默认 VirtualNetworkGatewayPolicyGroup。 bool （必需）
policyMembers VirtualNetworkGatewayPolicyGroup 的多个 PolicyMembers。 VirtualNetworkGatewayPolicyGroupMember[] （必需）
优先权 VirtualNetworkGatewayPolicyGroup 的优先级。 int （必需）

VirtualNetworkGatewayPropertiesFormat

名字 描述 价值
activeActive ActiveActive 标志。 bool
adminState 指示 Express Route 网关在 vnet 中有多个 Express Route 网关时是否为流量提供服务的属性 “Disabled”
“Enabled”
allowRemoteVnetTraffic 将此网关配置为接受来自其他 Azure 虚拟网络的流量。 此配置不支持连接到 Azure 虚拟 WAN。 bool
allowVirtualWanTraffic 将此网关配置为接受来自远程虚拟网络的流量。 bool
bgpSettings 虚拟网络网关的 BGP 扬声器设置。 BgpSettings
customRoutes 对地址空间资源的引用，该资源表示客户为虚拟网络网关和 VpnClient 指定的自定义路由地址空间。 AddressSpace
disableIPSecReplayProtection disableIPSecReplayProtection 标志。 bool
enableBgp 是否为此虚拟网络网关启用了 BGP。 bool
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat 标志。 bool
enableDnsForwarding 是否启用 DNS 转发。 bool
enablePrivateIpAddress 是否需要在此网关上为连接启用专用 IP。 bool
gatewayDefaultSite 对 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 SubResource
gatewayType 此虚拟网络网关的类型。 “ExpressRoute”
“LocalGateway”
“Vpn”
ipConfigurations 虚拟网络网关的 IP 配置。 VirtualNetworkGatewayIPConfiguration[]
natRules 虚拟网络网关的 NatRules。 VirtualNetworkGatewayNatRule[]
sku 对 VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。 VirtualNetworkGatewaySku
virtualNetworkGatewayPolicyGroups 对 VirtualNetworkGatewayPolicyGroup 资源的引用，该资源表示网关的可用 VirtualNetworkGatewayPolicyGroup。 VirtualNetworkGatewayPolicyGroup[]
vNetExtendedLocationResourceId 客户 vnet 资源 ID。本地网关类型的 VirtualNetworkGateway 与客户 vnet 相关联。 字符串
vpnClientConfiguration 对表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。 VpnClientConfiguration
vpnGatewayGeneration 此 VirtualNetworkGateway 的代系。 如果 gatewayType 不是 VPN，则必须为 None。 “Generation1”
“Generation2”
“None”
vpnType 此虚拟网络网关的类型。 “PolicyBased”
“RouteBased”

VirtualNetworkGatewaySku

名字 描述 价值
名字 网关 SKU 名称。 “Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”
层 网关 SKU 层。 “Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”

VngClientConnectionConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端根证书的属性。 VngClientConnectionConfigurationProperties

VngClientConnectionConfigurationProperties

名字 描述 价值
virtualNetworkGatewayPolicyGroups 对 virtualNetworkGatewayPolicyGroups 的引用列表 SubResource[] （必需）
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace （必需）

VpnClientConfiguration

名字 描述 价值
aadAudience 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADAudience 属性。 字符串
aadIssuer 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADIssuer 属性。 字符串
aadTenant 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADTenant 属性。 字符串
radiusServerAddress 用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 服务器地址属性。 字符串
radiusServers 多个 radius 服务器配置的 radiusServers 属性。 RadiusServer[]
radiusServerSecret 用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 机密属性。 字符串
vngClientConnectionConfigurations 虚拟网络网关 P2S 客户端的每个 IP 地址池连接策略。 VngClientConnectionConfiguration[]
vpnAuthenticationTypes 虚拟网络网关的 VPN 身份验证类型。 包含任一项的字符串数组：
“AAD”
“Certificate”
“Radius”
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace
vpnClientIpsecPolicies 用于虚拟网络网关 P2S 客户端的 VpnClientIpsecPolicies。 IpsecPolicy[]
vpnClientProtocols 用于虚拟网络网关的 VpnClientProtocols。 包含任一项的字符串数组：
“IkeV2”
“OpenVPN”
“SSTP”
vpnClientRevokedCertificates 用于虚拟网络网关的 VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRootCertificates 虚拟网络网关的 VpnClientRootCertificate。 VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端吊销证书的属性。 VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字 描述 价值
指纹 吊销的 VPN 客户端证书指纹。 字符串

VpnClientRootCertificate

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端根证书的属性。 VpnClientRootCertificatePropertiesFormat （必需）

VpnClientRootCertificatePropertiesFormat

名字 描述 价值
publicCertData 证书公共数据。 string （必需）

VpnNatRuleMapping

名字 描述 价值
addressSpace Vpn NatRule 映射的地址空间。 字符串
portRange Vpn NatRule 映射的端口范围。 字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
创建 BGP VNET 到 VNET 连接 使用此模板，可以使用虚拟网络网关和 BGP 连接两个 VNET
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN 通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。

ARM 模板资源定义

可以使用目标操作部署连接资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/connections 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/connections",
  "apiVersion": "2023-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "authorizationKey": "string",
    "connectionMode": "string",
    "connectionProtocol": "string",
    "connectionType": "string",
    "dpdTimeoutSeconds": "int",
    "egressNatRules": [
      {
        "id": "string"
      }
    ],
    "enableBgp": "bool",
    "enablePrivateLinkFastPath": "bool",
    "expressRouteGatewayBypass": "bool",
    "gatewayCustomBgpIpAddresses": [
      {
        "customBgpIpAddress": "string",
        "ipConfigurationId": "string"
      }
    ],
    "ingressNatRules": [
      {
        "id": "string"
      }
    ],
    "ipsecPolicies": [
      {
        "dhGroup": "string",
        "ikeEncryption": "string",
        "ikeIntegrity": "string",
        "ipsecEncryption": "string",
        "ipsecIntegrity": "string",
        "pfsGroup": "string",
        "saDataSizeKilobytes": "int",
        "saLifeTimeSeconds": "int"
      }
    ],
    "localNetworkGateway2": {
      "id": "string",
      "location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "bgpPeeringAddresses": [
            {
              "customBgpIpAddresses": [ "string" ],
              "ipconfigurationId": "string"
            }
          ],
          "peerWeight": "int"
        },
        "fqdn": "string",
        "gatewayIpAddress": "string",
        "localNetworkAddressSpace": {
          "addressPrefixes": [ "string" ]
        }
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "peer": {
      "id": "string"
    },
    "routingWeight": "int",
    "sharedKey": "string",
    "trafficSelectorPolicies": [
      {
        "localAddressRanges": [ "string" ],
        "remoteAddressRanges": [ "string" ]
      }
    ],
    "useLocalAzureIpAddress": "bool",
    "usePolicyBasedTrafficSelectors": "bool",
    "virtualNetworkGateway1": {
      "extendedLocation": {
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "adminState": "string",
        "allowRemoteVnetTraffic": "bool",
        "allowVirtualWanTraffic": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "bgpPeeringAddresses": [
            {
              "customBgpIpAddresses": [ "string" ],
              "ipconfigurationId": "string"
            }
          ],
          "peerWeight": "int"
        },
        "customRoutes": {
          "addressPrefixes": [ "string" ]
        },
        "disableIPSecReplayProtection": "bool",
        "enableBgp": "bool",
        "enableBgpRouteTranslationForNat": "bool",
        "enableDnsForwarding": "bool",
        "enablePrivateIpAddress": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "natRules": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "externalMappings": [
                {
                  "addressSpace": "string",
                  "portRange": "string"
                }
              ],
              "internalMappings": [
                {
                  "addressSpace": "string",
                  "portRange": "string"
                }
              ],
              "ipConfigurationId": "string",
              "mode": "string",
              "type": "string"
            }
          }
        ],
        "sku": {
          "name": "string",
          "tier": "string"
        },
        "virtualNetworkGatewayPolicyGroups": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "isDefault": "bool",
              "policyMembers": [
                {
                  "attributeType": "string",
                  "attributeValue": "string",
                  "name": "string"
                }
              ],
              "priority": "int"
            }
          }
        ],
        "vNetExtendedLocationResourceId": "string",
        "vpnClientConfiguration": {
          "aadAudience": "string",
          "aadIssuer": "string",
          "aadTenant": "string",
          "radiusServerAddress": "string",
          "radiusServers": [
            {
              "radiusServerAddress": "string",
              "radiusServerScore": "int",
              "radiusServerSecret": "string"
            }
          ],
          "radiusServerSecret": "string",
          "vngClientConnectionConfigurations": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "virtualNetworkGatewayPolicyGroups": [
                  {
                    "id": "string"
                  }
                ],
                "vpnClientAddressPool": {
                  "addressPrefixes": [ "string" ]
                }
              }
            }
          ],
          "vpnAuthenticationTypes": [ "string" ],
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientIpsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "vpnClientProtocols": [ "string" ],
          "vpnClientRevokedCertificates": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnGatewayGeneration": "string",
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "virtualNetworkGateway2": {
      "extendedLocation": {
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "adminState": "string",
        "allowRemoteVnetTraffic": "bool",
        "allowVirtualWanTraffic": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "bgpPeeringAddresses": [
            {
              "customBgpIpAddresses": [ "string" ],
              "ipconfigurationId": "string"
            }
          ],
          "peerWeight": "int"
        },
        "customRoutes": {
          "addressPrefixes": [ "string" ]
        },
        "disableIPSecReplayProtection": "bool",
        "enableBgp": "bool",
        "enableBgpRouteTranslationForNat": "bool",
        "enableDnsForwarding": "bool",
        "enablePrivateIpAddress": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "natRules": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "externalMappings": [
                {
                  "addressSpace": "string",
                  "portRange": "string"
                }
              ],
              "internalMappings": [
                {
                  "addressSpace": "string",
                  "portRange": "string"
                }
              ],
              "ipConfigurationId": "string",
              "mode": "string",
              "type": "string"
            }
          }
        ],
        "sku": {
          "name": "string",
          "tier": "string"
        },
        "virtualNetworkGatewayPolicyGroups": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "isDefault": "bool",
              "policyMembers": [
                {
                  "attributeType": "string",
                  "attributeValue": "string",
                  "name": "string"
                }
              ],
              "priority": "int"
            }
          }
        ],
        "vNetExtendedLocationResourceId": "string",
        "vpnClientConfiguration": {
          "aadAudience": "string",
          "aadIssuer": "string",
          "aadTenant": "string",
          "radiusServerAddress": "string",
          "radiusServers": [
            {
              "radiusServerAddress": "string",
              "radiusServerScore": "int",
              "radiusServerSecret": "string"
            }
          ],
          "radiusServerSecret": "string",
          "vngClientConnectionConfigurations": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "virtualNetworkGatewayPolicyGroups": [
                  {
                    "id": "string"
                  }
                ],
                "vpnClientAddressPool": {
                  "addressPrefixes": [ "string" ]
                }
              }
            }
          ],
          "vpnAuthenticationTypes": [ "string" ],
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientIpsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "vpnClientProtocols": [ "string" ],
          "vpnClientRevokedCertificates": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnGatewayGeneration": "string",
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AddressSpace

名字 描述 价值
addressPrefixes CIDR 表示法中为此虚拟网络保留的地址块列表。 string[]

BgpSettings

名字 描述 价值
asn BGP 扬声器的 ASN。 int

约束：
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 字符串
bgpPeeringAddresses 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 IPConfigurationBgpPeeringAddress[]
peerWeight 添加到从此 BGP 扬声器中学习的路由的权重。 int

ExtendedLocation

名字 描述 价值
名字 扩展位置的名称。 字符串
类型 扩展位置的类型。 “EdgeZone”

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 （必需）

LocalNetworkGateway

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 本地网络网关的属性。 LocalNetworkGatewayPropertiesFormat （必需）
标签 资源标记。 ResourceTags

LocalNetworkGatewayPropertiesFormat

名字 描述 价值
bgpSettings 本地网络网关的 BGP 扬声器设置。 BgpSettings
fqdn 本地网关的 FQDN。 字符串
gatewayIpAddress 本地网络网关的 IP 地址。 字符串
localNetworkAddressSpace 本地网络站点地址空间。 AddressSpace

Microsoft.Network/connections

名字 描述 价值
apiVersion API 版本 '2023-04-01'
位置 资源位置。 字符串
名字 资源名称 string （必需）
性能 虚拟网络网关连接的属性。 VirtualNetworkGatewayConnectionPropertiesFormat （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Network/connections”

RadiusServer

名字 描述 价值
radiusServerAddress 此半径服务器的地址。 string （必需）
radiusServerScore 分配给此半径服务器的初始分数。 int
radiusServerSecret 用于此半径服务器的机密。 字符串

ResourceTags

名字 描述 价值

ResourceTags

名字 描述 价值

ResourceTags

名字 描述 价值

SubResource

名字 描述 价值
id 资源 ID。 字符串

TrafficSelectorPolicy

名字 描述 价值
localAddressRanges CIDR 格式的本地地址空间的集合。 string[] （必需）
remoteAddressRanges 采用 CIDR 格式的远程地址空间集合。 string[] （必需）

VirtualNetworkGateway

名字 描述 价值
extendedLocation 本地虚拟网络网关类型的扩展位置。 ExtendedLocation
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 虚拟网络网关的属性。 VirtualNetworkGatewayPropertiesFormat （必需）
标签 资源标记。 ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字 描述 价值
authorizationKey authorizationKey。 字符串
connectionMode 此连接的连接模式。 “Default”
“InitiatorOnly”
“ResponderOnly”
connectionProtocol 用于此连接的连接协议。 “IKEv1”
“IKEv2”
connectionType 网关连接类型。 “ExpressRoute”
“IPsec”
“Vnet2Vnet”
“VPNClient”（必需）
dpdTimeoutSeconds 此连接的死对等检测超时（以秒为单位）。 int
egressNatRules 出口 NatRules 列表。 SubResource[]
enableBgp EnableBgp 标志。 bool
enablePrivateLinkFastPath 访问专用链接时绕过 ExpressRoute 网关。 必须启用 ExpressRoute FastPath （expressRouteGatewayBypass）。 bool
expressRouteGatewayBypass 绕过 ExpressRoute 网关进行数据转发。 bool
gatewayCustomBgpIpAddresses 用于虚拟网络网关连接的 GatewayCustomBgpIpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
ingressNatRules 入口 NatRules 列表。 SubResource[]
ipsecPolicies 此连接要考虑的 IPSec 策略。 IpsecPolicy[]
localNetworkGateway2 对本地网络网关资源的引用。 LocalNetworkGateway
同辈 对等互连资源的引用。 SubResource
routingWeight 路由权重。 int
sharedKey IPSec 共享密钥。 字符串
trafficSelectorPolicies 此连接要考虑的流量选择器策略。 TrafficSelectorPolicy[]
useLocalAzureIpAddress 将专用本地 Azure IP 用于连接。 bool
usePolicyBasedTrafficSelectors 启用基于策略的流量选择器。 bool
virtualNetworkGateway1 对虚拟网络网关资源的引用。 VirtualNetworkGateway （必需）
virtualNetworkGateway2 对虚拟网络网关资源的引用。 VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 虚拟网络网关 IP 配置的属性。 VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字 描述 价值
privateIPAllocationMethod 专用 IP 地址分配方法。 “Dynamic”
“Static”
publicIPAddress 对公共 IP 资源的引用。 SubResource
子 对子网资源的引用。 SubResource

VirtualNetworkGatewayNatRule

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 虚拟网络网关 NAT 规则的属性。 VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

名字 描述 价值
externalMappings NAT 的专用 IP 地址外部映射。 VpnNatRuleMapping[]
internalMappings NAT 的专用 IP 地址内部映射。 VpnNatRuleMapping[]
ipConfigurationId 此 NAT 规则适用的 IP 配置 ID。 字符串
模式 VPN NAT 的源 NAT 方向。 “EgressSnat”
“IngressSnat”
类型 VPN NAT 的 NAT 规则的类型。 “Dynamic”
“Static”

VirtualNetworkGatewayPolicyGroup

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 tVirtualNetworkGatewayPolicyGroup 的属性。 VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPolicyGroupMember

名字 描述 价值
attributeType Vpn Policy 成员属性类型。 “AADGroupId”
“CertificateGroupId”
“RadiusAzureGroupId”
attributeValue 用于此 VirtualNetworkGatewayPolicyGroupMember 的属性的值。 字符串
名字 VirtualNetworkGatewayPolicyGroupMember 的名称。 字符串

VirtualNetworkGatewayPolicyGroupProperties

名字 描述 价值
isDefault 显示这是否为默认 VirtualNetworkGatewayPolicyGroup。 bool （必需）
policyMembers VirtualNetworkGatewayPolicyGroup 的多个 PolicyMembers。 VirtualNetworkGatewayPolicyGroupMember[] （必需）
优先权 VirtualNetworkGatewayPolicyGroup 的优先级。 int （必需）

VirtualNetworkGatewayPropertiesFormat

名字 描述 价值
activeActive ActiveActive 标志。 bool
adminState 指示 Express Route 网关在 vnet 中有多个 Express Route 网关时是否为流量提供服务的属性 “Disabled”
“Enabled”
allowRemoteVnetTraffic 将此网关配置为接受来自其他 Azure 虚拟网络的流量。 此配置不支持连接到 Azure 虚拟 WAN。 bool
allowVirtualWanTraffic 将此网关配置为接受来自远程虚拟网络的流量。 bool
bgpSettings 虚拟网络网关的 BGP 扬声器设置。 BgpSettings
customRoutes 对地址空间资源的引用，该资源表示客户为虚拟网络网关和 VpnClient 指定的自定义路由地址空间。 AddressSpace
disableIPSecReplayProtection disableIPSecReplayProtection 标志。 bool
enableBgp 是否为此虚拟网络网关启用了 BGP。 bool
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat 标志。 bool
enableDnsForwarding 是否启用 DNS 转发。 bool
enablePrivateIpAddress 是否需要在此网关上为连接启用专用 IP。 bool
gatewayDefaultSite 对 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 SubResource
gatewayType 此虚拟网络网关的类型。 “ExpressRoute”
“LocalGateway”
“Vpn”
ipConfigurations 虚拟网络网关的 IP 配置。 VirtualNetworkGatewayIPConfiguration[]
natRules 虚拟网络网关的 NatRules。 VirtualNetworkGatewayNatRule[]
sku 对 VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。 VirtualNetworkGatewaySku
virtualNetworkGatewayPolicyGroups 对 VirtualNetworkGatewayPolicyGroup 资源的引用，该资源表示网关的可用 VirtualNetworkGatewayPolicyGroup。 VirtualNetworkGatewayPolicyGroup[]
vNetExtendedLocationResourceId 客户 vnet 资源 ID。本地网关类型的 VirtualNetworkGateway 与客户 vnet 相关联。 字符串
vpnClientConfiguration 对表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。 VpnClientConfiguration
vpnGatewayGeneration 此 VirtualNetworkGateway 的代系。 如果 gatewayType 不是 VPN，则必须为 None。 “Generation1”
“Generation2”
“None”
vpnType 此虚拟网络网关的类型。 “PolicyBased”
“RouteBased”

VirtualNetworkGatewaySku

名字 描述 价值
名字 网关 SKU 名称。 “Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”
层 网关 SKU 层。 “Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”

VngClientConnectionConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端根证书的属性。 VngClientConnectionConfigurationProperties

VngClientConnectionConfigurationProperties

名字 描述 价值
virtualNetworkGatewayPolicyGroups 对 virtualNetworkGatewayPolicyGroups 的引用列表 SubResource[] （必需）
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace （必需）

VpnClientConfiguration

名字 描述 价值
aadAudience 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADAudience 属性。 字符串
aadIssuer 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADIssuer 属性。 字符串
aadTenant 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADTenant 属性。 字符串
radiusServerAddress 用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 服务器地址属性。 字符串
radiusServers 多个 radius 服务器配置的 radiusServers 属性。 RadiusServer[]
radiusServerSecret 用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 机密属性。 字符串
vngClientConnectionConfigurations 虚拟网络网关 P2S 客户端的每个 IP 地址池连接策略。 VngClientConnectionConfiguration[]
vpnAuthenticationTypes 虚拟网络网关的 VPN 身份验证类型。 包含任一项的字符串数组：
“AAD”
“Certificate”
“Radius”
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace
vpnClientIpsecPolicies 用于虚拟网络网关 P2S 客户端的 VpnClientIpsecPolicies。 IpsecPolicy[]
vpnClientProtocols 用于虚拟网络网关的 VpnClientProtocols。 包含任一项的字符串数组：
“IkeV2”
“OpenVPN”
“SSTP”
vpnClientRevokedCertificates 用于虚拟网络网关的 VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRootCertificates 虚拟网络网关的 VpnClientRootCertificate。 VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端吊销证书的属性。 VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字 描述 价值
指纹 吊销的 VPN 客户端证书指纹。 字符串

VpnClientRootCertificate

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端根证书的属性。 VpnClientRootCertificatePropertiesFormat （必需）

VpnClientRootCertificatePropertiesFormat

名字 描述 价值
publicCertData 证书公共数据。 string （必需）

VpnNatRuleMapping

名字 描述 价值
addressSpace Vpn NatRule 映射的地址空间。 字符串
portRange Vpn NatRule 映射的端口范围。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
BOSH CF 跨区域

部署到 Azure 		此模板可帮助你设置在 Azure 上跨两个区域部署 BOSH 和 Cloud Foundry 所需的资源。
将 ExpressRoute 线路连接到 VNET

部署到 Azure 		此模板创建 VNET、ExpresRoute 网关和与配置了 AzurePrivatePeering 的预配和已启用的 ExpressRoute 线路的连接。
创建 BGP VNET 到 VNET 连接

部署到 Azure 		使用此模板，可以使用虚拟网络网关和 BGP 连接两个 VNET
创建站点到站点 VPN 连接

部署到 Azure 		使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
使用 VM 创建站点到站点 VPN 连接

部署到 Azure 		使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
跨两个区域创建 VNET 到 VNET 连接

部署到 Azure 		使用此模板，可以使用虚拟网络网关连接不同区域中的两个 VNET
创建三个 vNet 来演示 传递的 BGP 连接

部署到 Azure 		此模板部署使用虚拟网络网关和已启用 BGP 的连接连接的三个 vNet
部署 HBase 异地复制

部署到 Azure 		通过此模板，可以使用 VPN vnet 到 vnet 连接跨两个不同的区域配置用于 HBase 复制的 Azure 环境。
将现有 Azure VNET 扩展到多 VNET 配置

部署到 Azure 		使用此模板，可以将现有单一 VNET 环境扩展到使用 VNET 到 VNET 网关跨两个数据中心区域扩展的多 VNET 环境
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN

部署到 Azure 		通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。
VPN 自定义 IPSec 策略

部署到 Azure 		此自定义 IPSec 策略允许更精细地配置 IKE 参数。 这样，就可以部署站点到站点 VPN 策略，以支持 VPN 终结点设备上的特定设置。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署连接资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/connections 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/connections@2023-04-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authorizationKey = "string"
      connectionMode = "string"
      connectionProtocol = "string"
      connectionType = "string"
      dpdTimeoutSeconds = int
      egressNatRules = [
        {
          id = "string"
        }
      ]
      enableBgp = bool
      enablePrivateLinkFastPath = bool
      expressRouteGatewayBypass = bool
      gatewayCustomBgpIpAddresses = [
        {
          customBgpIpAddress = "string"
          ipConfigurationId = "string"
        }
      ]
      ingressNatRules = [
        {
          id = "string"
        }
      ]
      ipsecPolicies = [
        {
          dhGroup = "string"
          ikeEncryption = "string"
          ikeIntegrity = "string"
          ipsecEncryption = "string"
          ipsecIntegrity = "string"
          pfsGroup = "string"
          saDataSizeKilobytes = int
          saLifeTimeSeconds = int
        }
      ]
      localNetworkGateway2 = {
        id = "string"
        location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            bgpPeeringAddresses = [
              {
                customBgpIpAddresses = [
                  "string"
                ]
                ipconfigurationId = "string"
              }
            ]
            peerWeight = int
          }
          fqdn = "string"
          gatewayIpAddress = "string"
          localNetworkAddressSpace = {
            addressPrefixes = [
              "string"
            ]
          }
        }
        tags = {
          {customized property} = "string"
        }
      }
      peer = {
        id = "string"
      }
      routingWeight = int
      sharedKey = "string"
      trafficSelectorPolicies = [
        {
          localAddressRanges = [
            "string"
          ]
          remoteAddressRanges = [
            "string"
          ]
        }
      ]
      useLocalAzureIpAddress = bool
      usePolicyBasedTrafficSelectors = bool
      virtualNetworkGateway1 = {
        extendedLocation = {
          name = "string"
          type = "string"
        }
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          adminState = "string"
          allowRemoteVnetTraffic = bool
          allowVirtualWanTraffic = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            bgpPeeringAddresses = [
              {
                customBgpIpAddresses = [
                  "string"
                ]
                ipconfigurationId = "string"
              }
            ]
            peerWeight = int
          }
          customRoutes = {
            addressPrefixes = [
              "string"
            ]
          }
          disableIPSecReplayProtection = bool
          enableBgp = bool
          enableBgpRouteTranslationForNat = bool
          enableDnsForwarding = bool
          enablePrivateIpAddress = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          natRules = [
            {
              id = "string"
              name = "string"
              properties = {
                externalMappings = [
                  {
                    addressSpace = "string"
                    portRange = "string"
                  }
                ]
                internalMappings = [
                  {
                    addressSpace = "string"
                    portRange = "string"
                  }
                ]
                ipConfigurationId = "string"
                mode = "string"
                type = "string"
              }
            }
          ]
          sku = {
            name = "string"
            tier = "string"
          }
          virtualNetworkGatewayPolicyGroups = [
            {
              id = "string"
              name = "string"
              properties = {
                isDefault = bool
                policyMembers = [
                  {
                    attributeType = "string"
                    attributeValue = "string"
                    name = "string"
                  }
                ]
                priority = int
              }
            }
          ]
          vNetExtendedLocationResourceId = "string"
          vpnClientConfiguration = {
            aadAudience = "string"
            aadIssuer = "string"
            aadTenant = "string"
            radiusServerAddress = "string"
            radiusServers = [
              {
                radiusServerAddress = "string"
                radiusServerScore = int
                radiusServerSecret = "string"
              }
            ]
            radiusServerSecret = "string"
            vngClientConnectionConfigurations = [
              {
                id = "string"
                name = "string"
                properties = {
                  virtualNetworkGatewayPolicyGroups = [
                    {
                      id = "string"
                    }
                  ]
                  vpnClientAddressPool = {
                    addressPrefixes = [
                      "string"
                    ]
                  }
                }
              }
            ]
            vpnAuthenticationTypes = [
              "string"
            ]
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientIpsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            vpnClientProtocols = [
              "string"
            ]
            vpnClientRevokedCertificates = [
              {
                id = "string"
                name = "string"
                properties = {
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                id = "string"
                name = "string"
                properties = {
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnGatewayGeneration = "string"
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      virtualNetworkGateway2 = {
        extendedLocation = {
          name = "string"
          type = "string"
        }
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          adminState = "string"
          allowRemoteVnetTraffic = bool
          allowVirtualWanTraffic = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            bgpPeeringAddresses = [
              {
                customBgpIpAddresses = [
                  "string"
                ]
                ipconfigurationId = "string"
              }
            ]
            peerWeight = int
          }
          customRoutes = {
            addressPrefixes = [
              "string"
            ]
          }
          disableIPSecReplayProtection = bool
          enableBgp = bool
          enableBgpRouteTranslationForNat = bool
          enableDnsForwarding = bool
          enablePrivateIpAddress = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          natRules = [
            {
              id = "string"
              name = "string"
              properties = {
                externalMappings = [
                  {
                    addressSpace = "string"
                    portRange = "string"
                  }
                ]
                internalMappings = [
                  {
                    addressSpace = "string"
                    portRange = "string"
                  }
                ]
                ipConfigurationId = "string"
                mode = "string"
                type = "string"
              }
            }
          ]
          sku = {
            name = "string"
            tier = "string"
          }
          virtualNetworkGatewayPolicyGroups = [
            {
              id = "string"
              name = "string"
              properties = {
                isDefault = bool
                policyMembers = [
                  {
                    attributeType = "string"
                    attributeValue = "string"
                    name = "string"
                  }
                ]
                priority = int
              }
            }
          ]
          vNetExtendedLocationResourceId = "string"
          vpnClientConfiguration = {
            aadAudience = "string"
            aadIssuer = "string"
            aadTenant = "string"
            radiusServerAddress = "string"
            radiusServers = [
              {
                radiusServerAddress = "string"
                radiusServerScore = int
                radiusServerSecret = "string"
              }
            ]
            radiusServerSecret = "string"
            vngClientConnectionConfigurations = [
              {
                id = "string"
                name = "string"
                properties = {
                  virtualNetworkGatewayPolicyGroups = [
                    {
                      id = "string"
                    }
                  ]
                  vpnClientAddressPool = {
                    addressPrefixes = [
                      "string"
                    ]
                  }
                }
              }
            ]
            vpnAuthenticationTypes = [
              "string"
            ]
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientIpsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            vpnClientProtocols = [
              "string"
            ]
            vpnClientRevokedCertificates = [
              {
                id = "string"
                name = "string"
                properties = {
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                id = "string"
                name = "string"
                properties = {
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnGatewayGeneration = "string"
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
    }
  })
}

属性值

AddressSpace

名字 描述 价值
addressPrefixes CIDR 表示法中为此虚拟网络保留的地址块列表。 string[]

BgpSettings

名字 描述 价值
asn BGP 扬声器的 ASN。 int

约束：
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 字符串
bgpPeeringAddresses 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 IPConfigurationBgpPeeringAddress[]
peerWeight 添加到从此 BGP 扬声器中学习的路由的权重。 int

ExtendedLocation

名字 描述 价值
名字 扩展位置的名称。 字符串
类型 扩展位置的类型。 “EdgeZone”

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 （必需）

LocalNetworkGateway

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 本地网络网关的属性。 LocalNetworkGatewayPropertiesFormat （必需）
标签 资源标记。 ResourceTags

LocalNetworkGatewayPropertiesFormat

名字 描述 价值
bgpSettings 本地网络网关的 BGP 扬声器设置。 BgpSettings
fqdn 本地网关的 FQDN。 字符串
gatewayIpAddress 本地网络网关的 IP 地址。 字符串
localNetworkAddressSpace 本地网络站点地址空间。 AddressSpace

Microsoft.Network/connections

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 string （必需）
性能 虚拟网络网关连接的属性。 VirtualNetworkGatewayConnectionPropertiesFormat （必需）
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Network/connections@2023-04-01”

RadiusServer

名字 描述 价值
radiusServerAddress 此半径服务器的地址。 string （必需）
radiusServerScore 分配给此半径服务器的初始分数。 int
radiusServerSecret 用于此半径服务器的机密。 字符串

ResourceTags

名字 描述 价值

ResourceTags

名字 描述 价值

ResourceTags

名字 描述 价值

SubResource

名字 描述 价值
id 资源 ID。 字符串

TrafficSelectorPolicy

名字 描述 价值
localAddressRanges CIDR 格式的本地地址空间的集合。 string[] （必需）
remoteAddressRanges 采用 CIDR 格式的远程地址空间集合。 string[] （必需）

VirtualNetworkGateway

名字 描述 价值
extendedLocation 本地虚拟网络网关类型的扩展位置。 ExtendedLocation
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 虚拟网络网关的属性。 VirtualNetworkGatewayPropertiesFormat （必需）
标签 资源标记。 ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字 描述 价值
authorizationKey authorizationKey。 字符串
connectionMode 此连接的连接模式。 “Default”
“InitiatorOnly”
“ResponderOnly”
connectionProtocol 用于此连接的连接协议。 “IKEv1”
“IKEv2”
connectionType 网关连接类型。 “ExpressRoute”
“IPsec”
“Vnet2Vnet”
“VPNClient”（必需）
dpdTimeoutSeconds 此连接的死对等检测超时（以秒为单位）。 int
egressNatRules 出口 NatRules 列表。 SubResource[]
enableBgp EnableBgp 标志。 bool
enablePrivateLinkFastPath 访问专用链接时绕过 ExpressRoute 网关。 必须启用 ExpressRoute FastPath （expressRouteGatewayBypass）。 bool
expressRouteGatewayBypass 绕过 ExpressRoute 网关进行数据转发。 bool
gatewayCustomBgpIpAddresses 用于虚拟网络网关连接的 GatewayCustomBgpIpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
ingressNatRules 入口 NatRules 列表。 SubResource[]
ipsecPolicies 此连接要考虑的 IPSec 策略。 IpsecPolicy[]
localNetworkGateway2 对本地网络网关资源的引用。 LocalNetworkGateway
同辈 对等互连资源的引用。 SubResource
routingWeight 路由权重。 int
sharedKey IPSec 共享密钥。 字符串
trafficSelectorPolicies 此连接要考虑的流量选择器策略。 TrafficSelectorPolicy[]
useLocalAzureIpAddress 将专用本地 Azure IP 用于连接。 bool
usePolicyBasedTrafficSelectors 启用基于策略的流量选择器。 bool
virtualNetworkGateway1 对虚拟网络网关资源的引用。 VirtualNetworkGateway （必需）
virtualNetworkGateway2 对虚拟网络网关资源的引用。 VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 虚拟网络网关 IP 配置的属性。 VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字 描述 价值
privateIPAllocationMethod 专用 IP 地址分配方法。 “Dynamic”
“Static”
publicIPAddress 对公共 IP 资源的引用。 SubResource
子 对子网资源的引用。 SubResource

VirtualNetworkGatewayNatRule

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 虚拟网络网关 NAT 规则的属性。 VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

名字 描述 价值
externalMappings NAT 的专用 IP 地址外部映射。 VpnNatRuleMapping[]
internalMappings NAT 的专用 IP 地址内部映射。 VpnNatRuleMapping[]
ipConfigurationId 此 NAT 规则适用的 IP 配置 ID。 字符串
模式 VPN NAT 的源 NAT 方向。 “EgressSnat”
“IngressSnat”
类型 VPN NAT 的 NAT 规则的类型。 “Dynamic”
“Static”

VirtualNetworkGatewayPolicyGroup

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 tVirtualNetworkGatewayPolicyGroup 的属性。 VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPolicyGroupMember

名字 描述 价值
attributeType Vpn Policy 成员属性类型。 “AADGroupId”
“CertificateGroupId”
“RadiusAzureGroupId”
attributeValue 用于此 VirtualNetworkGatewayPolicyGroupMember 的属性的值。 字符串
名字 VirtualNetworkGatewayPolicyGroupMember 的名称。 字符串

VirtualNetworkGatewayPolicyGroupProperties

名字 描述 价值
isDefault 显示这是否为默认 VirtualNetworkGatewayPolicyGroup。 bool （必需）
policyMembers VirtualNetworkGatewayPolicyGroup 的多个 PolicyMembers。 VirtualNetworkGatewayPolicyGroupMember[] （必需）
优先权 VirtualNetworkGatewayPolicyGroup 的优先级。 int （必需）

VirtualNetworkGatewayPropertiesFormat

名字 描述 价值
activeActive ActiveActive 标志。 bool
adminState 指示 Express Route 网关在 vnet 中有多个 Express Route 网关时是否为流量提供服务的属性 “Disabled”
“Enabled”
allowRemoteVnetTraffic 将此网关配置为接受来自其他 Azure 虚拟网络的流量。 此配置不支持连接到 Azure 虚拟 WAN。 bool
allowVirtualWanTraffic 将此网关配置为接受来自远程虚拟网络的流量。 bool
bgpSettings 虚拟网络网关的 BGP 扬声器设置。 BgpSettings
customRoutes 对地址空间资源的引用，该资源表示客户为虚拟网络网关和 VpnClient 指定的自定义路由地址空间。 AddressSpace
disableIPSecReplayProtection disableIPSecReplayProtection 标志。 bool
enableBgp 是否为此虚拟网络网关启用了 BGP。 bool
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat 标志。 bool
enableDnsForwarding 是否启用 DNS 转发。 bool
enablePrivateIpAddress 是否需要在此网关上为连接启用专用 IP。 bool
gatewayDefaultSite 对 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 SubResource
gatewayType 此虚拟网络网关的类型。 “ExpressRoute”
“LocalGateway”
“Vpn”
ipConfigurations 虚拟网络网关的 IP 配置。 VirtualNetworkGatewayIPConfiguration[]
natRules 虚拟网络网关的 NatRules。 VirtualNetworkGatewayNatRule[]
sku 对 VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。 VirtualNetworkGatewaySku
virtualNetworkGatewayPolicyGroups 对 VirtualNetworkGatewayPolicyGroup 资源的引用，该资源表示网关的可用 VirtualNetworkGatewayPolicyGroup。 VirtualNetworkGatewayPolicyGroup[]
vNetExtendedLocationResourceId 客户 vnet 资源 ID。本地网关类型的 VirtualNetworkGateway 与客户 vnet 相关联。 字符串
vpnClientConfiguration 对表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。 VpnClientConfiguration
vpnGatewayGeneration 此 VirtualNetworkGateway 的代系。 如果 gatewayType 不是 VPN，则必须为 None。 “Generation1”
“Generation2”
“None”
vpnType 此虚拟网络网关的类型。 “PolicyBased”
“RouteBased”

VirtualNetworkGatewaySku

名字 描述 价值
名字 网关 SKU 名称。 “Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”
层 网关 SKU 层。 “Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”

VngClientConnectionConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端根证书的属性。 VngClientConnectionConfigurationProperties

VngClientConnectionConfigurationProperties

名字 描述 价值
virtualNetworkGatewayPolicyGroups 对 virtualNetworkGatewayPolicyGroups 的引用列表 SubResource[] （必需）
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace （必需）

VpnClientConfiguration

名字 描述 价值
aadAudience 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADAudience 属性。 字符串
aadIssuer 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADIssuer 属性。 字符串
aadTenant 用于 AAD 身份验证的 Vpn 客户端连接的 VirtualNetworkGateway 资源的 AADTenant 属性。 字符串
radiusServerAddress 用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 服务器地址属性。 字符串
radiusServers 多个 radius 服务器配置的 radiusServers 属性。 RadiusServer[]
radiusServerSecret 用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 机密属性。 字符串
vngClientConnectionConfigurations 虚拟网络网关 P2S 客户端的每个 IP 地址池连接策略。 VngClientConnectionConfiguration[]
vpnAuthenticationTypes 虚拟网络网关的 VPN 身份验证类型。 包含任一项的字符串数组：
“AAD”
“Certificate”
“Radius”
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace
vpnClientIpsecPolicies 用于虚拟网络网关 P2S 客户端的 VpnClientIpsecPolicies。 IpsecPolicy[]
vpnClientProtocols 用于虚拟网络网关的 VpnClientProtocols。 包含任一项的字符串数组：
“IkeV2”
“OpenVPN”
“SSTP”
vpnClientRevokedCertificates 用于虚拟网络网关的 VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRootCertificates 虚拟网络网关的 VpnClientRootCertificate。 VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端吊销证书的属性。 VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字 描述 价值
指纹 吊销的 VPN 客户端证书指纹。 字符串

VpnClientRootCertificate

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 VPN 客户端根证书的属性。 VpnClientRootCertificatePropertiesFormat （必需）

VpnClientRootCertificatePropertiesFormat

名字 描述 价值
publicCertData 证书公共数据。 string （必需）

VpnNatRuleMapping

名字 描述 价值
addressSpace Vpn NatRule 映射的地址空间。 字符串
portRange Vpn NatRule 映射的端口范围。 字符串