Microsoft.Network vpnGateways 2022-09-01

Definição de recurso do Bicep

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

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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@2022-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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
  }
}

Valores de propriedade

vpnGateways

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos, carateres de sublinhado, períodos e hífenes.

Comece com alfanumérico. Terminar alfanumérico ou caráter de sublinhado.
localização Localização do recurso. string
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
propriedades Propriedades do gateway de VPN. VpnGatewayProperties

VpnGatewayProperties

Nome Descrição Valor
bgpSettings Definições do altifalante BGP do gateway de rede local. BgpSettings
ligações Lista de todas as ligações vpn ao gateway. VpnConnection[]
enableBgpRouteTranslationForNat Ative a tradução de rotas BGP para NAT neste VpnGateway. bool
isRoutingPreferenceInternet Ative a propriedade Preferência de Encaminhamento 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 pertence o gateway. Sub-origem
vpnGatewayScaleUnit A unidade de dimensionamento deste gateway de vpn. int

BgpSettings

Nome Descrição Valor
asn O ASN do orador BGP. int
bgpPeeringAddress O endereço de peering BGP e o identificador BGP deste orador BGP. string
bgpPeeringAddresses Endereço de peering BGP com ID de configuração de IP para gateway de rede virtual. IPConfigurationBgpPeeringAddress[]
peerWeight O peso adicionado às rotas aprendidas com este orador BGP. int

IPConfigurationBgpPeeringAddress

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

VpnConnection

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da ligação VPN. VpnConnectionProperties

VpnConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada em MBPS. int
dpdTimeoutSeconds Tempo limite DPD em segundos para a ligação vpn. int
enableBgp Sinalizador EnableBgp. bool
enableInternetSecurity Ativar a segurança da Internet. bool
enableRateLimiting Sinalizador EnableBgp. bool
ipsecPolicies As Políticas IPSec a considerar por esta ligação. IpsecPolicy[]
remoteVpnSite ID do site de VPN ligado. Sub-origem
routingConfiguration A Configuração de Encaminhamento que indica as tabelas de rotas associadas e propagadas nesta ligação. RoutingConfiguration
routingWeight Peso do encaminhamento para a ligação vpn. int
sharedKey SharedKey para a ligação vpn. string
trafficSelectorPolicies As Políticas do Seletor de Tráfego a considerar por esta ligação. TrafficSelectorPolicy[]
useLocalAzureIpAddress Utilize o ip do azure local para iniciar a ligação. bool
usePolicyBasedTrafficSelectors Ativar seletores de tráfego baseados em políticas. bool
vpnConnectionProtocolType Protocolo de ligação utilizado para esta ligação. 'IKEv1'
'IKEv2'
vpnLinkConnections Lista de todas as ligações do site vpn ao gateway. VpnSiteLinkConnection[]

IpsecPolicy

Nome Descrição Valor
dhGroup O Grupo DH utilizado na Fase 1 do IKE para SA inicial. "DHGroup1"
"DHGroup14"
"DHGroup2"
"DHGroup2048"
"DHGroup24"
"ECP256"
"ECP384"
"Nenhum" (obrigatório)
ikeEncryption O algoritmo de encriptação IKE (fase 2 do IKE). 'AES128'
'AES192'
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES256" (obrigatório)
Integridade do ike O algoritmo de integridade IKE (fase 2 do IKE). "GCMAES128"
"GCMAES256"
'MD5'
'SHA1'
'SHA256'
"SHA384" (obrigatório)
ipsecEncryption O algoritmo de encriptação IPSec (fase 1 do IKE). 'AES128'
'AES192'
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES192"
"GCMAES256"
"Nenhum" (obrigatório)
Integridade do ipsec O algoritmo de integridade IPSec (fase 1 do IKE). "GCMAES128"
"GCMAES192"
"GCMAES256"
'MD5'
'SHA1'
"SHA256" (obrigatório)
pfsGroup O Grupo Pfs utilizado na Fase 2 do IKE para a nova SA subordinada. "ECP256"
"ECP384"
"Nenhum"
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
"PFSMM" (obrigatório)
saDataSizeKilobytes O tamanho do payload da Associação de Segurança IPSec (também denominado Modo Rápido ou Fase 2 SA) em KB para um túnel de VPN site a site. int (obrigatório)
saLifeTimeSeconds A duração da Associação de Segurança IPSec (também denominada Modo Rápido ou Fase 2 SA) em segundos para um túnel de VPN site a site. int (obrigatório)

Sub-origem

Nome Descrição Valor
ID ID do Recurso. string

RoutingConfiguration

Nome Descrição Valor
associatedRouteTable O ID de recurso RouteTable associado a esta RoutingConfiguration. Sub-origem
inboundRouteMap O ID de recurso do RouteMap associado a esta RoutingConfiguration para rotas aprendidas de entrada. Sub-origem
outboundRouteMap O ID de recurso doRouteMap associado a esta RoutingConfiguration para rotas anunciadas de saída. Sub-origem
propagatedRouteTables A lista de RouteTables para anunciar as rotas. PropagatedRouteTable
vnetRoutes Lista de rotas que controlam o encaminhamento do VirtualHub para uma ligação de rede virtual. VnetRoute

PropagatedRouteTable

Nome Descrição Valor
IDs A lista de IDs de recursos de todas as RouteTables. Subresource[]
etiquetas A lista de etiquetas. string[]

VnetRoute

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

StaticRoute

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

StaticRoutesConfig

Nome Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se a NVA na vnet spoke é ignorada para o tráfego com destino no spoke. "Contém"
'Igual'

TrafficSelectorPolicy

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

VpnSiteLinkConnection

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da ligação de ligação do site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
egressNatRules Lista de NatRules de saída. SubResource[]
enableBgp Sinalizador EnableBgp. bool
enableRateLimiting Sinalizador EnableBgp. bool
ingressNatRules Lista de NatRules de entrada. SubResource[]
ipsecPolicies As Políticas IPSec a considerar por esta ligação. IpsecPolicy[]
routingWeight Peso do encaminhamento para a ligação vpn. int
sharedKey SharedKey para a ligação vpn. string
useLocalAzureIpAddress Utilize o ip do azure local para iniciar a ligação. bool
usePolicyBasedTrafficSelectors Ativar seletores de tráfego baseados em políticas. bool
vpnConnectionProtocolType Protocolo de ligação utilizado para esta ligação. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses utilizados por esta ligação. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de ligação de ligação VPN. 'Predefinição'
"InitiatorOnly"
'ResponderOnly'
vpnSiteLink ID da ligação do site vpn ligado. Sub-origem

GatewayCustomBgpIpAddressIpConfiguration

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

VpnGatewayNatRule

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da regra NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nome Descrição Valor
externalMappings O mapeamento externo do endereço IP privado para NAT. VpnNatRuleMapping[]
internalMappings O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping[]
ipConfigurationId O ID de Configuração de IP a que esta regra NAT se aplica. string
mode A direção NAT de origem de um NAT de VPN. "EgressSnat"
"IngressSnat"
tipo O tipo de regra NAT para NAT de VPN. "Dinâmico"
"Estático"

VpnNatRuleMapping

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

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Descrição
Cria recursos WAN Virtual

Implementar no Azure
Este modelo permite-lhe criar recursos da WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway de VPN, Site VPN e um Conector de VPN.
Implementação de Vários Hubs do Azure WAN Virtual (vWAN)

Implementar no Azure
Este modelo permite-lhe criar uma implementação multi-hub do Azure WAN Virtual (vWAN), incluindo todos os gateways e ligações VNET.
Implementação de Vários Hubs do Azure vWAN com Tabelas de Encaminhamento Personalizadas

Implementar no Azure
Este modelo permite-lhe criar uma implementação multi-hub do Azure WAN Virtual (vWAN), incluindo todos os gateways e ligações VNET, e demonstrar a utilização de Tabelas de Rotas para encaminhamento personalizado.

Definição de recurso do modelo arm

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

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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": "2022-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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"
  }
}

Valores de propriedade

vpnGateways

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Network/vpnGateways"
apiVersion A versão da API de recursos '2022-09-01'
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos, carateres de sublinhado, períodos e hífenes.

Comece com alfanumérico. Terminar alfanumérico ou caráter de sublinhado.
localização Localização do recurso. string
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
propriedades Propriedades do gateway de VPN. VpnGatewayProperties

VpnGatewayProperties

Nome Descrição Valor
bgpSettings Definições do altifalante BGP do gateway de rede local. BgpSettings
ligações Lista de todas as ligações vpn ao gateway. VpnConnection[]
enableBgpRouteTranslationForNat Ative a tradução de rotas BGP para NAT neste VpnGateway. bool
isRoutingPreferenceInternet Ative a propriedade Preferência de Encaminhamento para a Interface de IP Público do VpnGateway. bool
natRules Lista de todas as Regras nat associadas ao gateway. VpnGatewayNatRule[]
virtualHub O VirtualHub ao qual o gateway pertence. Sub-origem
vpnGatewayScaleUnit A unidade de escala para este gateway de vpn. int

BgpSettings

Nome Descrição Valor
asn O ASN do orador BGP. int
bgpPeeringAddress O endereço de peering BGP e o identificador BGP deste orador BGP. string
bgpPeeringAddresses Endereço de peering BGP com ID de configuração de IP para gateway de rede virtual. IPConfigurationBgpPeeringAddress[]
peerWeight O peso adicionado às rotas aprendidas com este altifalante BGP. int

IPConfigurationBgpPeeringAddress

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

VpnConnection

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da ligação VPN. VpnConnectionProperties

VpnConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada em MBPS. int
dpdTimeoutSeconds Tempo limite DPD em segundos para a ligação vpn. int
enableBgp Sinalizador EnableBgp. bool
enableInternetSecurity Ativar a segurança da Internet. bool
enableRateLimiting Sinalizador EnableBgp. bool
ipsecPolicies As Políticas IPSec a considerar por esta ligação. IpsecPolicy[]
remoteVpnSite ID do site de VPN ligado. Sub-origem
routingConfiguration A Configuração de Encaminhamento que indica as tabelas de rotas associadas e propagadas nesta ligação. RoutingConfiguration
routingWeight Peso do encaminhamento para a ligação vpn. int
sharedKey SharedKey para a ligação vpn. string
trafficSelectorPolicies As Políticas do Seletor de Tráfego a considerar por esta ligação. TrafficSelectorPolicy[]
useLocalAzureIpAddress Utilize o ip do azure local para iniciar a ligação. bool
usePolicyBasedTrafficSelectors Ativar seletores de tráfego baseados em políticas. bool
vpnConnectionProtocolType Protocolo de ligação utilizado para esta ligação. 'IKEv1'
'IKEv2'
vpnLinkConnections Lista de todas as ligações do site vpn ao gateway. VpnSiteLinkConnection[]

IpsecPolicy

Nome Descrição Valor
dhGroup O Grupo DH utilizado na Fase 1 do IKE para SA inicial. "DHGroup1"
"DHGroup14"
"DHGroup2"
"DHGroup2048"
"DHGroup24"
"ECP256"
"ECP384"
"Nenhum" (obrigatório)
ikeEncryption O algoritmo de encriptação IKE (fase IKE 2). "AES128"
"AES192"
"AES256"
"DES"
'DES3'
"GCMAES128"
"GCMAES256" (obrigatório)
Integridade do ike O algoritmo de integridade IKE (fase IKE 2). "GCMAES128"
"GCMAES256"
"MD5"
'SHA1'
'SHA256'
"SHA384" (obrigatório)
ipsecEncryption O algoritmo de encriptação IPSec (fase IKE 1). "AES128"
"AES192"
"AES256"
"DES"
'DES3'
"GCMAES128"
"GCMAES192"
"GCMAES256"
"Nenhum" (obrigatório)
Integridade do ipsec O algoritmo de integridade IPSec (fase IKE 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
'SHA1'
"SHA256" (obrigatório)
pfsGroup O Grupo Pfs utilizado na Fase 2 do IKE para a nova SA subordinada. "ECP256"
"ECP384"
"Nenhum"
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
"PFSMM" (obrigatório)
saDataSizeKilobytes O tamanho de payload da Associação de Segurança IPSec (também denominado Modo Rápido ou Fase 2 SA) em KB para um túnel de VPN site a site. int (obrigatório)
saLifeTimeSeconds A Duração da Associação de Segurança IPSec (também denominada Modo Rápido ou Fase 2 SA) em segundos para um túnel de VPN site a site. int (obrigatório)

Sub-origem

Nome Descrição Valor
ID ID do Recurso. string

RoutingConfiguration

Nome Descrição Valor
associatedRouteTable O id de recurso RouteTable associado a esta RoutingConfiguration. Sub-origem
inboundRouteMap O ID de recurso do RouteMap associado a esta RoutingConfiguration para rotas aprendidas de entrada. Sub-origem
outboundRouteMap O ID de recurso doRouteMap associado a esta RoutingConfiguration para rotas anunciadas de saída. Sub-origem
propagatedRouteTables A lista de RouteTables para anunciar as rotas. PropagatedRouteTable
vnetRoutes Lista de rotas que controlam o encaminhamento do VirtualHub para uma ligação de rede virtual. VnetRoute

PropagatedRouteTable

Nome Descrição Valor
IDs A lista de IDs de recursos de todos os RouteTables. SubResource[]
etiquetas A lista de etiquetas. cadeia[]

VnetRoute

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

StaticRoute

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

StaticRoutesConfig

Nome Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se a NVA na vnet spoke é ignorada para o tráfego com destino no spoke. "Contém"
'Igual'

TrafficSelectorPolicy

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

VpnSiteLinkConnection

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da ligação de ligação do site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada em MBPS. int
egressNatRules Lista de NatRules de saída. Subresource[]
enableBgp Sinalizador EnableBgp. bool
enableRateLimiting Sinalizador EnableBgp. bool
ingressNatRules Lista de NatRules de entrada. Subresource[]
ipsecPolicies As Políticas IPSec a considerar por esta ligação. IpsecPolicy[]
routingWeight Peso do encaminhamento para a ligação vpn. int
sharedKey SharedKey para a ligação vpn. string
useLocalAzureIpAddress Utilize o ip do azure local para iniciar a ligação. bool
usePolicyBasedTrafficSelectors Ativar seletores de tráfego baseados em políticas. bool
vpnConnectionProtocolType Protocolo de ligação utilizado para esta ligação. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses utilizados por esta ligação. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de ligação de ligação VPN. 'Predefinição'
"InitiatorOnly"
'ResponderOnly'
vpnSiteLink ID da ligação do site vpn ligado. Sub-origem

GatewayCustomBgpIpAddressIpConfiguration

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

VpnGatewayNatRule

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da regra NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nome Descrição Valor
externalMappings O mapeamento externo do endereço IP privado para NAT. VpnNatRuleMapping[]
internalMappings O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping[]
ipConfigurationId O ID de Configuração de IP a que esta regra NAT se aplica. string
mode A direção NAT de origem de um NAT de VPN. "EgressSnat"
"IngressSnat"
tipo O tipo de regra NAT para NAT de VPN. "Dinâmico"
"Estático"

VpnNatRuleMapping

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

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Descrição
Cria recursos WAN Virtual

Implementar no Azure
Este modelo permite-lhe criar recursos da WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway de VPN, Site VPN e um Conector de VPN.
Implementação de Vários Hubs do Azure WAN Virtual (vWAN)

Implementar no Azure
Este modelo permite-lhe criar uma implementação multi-hub do Azure WAN Virtual (vWAN), incluindo todos os gateways e ligações VNET.
Implementação de Vários Hubs do Azure vWAN com Tabelas de Encaminhamento Personalizadas

Implementar no Azure
Este modelo permite-lhe criar uma implementação multi-hub do Azure WAN Virtual (vWAN), incluindo todos os gateways e ligações VNET, e demonstrar a utilização de Tabelas de Rotas para encaminhamento personalizado.

Definição de recurso terraform (fornecedor AzAPI)

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

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2022-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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
    }
  })
}

Valores de propriedade

vpnGateways

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Network/vpnGateways@2022-09-01"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos, carateres de sublinhado, períodos e hífenes.

Comece com alfanumérico. Terminar alfanumérico ou caráter de sublinhado.
localização Localização do recurso. string
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas.
propriedades Propriedades do gateway de VPN. VpnGatewayProperties

VpnGatewayProperties

Nome Descrição Valor
bgpSettings Definições do altifalante BGP do gateway de rede local. BgpSettings
ligações Lista de todas as ligações vpn ao gateway. VpnConnection[]
enableBgpRouteTranslationForNat Ative a tradução de rotas BGP para NAT neste VpnGateway. bool
isRoutingPreferenceInternet Ative a propriedade Preferência de Encaminhamento para a Interface de IP Público do VpnGateway. bool
natRules Lista de todas as Regras nat associadas ao gateway. VpnGatewayNatRule[]
virtualHub O VirtualHub ao qual o gateway pertence. Sub-origem
vpnGatewayScaleUnit A unidade de escala para este gateway de vpn. int

BgpSettings

Nome Descrição Valor
asn O ASN do orador BGP. int
bgpPeeringAddress O endereço de peering BGP e o identificador BGP deste orador BGP. string
bgpPeeringAddresses Endereço de peering BGP com ID de configuração de IP para gateway de rede virtual. IPConfigurationBgpPeeringAddress[]
peerWeight O peso adicionado às rotas aprendidas com este altifalante BGP. int

IPConfigurationBgpPeeringAddress

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

VpnConnection

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da ligação VPN. VpnConnectionProperties

VpnConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada em MBPS. int
dpdTimeoutSeconds Tempo limite DPD em segundos para a ligação vpn. int
enableBgp Sinalizador EnableBgp. bool
enableInternetSecurity Ativar a segurança da Internet. bool
enableRateLimiting Sinalizador EnableBgp. bool
ipsecPolicies As Políticas IPSec a considerar por esta ligação. IpsecPolicy[]
remoteVpnSite ID do site de VPN ligado. Sub-origem
routingConfiguration A Configuração de Encaminhamento que indica as tabelas de rotas associadas e propagadas nesta ligação. RoutingConfiguration
routingWeight Peso do encaminhamento para a ligação vpn. int
sharedKey SharedKey para a ligação vpn. string
trafficSelectorPolicies As Políticas do Seletor de Tráfego a considerar por esta ligação. TrafficSelectorPolicy[]
useLocalAzureIpAddress Utilize o ip do azure local para iniciar a ligação. bool
usePolicyBasedTrafficSelectors Ativar seletores de tráfego baseados em políticas. bool
vpnConnectionProtocolType Protocolo de ligação utilizado para esta ligação. "IKEv1"
"IKEv2"
vpnLinkConnections Lista de todas as ligações de ligação do site vpn ao gateway. VpnSiteLinkConnection[]

IpsecPolicy

Nome Descrição Valor
dhGroup O Grupo DH utilizado na Fase 1 do IKE para SA inicial. "DHGroup1"
"DHGroup14"
"DHGroup2"
"DHGroup2048"
"DHGroup24"
"ECP256"
"ECP384"
"Nenhum" (obrigatório)
ikeEncryption O algoritmo de encriptação IKE (fase IKE 2). "AES128"
"AES192"
"AES256"
"DES"
"DES3"
"GCMAES128"
"GCMAES256" (obrigatório)
Integridade do ike O algoritmo de integridade IKE (fase IKE 2). "GCMAES128"
"GCMAES256"
"MD5"
"SHA1"
"SHA256"
"SHA384" (obrigatório)
ipsecEncryption O algoritmo de encriptação IPSec (fase IKE 1). "AES128"
"AES192"
"AES256"
"DES"
"DES3"
"GCMAES128"
"GCMAES192"
"GCMAES256"
"Nenhum" (obrigatório)
Integridade do ipsec O algoritmo de integridade IPSec (fase IKE 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
"SHA1"
"SHA256" (obrigatório)
pfsGroup O Grupo Pfs utilizado na Fase 2 do IKE para a nova SA subordinada. "ECP256"
"ECP384"
"Nenhum"
"PFS1"
"PFS14"
"PFS2"
"PFS2048"
"PFS24"
"PFSMM" (obrigatório)
saDataSizeKilobytes O tamanho de payload da Associação de Segurança IPSec (também denominado Modo Rápido ou Fase 2 SA) em KB para um túnel de VPN site a site. int (obrigatório)
saLifeTimeSeconds A Duração da Associação de Segurança IPSec (também denominada Modo Rápido ou Fase 2 SA) em segundos para um túnel de VPN site a site. int (obrigatório)

Sub-origem

Nome Descrição Valor
ID ID do Recurso. string

RoutingConfiguration

Nome Descrição Valor
associatedRouteTable O id de recurso RouteTable associado a esta RoutingConfiguration. Sub-origem
inboundRouteMap O ID de recurso do RouteMap associado a esta RoutingConfiguration para rotas aprendidas de entrada. Sub-origem
outboundRouteMap O ID de recurso doRouteMap associado a esta RoutingConfiguration para rotas anunciadas de saída. Sub-origem
propagatedRouteTables A lista de RouteTables para anunciar as rotas. PropagatedRouteTable
vnetRoutes Lista de rotas que controlam o encaminhamento do VirtualHub para uma ligação de rede virtual. VnetRoute

PropagatedRouteTable

Nome Descrição Valor
IDs A lista de IDs de recursos de todos os RouteTables. SubResource[]
etiquetas A lista de etiquetas. cadeia[]

VnetRoute

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

StaticRoute

Nome Descrição Valor
addressPrefixes Lista de todos os prefixos de endereço. cadeia[]
name O nome do StaticRoute que é exclusivo numa VnetRoute. string
nextHopIpAddress O endereço IP do próximo salto. string

StaticRoutesConfig

Nome Descrição Valor
vnetLocalRouteOverrideCriteria Parâmetro que determina se a NVA na vnet spoke é ignorada para o tráfego com o destino no spoke. "Contém"
"Igual"

TrafficSelectorPolicy

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

VpnSiteLinkConnection

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da ligação de ligação do site VPN. VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nome Descrição Valor
connectionBandwidth Largura de banda esperada no MBPS. int
egressNatRules Lista de NatRules de saída. SubResource[]
enableBgp Sinalizador EnableBgp. bool
enableRateLimiting Sinalizador EnableBgp. bool
ingressNatRules Lista de NatRules de entrada. SubResource[]
ipsecPolicies As Políticas IPSec a considerar por esta ligação. IpsecPolicy[]
routingWeight Peso do encaminhamento para a ligação vpn. int
sharedKey SharedKey para a ligação vpn. string
useLocalAzureIpAddress Utilize o ip do azure local para iniciar a ligação. bool
usePolicyBasedTrafficSelectors Ativar seletores de tráfego baseados em políticas. bool
vpnConnectionProtocolType Protocolo de ligação utilizado para esta ligação. "IKEv1"
"IKEv2"
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses utilizados por esta ligação. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Modo de ligação de ligação VPN. "Predefinição"
"InitiatorOnly"
"ResponderOnly"
vpnSiteLink ID da ligação do site vpn ligado. Sub-origem

GatewayCustomBgpIpAddressIpConfiguration

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

VpnGatewayNatRule

Nome Descrição Valor
ID ID do Recurso. string
name O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. string
propriedades Propriedades da regra NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nome Descrição Valor
externalMappings O mapeamento externo do endereço IP privado para NAT. VpnNatRuleMapping[]
internalMappings O mapeamento interno do endereço IP privado para NAT. VpnNatRuleMapping[]
ipConfigurationId O ID de Configuração de IP a que esta regra NAT se aplica. string
mode A direção NAT de origem de um NAT de VPN. "EgressSnat"
"IngressSnat"
tipo O tipo de regra NAT para NAT de VPN. "Dinâmico"
"Estático"

VpnNatRuleMapping

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