Compartilhar via

Microsoft.Network vpnGateways 2023-06-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso vpnGateways pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/vpnGateways, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.Network/vpnGateways@2023-06-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    connections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          connectionBandwidth: int
          dpdTimeoutSeconds: int
          enableBgp: bool
          enableInternetSecurity: bool
          enableRateLimiting: bool
          ipsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          remoteVpnSite: {
            id: 'string'
          }
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            inboundRouteMap: {
              id: 'string'
            }
            outboundRouteMap: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
              staticRoutesConfig: {
                vnetLocalRouteOverrideCriteria: 'string'
              }
            }
          }
          routingWeight: int
          sharedKey: 'string'
          trafficSelectorPolicies: [
            {
              localAddressRanges: [
                'string'
              ]
              remoteAddressRanges: [
                'string'
              ]
            }
          ]
          useLocalAzureIpAddress: bool
          usePolicyBasedTrafficSelectors: bool
          vpnConnectionProtocolType: 'string'
          vpnLinkConnections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                connectionBandwidth: int
                egressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                enableBgp: bool
                enableRateLimiting: bool
                ingressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                ipsecPolicies: [
                  {
                    dhGroup: 'string'
                    ikeEncryption: 'string'
                    ikeIntegrity: 'string'
                    ipsecEncryption: 'string'
                    ipsecIntegrity: 'string'
                    pfsGroup: 'string'
                    saDataSizeKilobytes: int
                    saLifeTimeSeconds: int
                  }
                ]
                routingWeight: int
                sharedKey: 'string'
                useLocalAzureIpAddress: bool
                usePolicyBasedTrafficSelectors: bool
                vpnConnectionProtocolType: 'string'
                vpnGatewayCustomBgpAddresses: [
                  {
                    customBgpIpAddress: 'string'
                    ipConfigurationId: 'string'
                  }
                ]
                vpnLinkConnectionMode: 'string'
                vpnSiteLink: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    enableBgpRouteTranslationForNat: bool
    isRoutingPreferenceInternet: bool
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

BgpSettings

Nome Descrição Valor
Asn O ASN do alto-falante BGP. int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
bgpPeeringAddress O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP. corda
bgpPeeringAddresses Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual. IPConfigurationBgpPeeringAddress []
peerWeight O peso adicionado às rotas aprendidas com esse alto-falante BGP. int

GatewayCustomBgpIpAddressIpConfiguration

Nome Descrição Valor
customBgpIpAddress O BgpPeeringAddress personalizado que pertence a IpconfigurationId. cadeia de caracteres (obrigatório)
ipConfigurationId A IpconfigurationId de ipconfiguration que pertence ao gateway. cadeia de caracteres (obrigatório)

IPConfigurationBgpPeeringAddress

Nome Descrição Valor
customBgpIpAddresses A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP. string[]
ipconfigurationId A ID da configuração de IP que pertence ao gateway. corda

IpsecPolicy

Nome Descrição Valor
dhGroup O grupo DH usado na Fase 1 do IKE para SA inicial. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
'ECP256'
'ECP384'
'None' (obrigatório)
ikeEncryption O algoritmo de criptografia IKE (fase 2 do IKE). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES256' (obrigatório)
ikeIntegrity O algoritmo de integridade IKE (fase 2 do IKE). 'GCMAES128'
'GCMAES256'
'MD5'
'SHA1'
'SHA256'
'SHA384' (obrigatório)
ipsecEncryption O algoritmo de criptografia IPSec (fase 1 do IKE). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES192'
'GCMAES256'
'None' (obrigatório)
ipsecIntegrity O algoritmo de integridade IPSec (IKE fase 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
'MD5'
'SHA1'
'SHA256' (obrigatório)
pfsGroup O Grupo de Pfs usado na Fase 2 do IKE para a NOVA SA filho. 'ECP256'
'ECP384'
'None'
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
'PFSMM' (obrigatório)
saDataSizeKilobytes O tamanho da carga da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA fase 2) em KB para um túnel VPN site a site. int (obrigatório)
saLifeTimeSeconds A Associação de Segurança ipsec (também chamada de modo rápido ou sa fase 2) tempo de vida em segundos para um túnel VPN site a site. int (obrigatório)

Microsoft.Network/vpnGateways

Nome Descrição Valor
localização Local do recurso. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do gateway de VPN. VpnGatewayProperties
Tags Marcações de recursos Dicionário de nomes e valores de marca. Consulte Marcas em modelos

PropagatedRouteTable

Nome Descrição Valor
Ids A lista de IDs de recurso de todas as RouteTables. sub-recursos[]
Rótulos A lista de rótulos. string[]

ResourceTags

Nome Descrição Valor

RoutingConfiguration

Nome Descrição Valor
associatedRouteTable A ID do recurso RouteTable associada a esse RoutingConfiguration. sub-recurso
inboundRouteMap A ID de recurso do RouteMap associado a esse RoutingConfiguration para rotas aprendidas de entrada. sub-recurso
outboundRouteMap A ID de recurso do TheRouteMap associada a esse RoutingConfiguration para rotas anunciadas de saída. sub-recurso
propagatedRouteTables A lista de RouteTables para a qual anunciar as rotas. PropagatedRouteTable
vnetRoutes Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. do VnetRoute

StaticRoute

Nome Descrição Valor
addressPrefixes Lista de todos os prefixos de endereço. string[]
nome O nome do StaticRoute exclusivo em um VnetRoute. corda
nextHopIpAddress O endereço ip do próximo salto. corda

StaticRoutesConfig

Nome Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se a rede virtual NVA no spoke é ignorada para tráfego com destino no spoke. 'Contains'
'Igual'

SubResource

Nome Descrição Valor
id ID do recurso. corda

TrafficSelectorPolicy

Nome Descrição Valor
localAddressRanges Uma coleção de espaços de endereço local no formato CIDR. string[] (obrigatório)
remoteAddressRanges Uma coleção de espaços de endereço remoto no formato CIDR. string[] (obrigatório)

VnetRoute

Nome Descrição Valor
staticRoutes Lista de todas as rotas estáticas. StaticRoute []
staticRoutesConfig Configuração para rotas estáticas neste HubVnetConnection. StaticRoutesConfig

VpnConnection

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da conexão VPN. VpnConnectionProperties

VpnConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
dpdTimeoutSeconds Tempo limite de DPD em segundos para conexão vpn. int
enableBgp Sinalizador EnableBgp. Bool
enableInternetSecurity Habilitar a segurança da Internet. Bool
enableRateLimiting Sinalizador EnableBgp. Bool
ipsecPolicies As Políticas IPSec a serem consideradas por essa conexão. IpsecPolicy []
remoteVpnSite ID do site de VPN conectado. sub-recurso
routingConfiguration A Configuração de Roteamento que indica as tabelas de rotas associadas e propagadas nessa conexão. RoutingConfiguration
routingWeight Peso de roteamento para conexão vpn. int
sharedKey SharedKey para a conexão vpn. corda
trafficSelectorPolicies As Políticas do Seletor de Tráfego a serem consideradas por essa conexão. TrafficSelectorPolicy []
useLocalAzureIpAddress Use o ip do azure local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilitar seletores de tráfego baseados em política. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnLinkConnections Lista de todas as conexões de link de site vpn para o gateway. VpnSiteLinkConnection []

VpnGatewayNatRule

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da regra NAT do VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nome Descrição Valor
externalMappings O mapeamento externo de endereço IP privado para NAT. VpnNatRuleMapping []
internalMappings O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping []
ipConfigurationId A ID de Configuração de IP à qual essa regra NAT se aplica. corda
modo A direção nat de origem de um NAT VPN. 'EgressSnat'
'IngressSnat'
tipo O tipo de regra NAT para VPN NAT. 'Dinâmico'
'Estático'

VpnGatewayProperties

Nome Descrição Valor
bgpSettings Configurações do alto-falante BGP do gateway de rede local. bgpSettings
Conexões Lista de todas as conexões vpn com o gateway. vpnConnection []
enableBgpRouteTranslationForNat Habilite a tradução de rotas BGP para NAT neste VpnGateway. Bool
isRoutingPreferenceInternet Habilite a propriedade Preferência de Roteamento para a Interface ip pública do VpnGateway. Bool
natRules Lista de todas as regras nat associadas ao gateway. VpnGatewayNatRule []
virtualHub O VirtualHub ao qual o gateway pertence. sub-recurso
vpnGatewayScaleUnit A unidade de escala para esse gateway de VPN. int

VpnNatRuleMapping

Nome Descrição Valor
addressSpace Espaço de endereço para mapeamento de NatRule vpn. corda
portRange Intervalo de portas para mapeamento de NatRule de Vpn. corda

VpnSiteLinkConnection

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da conexão de link do site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
egressNatRules Lista de NatRules de saída. sub-recursos[]
enableBgp Sinalizador EnableBgp. Bool
enableRateLimiting Sinalizador EnableBgp. Bool
ingressNatRules Lista de NatRules de entrada. sub-recursos[]
ipsecPolicies As Políticas IPSec a serem consideradas por essa conexão. IpsecPolicy []
routingWeight Peso de roteamento para conexão vpn. int
sharedKey SharedKey para a conexão vpn. corda
useLocalAzureIpAddress Use o ip do azure local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilitar seletores de tráfego baseados em política. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses usados por essa conexão. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de conexão de link vpn. 'Padrão'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink ID do link do site vpn conectado. sub-recurso

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
cria recursos de WAN Virtual Esse modelo permite que você crie recursos de WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway de VPN, Site de VPN e um Vpn Connecton.

Definição de recurso de modelo do ARM

O tipo de recurso vpnGateways pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/vpnGateways, adicione o JSON a seguir ao seu modelo.

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2023-06-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "connections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "connectionBandwidth": "int",
          "dpdTimeoutSeconds": "int",
          "enableBgp": "bool",
          "enableInternetSecurity": "bool",
          "enableRateLimiting": "bool",
          "ipsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "remoteVpnSite": {
            "id": "string"
          },
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "inboundRouteMap": {
              "id": "string"
            },
            "outboundRouteMap": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ],
              "staticRoutesConfig": {
                "vnetLocalRouteOverrideCriteria": "string"
              }
            }
          },
          "routingWeight": "int",
          "sharedKey": "string",
          "trafficSelectorPolicies": [
            {
              "localAddressRanges": [ "string" ],
              "remoteAddressRanges": [ "string" ]
            }
          ],
          "useLocalAzureIpAddress": "bool",
          "usePolicyBasedTrafficSelectors": "bool",
          "vpnConnectionProtocolType": "string",
          "vpnLinkConnections": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "connectionBandwidth": "int",
                "egressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "enableBgp": "bool",
                "enableRateLimiting": "bool",
                "ingressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "ipsecPolicies": [
                  {
                    "dhGroup": "string",
                    "ikeEncryption": "string",
                    "ikeIntegrity": "string",
                    "ipsecEncryption": "string",
                    "ipsecIntegrity": "string",
                    "pfsGroup": "string",
                    "saDataSizeKilobytes": "int",
                    "saLifeTimeSeconds": "int"
                  }
                ],
                "routingWeight": "int",
                "sharedKey": "string",
                "useLocalAzureIpAddress": "bool",
                "usePolicyBasedTrafficSelectors": "bool",
                "vpnConnectionProtocolType": "string",
                "vpnGatewayCustomBgpAddresses": [
                  {
                    "customBgpIpAddress": "string",
                    "ipConfigurationId": "string"
                  }
                ],
                "vpnLinkConnectionMode": "string",
                "vpnSiteLink": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": "bool",
    "isRoutingPreferenceInternet": "bool",
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

BgpSettings

Nome Descrição Valor
Asn O ASN do alto-falante BGP. int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
bgpPeeringAddress O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP. corda
bgpPeeringAddresses Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual. IPConfigurationBgpPeeringAddress []
peerWeight O peso adicionado às rotas aprendidas com esse alto-falante BGP. int

GatewayCustomBgpIpAddressIpConfiguration

Nome Descrição Valor
customBgpIpAddress O BgpPeeringAddress personalizado que pertence a IpconfigurationId. cadeia de caracteres (obrigatório)
ipConfigurationId A IpconfigurationId de ipconfiguration que pertence ao gateway. cadeia de caracteres (obrigatório)

IPConfigurationBgpPeeringAddress

Nome Descrição Valor
customBgpIpAddresses A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP. string[]
ipconfigurationId A ID da configuração de IP que pertence ao gateway. corda

IpsecPolicy

Nome Descrição Valor
dhGroup O grupo DH usado na Fase 1 do IKE para SA inicial. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
'ECP256'
'ECP384'
'None' (obrigatório)
ikeEncryption O algoritmo de criptografia IKE (fase 2 do IKE). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES256' (obrigatório)
ikeIntegrity O algoritmo de integridade IKE (fase 2 do IKE). 'GCMAES128'
'GCMAES256'
'MD5'
'SHA1'
'SHA256'
'SHA384' (obrigatório)
ipsecEncryption O algoritmo de criptografia IPSec (fase 1 do IKE). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES192'
'GCMAES256'
'None' (obrigatório)
ipsecIntegrity O algoritmo de integridade IPSec (IKE fase 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
'MD5'
'SHA1'
'SHA256' (obrigatório)
pfsGroup O Grupo de Pfs usado na Fase 2 do IKE para a NOVA SA filho. 'ECP256'
'ECP384'
'None'
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
'PFSMM' (obrigatório)
saDataSizeKilobytes O tamanho da carga da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA fase 2) em KB para um túnel VPN site a site. int (obrigatório)
saLifeTimeSeconds A Associação de Segurança ipsec (também chamada de modo rápido ou sa fase 2) tempo de vida em segundos para um túnel VPN site a site. int (obrigatório)

Microsoft.Network/vpnGateways

Nome Descrição Valor
apiVersion A versão da API '2023-06-01'
localização Local do recurso. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do gateway de VPN. VpnGatewayProperties
Tags Marcações de recursos Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.Network/vpnGateways'

PropagatedRouteTable

Nome Descrição Valor
Ids A lista de IDs de recurso de todas as RouteTables. sub-recursos[]
Rótulos A lista de rótulos. string[]

ResourceTags

Nome Descrição Valor

RoutingConfiguration

Nome Descrição Valor
associatedRouteTable A ID do recurso RouteTable associada a esse RoutingConfiguration. sub-recurso
inboundRouteMap A ID de recurso do RouteMap associado a esse RoutingConfiguration para rotas aprendidas de entrada. sub-recurso
outboundRouteMap A ID de recurso do TheRouteMap associada a esse RoutingConfiguration para rotas anunciadas de saída. sub-recurso
propagatedRouteTables A lista de RouteTables para a qual anunciar as rotas. PropagatedRouteTable
vnetRoutes Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. do VnetRoute

StaticRoute

Nome Descrição Valor
addressPrefixes Lista de todos os prefixos de endereço. string[]
nome O nome do StaticRoute exclusivo em um VnetRoute. corda
nextHopIpAddress O endereço ip do próximo salto. corda

StaticRoutesConfig

Nome Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se a rede virtual NVA no spoke é ignorada para tráfego com destino no spoke. 'Contains'
'Igual'

SubResource

Nome Descrição Valor
id ID do recurso. corda

TrafficSelectorPolicy

Nome Descrição Valor
localAddressRanges Uma coleção de espaços de endereço local no formato CIDR. string[] (obrigatório)
remoteAddressRanges Uma coleção de espaços de endereço remoto no formato CIDR. string[] (obrigatório)

VnetRoute

Nome Descrição Valor
staticRoutes Lista de todas as rotas estáticas. StaticRoute []
staticRoutesConfig Configuração para rotas estáticas neste HubVnetConnection. StaticRoutesConfig

VpnConnection

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da conexão VPN. VpnConnectionProperties

VpnConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
dpdTimeoutSeconds Tempo limite de DPD em segundos para conexão vpn. int
enableBgp Sinalizador EnableBgp. Bool
enableInternetSecurity Habilitar a segurança da Internet. Bool
enableRateLimiting Sinalizador EnableBgp. Bool
ipsecPolicies As Políticas IPSec a serem consideradas por essa conexão. IpsecPolicy []
remoteVpnSite ID do site de VPN conectado. sub-recurso
routingConfiguration A Configuração de Roteamento que indica as tabelas de rotas associadas e propagadas nessa conexão. RoutingConfiguration
routingWeight Peso de roteamento para conexão vpn. int
sharedKey SharedKey para a conexão vpn. corda
trafficSelectorPolicies As Políticas do Seletor de Tráfego a serem consideradas por essa conexão. TrafficSelectorPolicy []
useLocalAzureIpAddress Use o ip do azure local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilitar seletores de tráfego baseados em política. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnLinkConnections Lista de todas as conexões de link de site vpn para o gateway. VpnSiteLinkConnection []

VpnGatewayNatRule

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da regra NAT do VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nome Descrição Valor
externalMappings O mapeamento externo de endereço IP privado para NAT. VpnNatRuleMapping []
internalMappings O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping []
ipConfigurationId A ID de Configuração de IP à qual essa regra NAT se aplica. corda
modo A direção nat de origem de um NAT VPN. 'EgressSnat'
'IngressSnat'
tipo O tipo de regra NAT para VPN NAT. 'Dinâmico'
'Estático'

VpnGatewayProperties

Nome Descrição Valor
bgpSettings Configurações do alto-falante BGP do gateway de rede local. bgpSettings
Conexões Lista de todas as conexões vpn com o gateway. vpnConnection []
enableBgpRouteTranslationForNat Habilite a tradução de rotas BGP para NAT neste VpnGateway. Bool
isRoutingPreferenceInternet Habilite a propriedade Preferência de Roteamento para a Interface ip pública do VpnGateway. Bool
natRules Lista de todas as regras nat associadas ao gateway. VpnGatewayNatRule []
virtualHub O VirtualHub ao qual o gateway pertence. sub-recurso
vpnGatewayScaleUnit A unidade de escala para esse gateway de VPN. int

VpnNatRuleMapping

Nome Descrição Valor
addressSpace Espaço de endereço para mapeamento de NatRule vpn. corda
portRange Intervalo de portas para mapeamento de NatRule de Vpn. corda

VpnSiteLinkConnection

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da conexão de link do site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
egressNatRules Lista de NatRules de saída. sub-recursos[]
enableBgp Sinalizador EnableBgp. Bool
enableRateLimiting Sinalizador EnableBgp. Bool
ingressNatRules Lista de NatRules de entrada. sub-recursos[]
ipsecPolicies As Políticas IPSec a serem consideradas por essa conexão. IpsecPolicy []
routingWeight Peso de roteamento para conexão vpn. int
sharedKey SharedKey para a conexão vpn. corda
useLocalAzureIpAddress Use o ip do azure local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilitar seletores de tráfego baseados em política. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses usados por essa conexão. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de conexão de link vpn. 'Padrão'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink ID do link do site vpn conectado. sub-recurso

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
implantação de vários hubs da WAN Virtual do Azure (vWAN)

Implantar no Azure 		Esse modelo permite que você crie uma implantação de vários hubs da WAN Virtual do Azure (vWAN), incluindo todos os gateways e conexões VNET.
implantação de vários hubs vWAN do Azure com tabelas de roteamento personalizadas

Implantar no Azure 		Esse modelo permite que você crie uma implantação de vários hubs da WAN Virtual do Azure (vWAN), incluindo todos os gateways e conexões VNET, e demonstre o uso de Tabelas de Rota para roteamento personalizado.
cria recursos de WAN Virtual

Implantar no Azure 		Esse modelo permite que você crie recursos de WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway de VPN, Site de VPN e um Vpn Connecton.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso vpnGateways pode ser implantado com operações de destino:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/vpnGateways, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2023-06-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      connections = [
        {
          id = "string"
          name = "string"
          properties = {
            connectionBandwidth = int
            dpdTimeoutSeconds = int
            enableBgp = bool
            enableInternetSecurity = bool
            enableRateLimiting = bool
            ipsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            remoteVpnSite = {
              id = "string"
            }
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              inboundRouteMap = {
                id = "string"
              }
              outboundRouteMap = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
                staticRoutesConfig = {
                  vnetLocalRouteOverrideCriteria = "string"
                }
              }
            }
            routingWeight = int
            sharedKey = "string"
            trafficSelectorPolicies = [
              {
                localAddressRanges = [
                  "string"
                ]
                remoteAddressRanges = [
                  "string"
                ]
              }
            ]
            useLocalAzureIpAddress = bool
            usePolicyBasedTrafficSelectors = bool
            vpnConnectionProtocolType = "string"
            vpnLinkConnections = [
              {
                id = "string"
                name = "string"
                properties = {
                  connectionBandwidth = int
                  egressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  enableBgp = bool
                  enableRateLimiting = bool
                  ingressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  ipsecPolicies = [
                    {
                      dhGroup = "string"
                      ikeEncryption = "string"
                      ikeIntegrity = "string"
                      ipsecEncryption = "string"
                      ipsecIntegrity = "string"
                      pfsGroup = "string"
                      saDataSizeKilobytes = int
                      saLifeTimeSeconds = int
                    }
                  ]
                  routingWeight = int
                  sharedKey = "string"
                  useLocalAzureIpAddress = bool
                  usePolicyBasedTrafficSelectors = bool
                  vpnConnectionProtocolType = "string"
                  vpnGatewayCustomBgpAddresses = [
                    {
                      customBgpIpAddress = "string"
                      ipConfigurationId = "string"
                    }
                  ]
                  vpnLinkConnectionMode = "string"
                  vpnSiteLink = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      enableBgpRouteTranslationForNat = bool
      isRoutingPreferenceInternet = bool
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Valores de propriedade

BgpSettings

Nome Descrição Valor
Asn O ASN do alto-falante BGP. int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
bgpPeeringAddress O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP. corda
bgpPeeringAddresses Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual. IPConfigurationBgpPeeringAddress []
peerWeight O peso adicionado às rotas aprendidas com esse alto-falante BGP. int

GatewayCustomBgpIpAddressIpConfiguration

Nome Descrição Valor
customBgpIpAddress O BgpPeeringAddress personalizado que pertence a IpconfigurationId. cadeia de caracteres (obrigatório)
ipConfigurationId A IpconfigurationId de ipconfiguration que pertence ao gateway. cadeia de caracteres (obrigatório)

IPConfigurationBgpPeeringAddress

Nome Descrição Valor
customBgpIpAddresses A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP. string[]
ipconfigurationId A ID da configuração de IP que pertence ao gateway. corda

IpsecPolicy

Nome Descrição Valor
dhGroup O grupo DH usado na Fase 1 do IKE para SA inicial. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
'ECP256'
'ECP384'
'None' (obrigatório)
ikeEncryption O algoritmo de criptografia IKE (fase 2 do IKE). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES256' (obrigatório)
ikeIntegrity O algoritmo de integridade IKE (fase 2 do IKE). 'GCMAES128'
'GCMAES256'
'MD5'
'SHA1'
'SHA256'
'SHA384' (obrigatório)
ipsecEncryption O algoritmo de criptografia IPSec (fase 1 do IKE). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES192'
'GCMAES256'
'None' (obrigatório)
ipsecIntegrity O algoritmo de integridade IPSec (IKE fase 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
'MD5'
'SHA1'
'SHA256' (obrigatório)
pfsGroup O Grupo de Pfs usado na Fase 2 do IKE para a NOVA SA filho. 'ECP256'
'ECP384'
'None'
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
'PFSMM' (obrigatório)
saDataSizeKilobytes O tamanho da carga da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA fase 2) em KB para um túnel VPN site a site. int (obrigatório)
saLifeTimeSeconds A Associação de Segurança ipsec (também chamada de modo rápido ou sa fase 2) tempo de vida em segundos para um túnel VPN site a site. int (obrigatório)

Microsoft.Network/vpnGateways

Nome Descrição Valor
localização Local do recurso. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do gateway de VPN. VpnGatewayProperties
Tags Marcações de recursos Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.Network/vpnGateways@2023-06-01"

PropagatedRouteTable

Nome Descrição Valor
Ids A lista de IDs de recurso de todas as RouteTables. sub-recursos[]
Rótulos A lista de rótulos. string[]

ResourceTags

Nome Descrição Valor

RoutingConfiguration

Nome Descrição Valor
associatedRouteTable A ID do recurso RouteTable associada a esse RoutingConfiguration. sub-recurso
inboundRouteMap A ID de recurso do RouteMap associado a esse RoutingConfiguration para rotas aprendidas de entrada. sub-recurso
outboundRouteMap A ID de recurso do TheRouteMap associada a esse RoutingConfiguration para rotas anunciadas de saída. sub-recurso
propagatedRouteTables A lista de RouteTables para a qual anunciar as rotas. PropagatedRouteTable
vnetRoutes Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. do VnetRoute

StaticRoute

Nome Descrição Valor
addressPrefixes Lista de todos os prefixos de endereço. string[]
nome O nome do StaticRoute exclusivo em um VnetRoute. corda
nextHopIpAddress O endereço ip do próximo salto. corda

StaticRoutesConfig

Nome Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se a rede virtual NVA no spoke é ignorada para tráfego com destino no spoke. 'Contains'
'Igual'

SubResource

Nome Descrição Valor
id ID do recurso. corda

TrafficSelectorPolicy

Nome Descrição Valor
localAddressRanges Uma coleção de espaços de endereço local no formato CIDR. string[] (obrigatório)
remoteAddressRanges Uma coleção de espaços de endereço remoto no formato CIDR. string[] (obrigatório)

VnetRoute

Nome Descrição Valor
staticRoutes Lista de todas as rotas estáticas. StaticRoute []
staticRoutesConfig Configuração para rotas estáticas neste HubVnetConnection. StaticRoutesConfig

VpnConnection

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da conexão VPN. VpnConnectionProperties

VpnConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
dpdTimeoutSeconds Tempo limite de DPD em segundos para conexão vpn. int
enableBgp Sinalizador EnableBgp. Bool
enableInternetSecurity Habilitar a segurança da Internet. Bool
enableRateLimiting Sinalizador EnableBgp. Bool
ipsecPolicies As Políticas IPSec a serem consideradas por essa conexão. IpsecPolicy []
remoteVpnSite ID do site de VPN conectado. sub-recurso
routingConfiguration A Configuração de Roteamento que indica as tabelas de rotas associadas e propagadas nessa conexão. RoutingConfiguration
routingWeight Peso de roteamento para conexão vpn. int
sharedKey SharedKey para a conexão vpn. corda
trafficSelectorPolicies As Políticas do Seletor de Tráfego a serem consideradas por essa conexão. TrafficSelectorPolicy []
useLocalAzureIpAddress Use o ip do azure local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilitar seletores de tráfego baseados em política. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnLinkConnections Lista de todas as conexões de link de site vpn para o gateway. VpnSiteLinkConnection []

VpnGatewayNatRule

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da regra NAT do VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nome Descrição Valor
externalMappings O mapeamento externo de endereço IP privado para NAT. VpnNatRuleMapping []
internalMappings O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping []
ipConfigurationId A ID de Configuração de IP à qual essa regra NAT se aplica. corda
modo A direção nat de origem de um NAT VPN. 'EgressSnat'
'IngressSnat'
tipo O tipo de regra NAT para VPN NAT. 'Dinâmico'
'Estático'

VpnGatewayProperties

Nome Descrição Valor
bgpSettings Configurações do alto-falante BGP do gateway de rede local. bgpSettings
Conexões Lista de todas as conexões vpn com o gateway. vpnConnection []
enableBgpRouteTranslationForNat Habilite a tradução de rotas BGP para NAT neste VpnGateway. Bool
isRoutingPreferenceInternet Habilite a propriedade Preferência de Roteamento para a Interface ip pública do VpnGateway. Bool
natRules Lista de todas as regras nat associadas ao gateway. VpnGatewayNatRule []
virtualHub O VirtualHub ao qual o gateway pertence. sub-recurso
vpnGatewayScaleUnit A unidade de escala para esse gateway de VPN. int

VpnNatRuleMapping

Nome Descrição Valor
addressSpace Espaço de endereço para mapeamento de NatRule vpn. corda
portRange Intervalo de portas para mapeamento de NatRule de Vpn. corda

VpnSiteLinkConnection

Nome Descrição Valor
id ID do recurso. corda
nome O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso. corda
Propriedades Propriedades da conexão de link do site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
egressNatRules Lista de NatRules de saída. sub-recursos[]
enableBgp Sinalizador EnableBgp. Bool
enableRateLimiting Sinalizador EnableBgp. Bool
ingressNatRules Lista de NatRules de entrada. sub-recursos[]
ipsecPolicies As Políticas IPSec a serem consideradas por essa conexão. IpsecPolicy []
routingWeight Peso de roteamento para conexão vpn. int
sharedKey SharedKey para a conexão vpn. corda
useLocalAzureIpAddress Use o ip do azure local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilitar seletores de tráfego baseados em política. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses usados por essa conexão. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de conexão de link vpn. 'Padrão'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink ID do link do site vpn conectado. sub-recurso