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

Microsoft.Network virtualNetworkGateways 2021-05-01

• 最新
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 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
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01
• 2017-03-30
• 2017-03-01
• 2016-12-01
• 2016-09-01
• 2016-06-01
• 2016-03-30
• 2015-06-15
• 2015-05-01-preview

Bicep 资源定义

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

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2021-05-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: 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'
    }
    vNetExtendedLocationResourceId: 'string'
    vpnClientConfiguration: {
      aadAudience: 'string'
      aadIssuer: 'string'
      aadTenant: 'string'
      radiusServerAddress: 'string'
      radiusServers: [
        {
          radiusServerAddress: 'string'
          radiusServerScore: int
          radiusServerSecret: 'string'
        }
      ]
      radiusServerSecret: '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”

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/virtualNetworkGateways

名字	描述	价值
extendedLocation	本地虚拟网络网关类型的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟网络网关的属性。	VirtualNetworkGatewayPropertiesFormat （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

RadiusServer

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

ResourceTags

名字	描述	价值

SubResource

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

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”

VirtualNetworkGatewayPropertiesFormat

名字	描述	价值
activeActive	ActiveActive 标志。	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
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”

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 机密属性。	字符串
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
使用 Azure AD 创建点到站点网关	此模板部署配置了 Azure Active Directory 点到站点连接的 VPN 虚拟网络网关
使用专用对等互连和 Azure VNet ExpressRoute 线路	此模板配置 ExpressRoute Microsoft对等互连，部署包含 Expressroute 网关的 Azure VNet，并将 VNet 链接到 ExpressRoute 线路
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN	通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理	此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。

ARM 模板资源定义

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

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Network/virtualNetworkGateways",
  "apiVersion": "2021-05-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "activeActive": "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"
    },
    "vNetExtendedLocationResourceId": "string",
    "vpnClientConfiguration": {
      "aadAudience": "string",
      "aadIssuer": "string",
      "aadTenant": "string",
      "radiusServerAddress": "string",
      "radiusServers": [
        {
          "radiusServerAddress": "string",
          "radiusServerScore": "int",
          "radiusServerSecret": "string"
        }
      ],
      "radiusServerSecret": "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”

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/virtualNetworkGateways

名字	描述	价值
apiVersion	API 版本	'2021-05-01'
extendedLocation	本地虚拟网络网关类型的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟网络网关的属性。	VirtualNetworkGatewayPropertiesFormat （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Network/virtualNetworkGateways”

RadiusServer

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

ResourceTags

名字	描述	价值

SubResource

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

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”

VirtualNetworkGatewayPropertiesFormat

名字	描述	价值
activeActive	ActiveActive 标志。	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
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”

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 机密属性。	字符串
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 映射的端口范围。	字符串

快速入门模板

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

模板	描述
使用 Azure SQL 后端 应用服务环境	此模板创建具有 Azure SQL 后端的应用服务环境以及专用终结点以及通常用于专用/隔离环境中的关联资源。
BOSH CF 跨区域	此模板可帮助你设置在 Azure 上跨两个区域部署 BOSH 和 Cloud Foundry 所需的资源。
将 ExpressRoute 线路连接到 VNET	此模板创建 VNET、ExpresRoute 网关和与配置了 AzurePrivatePeering 的预配和已启用的 ExpressRoute 线路的连接。
创建 BGP VNET 到 VNET 连接	使用此模板，可以使用虚拟网络网关和 BGP 连接两个 VNET
使用 P2S VPN 和 IIS 创建开发测试环境	此模板在 Windows 服务器上创建具有点到站点 VPN 和 IIS 的简单开发测试环境，这是入门的好方法。
创建点到站点网关	使用此模板，可以使用 VirtualNetworkGateways 创建点到站点连接
使用 Azure AD 创建点到站点网关	此模板部署配置了 Azure Active Directory 点到站点连接的 VPN 虚拟网络网关
创建站点到站点 VPN 连接	使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
使用 VM 创建站点到站点 VPN 连接	使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
跨两个区域创建 VNET 到 VNET 连接	使用此模板，可以使用虚拟网络网关连接不同区域中的两个 VNET
创建配置了点到站点连接的 SQL MI	部署为新虚拟网络中的点到站点连接配置的 Azure Sql 数据库托管实例（SQL MI）和虚拟网络网关。
创建三个 vNet 来演示 传递的 BGP 连接	此模板部署使用虚拟网络网关和已启用 BGP 的连接连接的三个 vNet
创建包含两个子网、本地网络和网关 的 VNet	此模板创建 VNet、2 个子网和网关
部署中心辐射型拓扑沙盒	此模板创建基本的中心辐射型拓扑设置。 它创建包含外围网络、管理、共享和网关（可选）子网的中心 VNet，其中两个辐射 VNet（开发和生产）包含每个子网的工作负荷子网。 它还在 HUB 的管理子网上部署 Windows Jump-Host，并在中心与两个辐射之间建立 VNet 对等互连。
部署 HBase 异地复制	通过此模板，可以使用 VPN vnet 到 vnet 连接跨两个不同的区域配置用于 HBase 复制的 Azure 环境。
使用专用对等互连和 Azure VNet ExpressRoute 线路	此模板配置 ExpressRoute Microsoft对等互连，部署包含 Expressroute 网关的 Azure VNet，并将 VNet 链接到 ExpressRoute 线路
将现有 Azure VNET 扩展到多 VNET 配置	使用此模板，可以将现有单一 VNET 环境扩展到使用 VNET 到 VNET 网关跨两个数据中心区域扩展的多 VNET 环境
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN	通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理	此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。

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

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

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2021-05-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      activeActive = 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"
      }
      vNetExtendedLocationResourceId = "string"
      vpnClientConfiguration = {
        aadAudience = "string"
        aadIssuer = "string"
        aadTenant = "string"
        radiusServerAddress = "string"
        radiusServers = [
          {
            radiusServerAddress = "string"
            radiusServerScore = int
            radiusServerSecret = "string"
          }
        ]
        radiusServerSecret = "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"
    }
  })
}

属性值

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”

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/virtualNetworkGateways

名字	描述	价值
extendedLocation	本地虚拟网络网关类型的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟网络网关的属性。	VirtualNetworkGatewayPropertiesFormat （必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Network/virtualNetworkGateways@2021-05-01”

RadiusServer

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

ResourceTags

名字	描述	价值

SubResource

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

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”

VirtualNetworkGatewayPropertiesFormat

名字	描述	价值
activeActive	ActiveActive 标志。	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
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”

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 机密属性。	字符串
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 映射的端口范围。	字符串