Partilhar via

Microsoft.Network vpnGateways 2024-01-01

  • Artigo

Definição de recursos do bíceps

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

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

Formato do recurso

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

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

Valores de propriedade

BgpSettings

Designação Descrição Valor
ASN ASN do orador BGP. Int

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

GatewayCustomBgpIpAddressIpConfiguration

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

IPConfigurationBgpPeeringAddress

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

IpsecPolicy

Designação Descrição Valor
Grupo dh O Grupo DH utilizado na Fase 1 do IKE para a SA inicial. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
«ECP256»
«ECP384»
«Nenhum» (obrigatório)
ikeEncriptação O algoritmo de encriptação IKE (fase 2 IKE). «AES128»
«AES192»
«AES256»
'DES'
«DES3»
'GCMAES128'
'GCMAES256' (obrigatório)
ikeIntegridade O algoritmo de integridade IKE (fase 2 do IKE). 'GCMAES128'
'GCMAES256'
«MD5»
'SHA1'
'SHA256'
'SHA384' (obrigatório)
ipsecEncryption O algoritmo de encriptação IPSec (IKE fase 1). «AES128»
«AES192»
«AES256»
'DES'
«DES3»
'GCMAES128'
'GCMAES192'
'GCMAES256'
«Nenhum» (obrigatório)
ipsecIntegridade O algoritmo de integridade IPSec (IKE fase 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
«MD5»
'SHA1'
'SHA256' (obrigatório)
Grupo pfs O Grupo Pfs usado na Fase 2 do IKE para a nova criança SA. «ECP256»
«ECP384»
'Nenhuma'
«PFS1»
«PFS14»
«PFS2»
'PFS2048'
«PFS24» (obrigatório)
saDataSizeKilobytes O tamanho da carga útil da Associação de Segurança IPSec (também chamada de Modo Rápido ou SA de Fase 2) em KB para um túnel VPN site a site. int (obrigatório)
saLifeTimeSegundos O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA de Fase 2) é executado em segundos para um túnel VPN site a site. int (obrigatório)

Microsoft.Network/vpnGateways

Designação Descrição Valor
Localização Localização do recurso. string
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do gateway VPN. VpnGatewayProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

PropagatedRouteTable

Designação Descrição Valor
IDs A lista de ids de recursos de todas as RouteTables. SubResource[]
rótulos A lista de rótulos. string[]

Tags de Recursos

Designação Descrição Valor

RoutingConfiguration

Designação Descrição Valor
RouteTable associado A id do recurso RouteTable associada a esta RoutingConfiguration. SubResource
inboundRouteMap A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas aprendidas de entrada. SubResource
outboundRouteMapa A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas anunciadas de saída. SubResource
propagatedRouteTables A lista de RouteTables para anunciar as rotas. PropagatedRouteTable
vnetRotas Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. VnetRoute

Rota Estática

Designação Descrição Valor
addressPrefixes Lista de todos os prefixos de endereço. string[]
Designação O nome do StaticRoute que é exclusivo dentro de um VnetRoute. string
próximoHopIpAddress O endereço ip do próximo salto. string

StaticRoutesConfig

Designação Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se o NVA na vnet spoke é ignorado para o tráfego com destino em spoke. «Contém»
'Igual'

Subrecurso

Designação Descrição Valor
ID ID do recurso. string

TrafficSelectorPolicy

Designação 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

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

Conexão VpnConnection

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da conexão VPN. VpnConnectionProperties

VpnConnectionProperties

Designação Descrição Valor
conexãoLargura de banda Largura de banda esperada em MBPS. Int
dpdTimeoutSeconds Tempo limite do DPD em segundos para conexão vpn. Int
habilitaçãoBgp Sinalizador EnableBgp. Bool
habilitarInternetSecurity Habilite a segurança na Internet. Bool
enableRateLimitando Sinalizador EnableBgp. Bool
ipsecPolíticas As políticas IPSec a serem consideradas por esta ligação. IpsecPolicy []
remoteVpnSite ID do site vpn conectado. SubResource
RoutingConfiguration A Configuração de Roteamento indica as tabelas de rotas associadas e propagadas nessa conexão. RoutingConfiguration
roteamentoPeso Peso de roteamento para conexão vpn. Int
sharedKey SharedKey para a conexão vpn. string
trafficSelectorPolicies As Políticas do Seletor de Tráfego a serem consideradas por essa conexão. TrafficSelectorPolicy []
useLocalAzureIpAddress Use o azure ip local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilite seletores de tráfego baseados em políticas. 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

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da regra NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Designação Descrição Valor
mapeamentos externos O mapeamento externo do endereço IP privado para NAT. VpnNatRuleMapping []
mapeamentos internos O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping []
ipConfigurationId O ID de configuração IP ao qual esta regra NAT se aplica. string
modo A direção NAT de origem de um NAT VPN. 'EgressSnat'
'IngressSnat'
tipo O tipo de regra NAT para NAT VPN. 'Dinâmico'
'Estática'

VpnGatewayProperties

Designação Descrição Valor
bgpConfigurações Configurações de alto-falante BGP do gateway de rede local. BgpSettings
conexões Lista de todas as conexões vpn para o gateway. VpnConnection []
enableBgpRouteTranslationForNat Habilite a conversão de rotas BGP para NAT neste VpnGateway. Bool
isRoutingPreferenceInternet Habilite a propriedade Routing Preference para a interface IP pública do VpnGateway. Bool
natRegras Lista de todas as regras nat associadas ao gateway. VpnGatewayNatRule []
Hub virtual O VirtualHub ao qual o gateway pertence. SubResource
vpnGatewayScaleUnit A unidade de escala para este gateway vpn. Int

VpnNatRuleMapping

Designação Descrição Valor
endereçoEspaço Espaço de endereço para mapeamento Vpn NatRule. string
portRange Intervalo de portas para mapeamento Vpn NatRule. string

VpnSiteLinkConnection

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da conexão de link de site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Designação Descrição Valor
conexãoLargura de banda Largura de banda esperada em MBPS. Int
dpdTimeoutSeconds Tempo limite de deteção de peer inativo em segundos para conexão VpnLink. Int
egressNatRules Lista de NatRules de saída. SubResource[]
habilitaçãoBgp Sinalizador EnableBgp. Bool
enableRateLimitando Sinalizador EnableBgp. Bool
ingressNatRules Lista de ingress NatRules. SubResource[]
ipsecPolíticas As políticas IPSec a serem consideradas por esta ligação. IpsecPolicy []
roteamentoPeso Peso de roteamento para conexão vpn. Int
sharedKey SharedKey para a conexão vpn. string
useLocalAzureIpAddress Use o azure ip local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilite seletores de tráfego baseados em políticas. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses usado por esta conexão. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de conexão de link vpn. 'Inadimplência'
'Apenas iniciador'
'Apenas responder'
vpnSiteLink ID do link do site vpn conectado. SubResource

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 Este modelo permite que você crie recursos de WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway VPN, Site VPN e um VPN Connecton.

Definição de recurso de modelo ARM

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

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

Formato do recurso

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

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

Valores de propriedade

BgpSettings

Designação Descrição Valor
ASN ASN do orador BGP. Int

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

GatewayCustomBgpIpAddressIpConfiguration

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

IPConfigurationBgpPeeringAddress

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

IpsecPolicy

Designação Descrição Valor
Grupo dh O Grupo DH utilizado na Fase 1 do IKE para a SA inicial. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
«ECP256»
«ECP384»
«Nenhum» (obrigatório)
ikeEncriptação O algoritmo de encriptação IKE (fase 2 IKE). «AES128»
«AES192»
«AES256»
'DES'
«DES3»
'GCMAES128'
'GCMAES256' (obrigatório)
ikeIntegridade O algoritmo de integridade IKE (fase 2 do IKE). 'GCMAES128'
'GCMAES256'
«MD5»
'SHA1'
'SHA256'
'SHA384' (obrigatório)
ipsecEncryption O algoritmo de encriptação IPSec (IKE fase 1). «AES128»
«AES192»
«AES256»
'DES'
«DES3»
'GCMAES128'
'GCMAES192'
'GCMAES256'
«Nenhum» (obrigatório)
ipsecIntegridade O algoritmo de integridade IPSec (IKE fase 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
«MD5»
'SHA1'
'SHA256' (obrigatório)
Grupo pfs O Grupo Pfs usado na Fase 2 do IKE para a nova criança SA. «ECP256»
«ECP384»
'Nenhuma'
«PFS1»
«PFS14»
«PFS2»
'PFS2048'
«PFS24» (obrigatório)
saDataSizeKilobytes O tamanho da carga útil da Associação de Segurança IPSec (também chamada de Modo Rápido ou SA de Fase 2) em KB para um túnel VPN site a site. int (obrigatório)
saLifeTimeSegundos O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA de Fase 2) é executado em segundos para um túnel VPN site a site. int (obrigatório)

Microsoft.Network/vpnGateways

Designação Descrição Valor
apiVersion A versão api '2024-01-01'
Localização Localização do recurso. string
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do gateway VPN. VpnGatewayProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Network/vpnGateways'

PropagatedRouteTable

Designação Descrição Valor
IDs A lista de ids de recursos de todas as RouteTables. SubResource[]
rótulos A lista de rótulos. string[]

Tags de Recursos

Designação Descrição Valor

RoutingConfiguration

Designação Descrição Valor
RouteTable associado A id do recurso RouteTable associada a esta RoutingConfiguration. SubResource
inboundRouteMap A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas aprendidas de entrada. SubResource
outboundRouteMapa A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas anunciadas de saída. SubResource
propagatedRouteTables A lista de RouteTables para anunciar as rotas. PropagatedRouteTable
vnetRotas Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. VnetRoute

Rota Estática

Designação Descrição Valor
addressPrefixes Lista de todos os prefixos de endereço. string[]
Designação O nome do StaticRoute que é exclusivo dentro de um VnetRoute. string
próximoHopIpAddress O endereço ip do próximo salto. string

StaticRoutesConfig

Designação Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se o NVA na vnet spoke é ignorado para o tráfego com destino em spoke. «Contém»
'Igual'

Subrecurso

Designação Descrição Valor
ID ID do recurso. string

TrafficSelectorPolicy

Designação 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

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

Conexão VpnConnection

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da conexão VPN. VpnConnectionProperties

VpnConnectionProperties

Designação Descrição Valor
conexãoLargura de banda Largura de banda esperada em MBPS. Int
dpdTimeoutSeconds Tempo limite do DPD em segundos para conexão vpn. Int
habilitaçãoBgp Sinalizador EnableBgp. Bool
habilitarInternetSecurity Habilite a segurança na Internet. Bool
enableRateLimitando Sinalizador EnableBgp. Bool
ipsecPolíticas As políticas IPSec a serem consideradas por esta ligação. IpsecPolicy []
remoteVpnSite ID do site vpn conectado. SubResource
RoutingConfiguration A Configuração de Roteamento indica as tabelas de rotas associadas e propagadas nessa conexão. RoutingConfiguration
roteamentoPeso Peso de roteamento para conexão vpn. Int
sharedKey SharedKey para a conexão vpn. string
trafficSelectorPolicies As Políticas do Seletor de Tráfego a serem consideradas por essa conexão. TrafficSelectorPolicy []
useLocalAzureIpAddress Use o azure ip local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilite seletores de tráfego baseados em políticas. 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

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da regra NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Designação Descrição Valor
mapeamentos externos O mapeamento externo do endereço IP privado para NAT. VpnNatRuleMapping []
mapeamentos internos O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping []
ipConfigurationId O ID de configuração IP ao qual esta regra NAT se aplica. string
modo A direção NAT de origem de um NAT VPN. 'EgressSnat'
'IngressSnat'
tipo O tipo de regra NAT para NAT VPN. 'Dinâmico'
'Estática'

VpnGatewayProperties

Designação Descrição Valor
bgpConfigurações Configurações de alto-falante BGP do gateway de rede local. BgpSettings
conexões Lista de todas as conexões vpn para o gateway. VpnConnection []
enableBgpRouteTranslationForNat Habilite a conversão de rotas BGP para NAT neste VpnGateway. Bool
isRoutingPreferenceInternet Habilite a propriedade Routing Preference para a interface IP pública do VpnGateway. Bool
natRegras Lista de todas as regras nat associadas ao gateway. VpnGatewayNatRule []
Hub virtual O VirtualHub ao qual o gateway pertence. SubResource
vpnGatewayScaleUnit A unidade de escala para este gateway vpn. Int

VpnNatRuleMapping

Designação Descrição Valor
endereçoEspaço Espaço de endereço para mapeamento Vpn NatRule. string
portRange Intervalo de portas para mapeamento Vpn NatRule. string

VpnSiteLinkConnection

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da conexão de link de site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Designação Descrição Valor
conexãoLargura de banda Largura de banda esperada em MBPS. Int
dpdTimeoutSeconds Tempo limite de deteção de peer inativo em segundos para conexão VpnLink. Int
egressNatRules Lista de NatRules de saída. SubResource[]
habilitaçãoBgp Sinalizador EnableBgp. Bool
enableRateLimitando Sinalizador EnableBgp. Bool
ingressNatRules Lista de ingress NatRules. SubResource[]
ipsecPolíticas As políticas IPSec a serem consideradas por esta ligação. IpsecPolicy []
roteamentoPeso Peso de roteamento para conexão vpn. Int
sharedKey SharedKey para a conexão vpn. string
useLocalAzureIpAddress Use o azure ip local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilite seletores de tráfego baseados em políticas. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses usado por esta conexão. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de conexão de link vpn. 'Inadimplência'
'Apenas iniciador'
'Apenas responder'
vpnSiteLink ID do link do site vpn conectado. SubResource

Modelos de início rápido

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

Modelo Descrição
de Implantação Multihub da WAN Virtual do Azure (vWAN)

Implantar no Azure 		Este modelo permite criar uma implantação multihub da WAN Virtual do Azure (vWAN), incluindo todos os gateways e conexões VNET.
Implantação Multihub vWAN do Azure com tabelas de roteamento personalizadas

Implantar no Azure 		Este modelo permite criar uma implantação multihub da WAN Virtual do Azure (vWAN), incluindo todos os gateways e conexões VNET, e demonstrar o uso de Tabelas de Rotas para roteamento personalizado.
cria recursos de WAN virtual

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

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

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

Formato do recurso

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

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

Valores de propriedade

BgpSettings

Designação Descrição Valor
ASN ASN do orador BGP. Int

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

GatewayCustomBgpIpAddressIpConfiguration

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

IPConfigurationBgpPeeringAddress

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

IpsecPolicy

Designação Descrição Valor
Grupo dh O Grupo DH utilizado na Fase 1 do IKE para a SA inicial. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
«ECP256»
«ECP384»
«Nenhum» (obrigatório)
ikeEncriptação O algoritmo de encriptação IKE (fase 2 IKE). «AES128»
«AES192»
«AES256»
'DES'
«DES3»
'GCMAES128'
'GCMAES256' (obrigatório)
ikeIntegridade O algoritmo de integridade IKE (fase 2 do IKE). 'GCMAES128'
'GCMAES256'
«MD5»
'SHA1'
'SHA256'
'SHA384' (obrigatório)
ipsecEncryption O algoritmo de encriptação IPSec (IKE fase 1). «AES128»
«AES192»
«AES256»
'DES'
«DES3»
'GCMAES128'
'GCMAES192'
'GCMAES256'
«Nenhum» (obrigatório)
ipsecIntegridade O algoritmo de integridade IPSec (IKE fase 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
«MD5»
'SHA1'
'SHA256' (obrigatório)
Grupo pfs O Grupo Pfs usado na Fase 2 do IKE para a nova criança SA. «ECP256»
«ECP384»
'Nenhuma'
«PFS1»
«PFS14»
«PFS2»
'PFS2048'
«PFS24» (obrigatório)
saDataSizeKilobytes O tamanho da carga útil da Associação de Segurança IPSec (também chamada de Modo Rápido ou SA de Fase 2) em KB para um túnel VPN site a site. int (obrigatório)
saLifeTimeSegundos O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA de Fase 2) é executado em segundos para um túnel VPN site a site. int (obrigatório)

Microsoft.Network/vpnGateways

Designação Descrição Valor
Localização Localização do recurso. string
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do gateway VPN. VpnGatewayProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Network/vpnGateways@2024-01-01"

PropagatedRouteTable

Designação Descrição Valor
IDs A lista de ids de recursos de todas as RouteTables. SubResource[]
rótulos A lista de rótulos. string[]

Tags de Recursos

Designação Descrição Valor

RoutingConfiguration

Designação Descrição Valor
RouteTable associado A id do recurso RouteTable associada a esta RoutingConfiguration. SubResource
inboundRouteMap A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas aprendidas de entrada. SubResource
outboundRouteMapa A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas anunciadas de saída. SubResource
propagatedRouteTables A lista de RouteTables para anunciar as rotas. PropagatedRouteTable
vnetRotas Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual. VnetRoute

Rota Estática

Designação Descrição Valor
addressPrefixes Lista de todos os prefixos de endereço. string[]
Designação O nome do StaticRoute que é exclusivo dentro de um VnetRoute. string
próximoHopIpAddress O endereço ip do próximo salto. string

StaticRoutesConfig

Designação Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se o NVA na vnet spoke é ignorado para o tráfego com destino em spoke. «Contém»
'Igual'

Subrecurso

Designação Descrição Valor
ID ID do recurso. string

TrafficSelectorPolicy

Designação 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

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

Conexão VpnConnection

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da conexão VPN. VpnConnectionProperties

VpnConnectionProperties

Designação Descrição Valor
conexãoLargura de banda Largura de banda esperada em MBPS. Int
dpdTimeoutSeconds Tempo limite do DPD em segundos para conexão vpn. Int
habilitaçãoBgp Sinalizador EnableBgp. Bool
habilitarInternetSecurity Habilite a segurança na Internet. Bool
enableRateLimitando Sinalizador EnableBgp. Bool
ipsecPolíticas As políticas IPSec a serem consideradas por esta ligação. IpsecPolicy []
remoteVpnSite ID do site vpn conectado. SubResource
RoutingConfiguration A Configuração de Roteamento indica as tabelas de rotas associadas e propagadas nessa conexão. RoutingConfiguration
roteamentoPeso Peso de roteamento para conexão vpn. Int
sharedKey SharedKey para a conexão vpn. string
trafficSelectorPolicies As Políticas do Seletor de Tráfego a serem consideradas por essa conexão. TrafficSelectorPolicy []
useLocalAzureIpAddress Use o azure ip local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilite seletores de tráfego baseados em políticas. 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

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da regra NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Designação Descrição Valor
mapeamentos externos O mapeamento externo do endereço IP privado para NAT. VpnNatRuleMapping []
mapeamentos internos O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping []
ipConfigurationId O ID de configuração IP ao qual esta regra NAT se aplica. string
modo A direção NAT de origem de um NAT VPN. 'EgressSnat'
'IngressSnat'
tipo O tipo de regra NAT para NAT VPN. 'Dinâmico'
'Estática'

VpnGatewayProperties

Designação Descrição Valor
bgpConfigurações Configurações de alto-falante BGP do gateway de rede local. BgpSettings
conexões Lista de todas as conexões vpn para o gateway. VpnConnection []
enableBgpRouteTranslationForNat Habilite a conversão de rotas BGP para NAT neste VpnGateway. Bool
isRoutingPreferenceInternet Habilite a propriedade Routing Preference para a interface IP pública do VpnGateway. Bool
natRegras Lista de todas as regras nat associadas ao gateway. VpnGatewayNatRule []
Hub virtual O VirtualHub ao qual o gateway pertence. SubResource
vpnGatewayScaleUnit A unidade de escala para este gateway vpn. Int

VpnNatRuleMapping

Designação Descrição Valor
endereçoEspaço Espaço de endereço para mapeamento Vpn NatRule. string
portRange Intervalo de portas para mapeamento Vpn NatRule. string

VpnSiteLinkConnection

Designação Descrição Valor
ID ID do recurso. string
Designação O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. string
propriedades Propriedades da conexão de link de site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Designação Descrição Valor
conexãoLargura de banda Largura de banda esperada em MBPS. Int
dpdTimeoutSeconds Tempo limite de deteção de peer inativo em segundos para conexão VpnLink. Int
egressNatRules Lista de NatRules de saída. SubResource[]
habilitaçãoBgp Sinalizador EnableBgp. Bool
enableRateLimitando Sinalizador EnableBgp. Bool
ingressNatRules Lista de ingress NatRules. SubResource[]
ipsecPolíticas As políticas IPSec a serem consideradas por esta ligação. IpsecPolicy []
roteamentoPeso Peso de roteamento para conexão vpn. Int
sharedKey SharedKey para a conexão vpn. string
useLocalAzureIpAddress Use o azure ip local para iniciar a conexão. Bool
usePolicyBasedTrafficSelectors Habilite seletores de tráfego baseados em políticas. Bool
vpnConnectionProtocolType Protocolo de conexão usado para essa conexão. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses usado por esta conexão. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de conexão de link vpn. 'Inadimplência'
'Apenas iniciador'
'Apenas responder'
vpnSiteLink ID do link do site vpn conectado. SubResource