Microsoft.Network vpnGateways 2022-07-01

Artigo
05/07/2024

Definição de recurso do Bicep

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

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

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

resource symbolicname 'Microsoft.Network/vpnGateways@2022-07-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 de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos, sublinhados, pontos e hifens. Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local	Local do recurso.	string
marcas	Marcas de recurso.	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties	Propriedades do gateway de VPN.	VpnGatewayProperties

VpnGatewayProperties

Nome	Descrição	Valor
bgpSettings	Configurações do alto-falante BGP do gateway de rede local.	BgpSettings
connections	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.	SubResource
vpnGatewayScaleUnit	A unidade de escala para esse gateway de VPN.	INT

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.	string
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

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.	string

VpnConnection

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	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 vpn conectado.	SubResource
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.	string
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[]

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 (fase 1 do IKE).	'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 chamada de Modo Rápido ou SA da Fase 2) em KB para um túnel VPN site a site.	int (obrigatório)
saLifeTimeSeconds	O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA da Fase 2) em segundos para um túnel VPN site a site.	int (obrigatório)

SubResource

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

Routingconfiguration

Nome	Descrição	Valor
associatedRouteTable	A ID do recurso RouteTable associada a esse RoutingConfiguration.	SubResource
inboundRouteMap	A ID do recurso do RouteMap associado a esse RoutingConfiguration para rotas aprendidas de entrada.	SubResource
outboundRouteMap	A ID do recurso doRouteMap associado a esse RoutingConfiguration para rotas anunciadas de saída.	SubResource
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.	VnetRoute

PropagatedRouteTable

Nome	Descrição	Valor
ids	A lista de IDs de recursos de todas as RouteTables.	SubResource[]
rótulos	A lista de rótulos.	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 que é exclusivo em um 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 tráfego com destino no spoke.	'Contains' 'Equal'

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)

VpnSiteLinkConnection

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	Propriedades da conexão de link 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 serem consideradas por essa conexão.	IpsecPolicy[]
routingWeight	Peso de roteamento para conexão vpn.	INT
sharedKey	SharedKey para a conexão vpn.	string
useLocalAzureIpAddress	Use o ip local do azure 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 usado 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.	SubResource

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)

VpnGatewayNatRule

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	Propriedades da regra NAT do 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	A ID de configuração de IP à qual essa regra NAT se aplica.	string
mode	A direção nat de origem de um NAT vpn.	'EgressSnat' 'IngressSnat'
tipo	O tipo de regra NAT para VPN NAT.	'Dinâmico' 'Static'

VpnNatRuleMapping

Nome	Descrição	Valor
addressSpace	Espaço de endereço 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 modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	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 VPN e um Vpn Connecton.
Políticas e intenção de roteamento de WAN Virtual do Azure	Esse modelo provisiona um WAN Virtual do Azure com dois hubs com o recurso Detenção e Políticas de Roteamento habilitado.
Implantação multi-Hub do Azure WAN Virtual (vWAN)	Esse modelo permite que você crie uma implantação de vários hubs do Azure WAN Virtual (vWAN), incluindo todos os gateways e conexões VNET.
Implantação de vários hubs vWAN do Azure com tabelas de roteamento personalizadas	Esse modelo permite que você crie uma implantação de vários hubs do Azure WAN Virtual (vWAN), incluindo todos os gateways e conexões VNET, e demonstre o uso de Tabelas de Rotas para roteamento personalizado.

Definição de recurso de modelo do ARM

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

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

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

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2022-07-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 do recurso	'2022-07-01'
name	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos, sublinhados, pontos e hifens. Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local	Local do recurso.	string
marcas	Marcas de recurso.	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties	Propriedades do gateway de VPN.	VpnGatewayProperties

VpnGatewayProperties

Nome	Descrição	Valor
bgpSettings	Configurações do alto-falante BGP do gateway de rede local.	BgpSettings
connections	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.	SubResource
vpnGatewayScaleUnit	A unidade de escala para esse gateway de VPN.	INT

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.	string
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

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.	string

VpnConnection

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	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 vpn conectado.	SubResource
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.	string
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[]

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 (fase 1 do IKE).	'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 chamada de Modo Rápido ou SA da Fase 2) em KB para um túnel VPN site a site.	int (obrigatório)
saLifeTimeSeconds	O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA da Fase 2) em segundos para um túnel VPN site a site.	int (obrigatório)

SubResource

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

Routingconfiguration

Nome	Descrição	Valor
associatedRouteTable	A ID do recurso RouteTable associada a esse RoutingConfiguration.	SubResource
inboundRouteMap	A ID do recurso do RouteMap associado a esse RoutingConfiguration para rotas aprendidas de entrada.	SubResource
outboundRouteMap	A ID do recurso doRouteMap associado a esse RoutingConfiguration para rotas anunciadas de saída.	SubResource
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.	VnetRoute

PropagatedRouteTable

Nome	Descrição	Valor
ids	A lista de IDs de recursos de todas as RouteTables.	SubResource[]
rótulos	A lista de rótulos.	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 que é exclusivo em um 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 tráfego com destino no spoke.	'Contains' 'Equal'

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)

VpnSiteLinkConnection

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	Propriedades da conexão de link 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 serem consideradas por essa conexão.	IpsecPolicy[]
routingWeight	Peso de roteamento para conexão vpn.	INT
sharedKey	SharedKey para a conexão vpn.	string
useLocalAzureIpAddress	Use o ip local do azure 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 usado 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.	SubResource

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)

VpnGatewayNatRule

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	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.	string
mode	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'

VpnNatRuleMapping

Nome	Descrição	Valor
addressSpace	Espaço de endereço 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 modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	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 VPN e um Vpn Connecton.
Intenção e políticas de roteamento de WAN Virtual do Azure	Esse modelo provisiona um WAN Virtual do Azure com dois hubs com o recurso Detenção e Políticas de Roteamento habilitado.
Implantação multi-Hub do Azure WAN Virtual (vWAN)	Esse modelo permite que você crie uma implantação de vários hubs do Azure WAN Virtual (vWAN), incluindo todos os gateways e conexões VNET.
Implantação de vários hubs vWAN do Azure com tabelas de roteamento personalizadas	Esse modelo permite que você crie uma implantação de vários hubs do Azure WAN Virtual (vWAN), incluindo todos os gateways e conexões VNET, e demonstre o uso de Tabelas de Rota para roteamento personalizado.

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

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

Grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2022-07-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-07-01"
name	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos, sublinhados, pontos e hifens. Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local	Local do recurso.	string
parent_id	Para implantar em um grupo de recursos, use a ID desse grupo de recursos.	cadeia de caracteres (obrigatório)
marcas	Marcas de recurso.	Dicionário de nomes e valores de marcas.
properties	Propriedades do gateway de VPN.	VpnGatewayProperties

VpnGatewayProperties

Nome	Descrição	Valor
bgpSettings	Configurações do alto-falante BGP do gateway de rede local.	BgpSettings
connections	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.	SubResource
vpnGatewayScaleUnit	A unidade de escala para esse gateway de VPN.	INT

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.	string
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

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.	string

VpnConnection

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	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 vpn conectado.	SubResource
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.	string
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[]

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 (fase 1 do IKE).	"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 do conteúdo 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	O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA fase 2) em segundos para um túnel VPN site a site.	int (obrigatório)

SubResource

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

Routingconfiguration

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

PropagatedRouteTable

Nome	Descrição	Valor
ids	A lista de IDs de recurso de todas as RouteTables.	SubResource[]
rótulos	A lista de rótulos.	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 em um 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.	"Contains" "Igual"

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 remotos no formato CIDR.	string[] (obrigatório)

VpnSiteLinkConnection

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	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.	SubResource[]
enableBgp	Sinalizador EnableBgp.	bool
enableRateLimiting	Sinalizador EnableBgp.	bool
ingressNatRules	Lista de NatRules de entrada.	SubResource[]
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.	string
useLocalAzureIpAddress	Use o ip local do azure 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 usado 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.	SubResource

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)

VpnGatewayNatRule

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	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.	string
mode	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"

VpnNatRuleMapping

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

Share via

Microsoft.Network vpnGateways 2022-07-01

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

vpnGateways

VpnGatewayProperties

BgpSettings

IPConfigurationBgpPeeringAddress

VpnConnection

VpnConnectionProperties

IpsecPolicy

SubResource

Routingconfiguration

PropagatedRouteTable

VnetRoute

StaticRoute

StaticRoutesConfig

TrafficSelectorPolicy

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

GatewayCustomBgpIpAddressIpConfiguration

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnNatRuleMapping

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

vpnGateways

VpnGatewayProperties

BgpSettings

IPConfigurationBgpPeeringAddress

VpnConnection

VpnConnectionProperties

IpsecPolicy

SubResource

Routingconfiguration

PropagatedRouteTable

VnetRoute

StaticRoute

StaticRoutesConfig

TrafficSelectorPolicy

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

GatewayCustomBgpIpAddressIpConfiguration

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnNatRuleMapping

Modelos de início rápido

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

Formato de recurso

Valores de propriedade

vpnGateways

VpnGatewayProperties

BgpSettings

IPConfigurationBgpPeeringAddress

VpnConnection

VpnConnectionProperties

IpsecPolicy

SubResource

Routingconfiguration

PropagatedRouteTable

VnetRoute

StaticRoute

StaticRoutesConfig

TrafficSelectorPolicy

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

GatewayCustomBgpIpAddressIpConfiguration

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnNatRuleMapping

Comentários

Comentários

Recursos adicionais