Partager via

Microsoft.Network vpnGateways 2023-05-01

  • Article

Définition de ressource Bicep

Le type de ressource vpnGateways peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Network/vpnGateways, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

BgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. corde
bgpPeeringAddresses Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP. Int

GatewayCustomBgpIpAddressIpConfiguration

Nom Description Valeur
customBgpIpAddress BgpPeeringAddress personnalisé qui appartient à IpconfigurationId. chaîne (obligatoire)
ipConfigurationId IpconfigurationId de ipconfiguration qui appartient à la passerelle. chaîne (obligatoire)

IPConfigurationBgpPeeringAddress

Nom Description Valeur
customBgpIpAddresses Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP. string[]
ipconfigurationId ID de la configuration IP qui appartient à la passerelle. corde

IpsecPolicy

Nom Description Valeur
dhGroup Groupe DH utilisé dans la phase 1 de IKE pour la sa initiale. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
'ECP256'
'ECP384'
'None' (obligatoire)
ikeEncryption Algorithme de chiffrement IKE (phase IKE 2). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES256' (obligatoire)
ikeIntegrity Algorithme d’intégrité IKE (phase IKE 2). 'GCMAES128'
'GCMAES256'
'MD5'
'SHA1'
'SHA256'
'SHA384' (obligatoire)
ipsecEncryption Algorithme de chiffrement IPSec (phase IKE 1). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES192'
'GCMAES256'
'None' (obligatoire)
ipsecIntegrity Algorithme d’intégrité IPSec (phase IKE 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
'MD5'
'SHA1'
'SHA256' (obligatoire)
pfsGroup Groupe Pfs utilisé dans la phase IKE 2 pour la nouvelle SAP enfant. 'ECP256'
'ECP384'
'None'
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
'PFSMM' (obligatoire)
saDataSizeKilobytes La taille de charge utile IPSec Security Association (également appelée mode rapide ou sa phase 2) en Ko pour un tunnel VPN de site à site. int (obligatoire)
saLifeTimeSeconds Durée de vie de l’association de sécurité IPSec (également appelée mode rapide ou sa phase 2) en secondes pour un tunnel VPN de site à site. int (obligatoire)

Microsoft.Network/vpnGateways

Nom Description Valeur
emplacement Emplacement des ressources. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de la passerelle VPN. VpnGatewayProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

PropagatedRouteTable

Nom Description Valeur
Id Liste des ID de ressource de tous les RouteTables. SubResource[]
Étiquettes Liste des étiquettes. string[]

ResourceTags

Nom Description Valeur

RoutingConfiguration

Nom Description Valeur
associatedRouteTable Id de ressource RouteTable associé à ce RoutingConfiguration. SubResource
inboundRouteMap ID de ressource de RouteMap associé à ce RoutingConfiguration pour les itinéraires appris entrants. SubResource
outboundRouteMap ID de ressource de l’ObjetRouteMap associé à ce RoutingConfiguration pour les itinéraires publiés sortants. SubResource
propagatedRouteTables Liste des RoutesTables pour publier les itinéraires vers. PropagéeRouteTable
vnetRoutes Liste des itinéraires qui contrôlent le routage à partir de VirtualHub vers une connexion de réseau virtuel. de réseau virtuel

StaticRoute

Nom Description Valeur
addressPrefixes Liste de tous les préfixes d’adresse. string[]
nom Nom de StaticRoute unique au sein d’un réseau virtuel. corde
nextHopIpAddress Adresse IP du tronçon suivant. corde

StaticRoutesConfig

Nom Description Valeur
vnetLocalRouteOverrideCriteria Paramètre déterminant si l’appliance virtuelle réseau dans le réseau virtuel spoke est contournée pour le trafic avec la destination en spoke. 'Contains'
'Égal'

Sous-ressource

Nom Description Valeur
id ID de ressource. corde

TrafficSelectorPolicy

Nom Description Valeur
localAddressRanges Collection d’espaces d’adressage locaux au format CIDR. string[] (obligatoire)
remoteAddressRanges Collection d’espaces d’adressage distants au format CIDR. string[] (obligatoire)

VnetRoute

Nom Description Valeur
staticRoutes Liste de tous les itinéraires statiques. staticRoute[]
staticRoutesConfig Configuration des itinéraires statiques sur ce HubVnetConnection. StaticRoutesConfig

VpnConnection

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la connexion VPN. vpnConnectionProperties

VpnConnectionProperties

Nom Description Valeur
connectionBandwidth Bande passante attendue en MBITs/S. Int
dpdTimeoutSeconds Délai DPD en secondes pour la connexion VPN. Int
enableBgp Indicateur EnableBgp. Bool
enableInternetSecurity Activer la sécurité Internet. Bool
enableRateLimiting Indicateur EnableBgp. Bool
ipsecPolicies Stratégies IPSec à prendre en compte par cette connexion. IpsecPolicy []
remoteVpnSite ID du site vpn connecté. SubResource
routingConfiguration Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion. routingConfiguration
routingWeight Poids du routage pour la connexion VPN. Int
sharedKey SharedKey pour la connexion vpn. corde
trafficSelectorPolicies Stratégies de sélecteur de trafic à prendre en compte par cette connexion. TrafficSelectorPolicy[]
useLocalAzureIpAddress Utilisez l’adresse IP Azure locale pour lancer la connexion. Bool
usePolicyBasedTrafficSelectors Activez les sélecteurs de trafic basés sur des stratégies. Bool
vpnConnectionProtocolType Protocole de connexion utilisé pour cette connexion. 'IKEv1'
'IKEv2'
vpnLinkConnections Liste de toutes les connexions de site vpn à la passerelle. VpnSiteLinkConnection[]

VpnGatewayNatRule

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la règle NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nom Description Valeur
externalMappings Mappage externe d’adresse IP privée pour NAT. VpnNatRuleMapping[]
internalMappings Mappage interne d’adresse IP privée pour NAT. VpnNatRuleMapping[]
ipConfigurationId L’ID de configuration IP à cette règle NAT s’applique. corde
mode Direction NAT source d’un NAT VPN. 'EgressSnat'
'IngressSnat'
type Type de règle NAT pour VPN NAT. 'Dynamique'
'Static'

VpnGatewayProperties

Nom Description Valeur
bgpSettings Paramètres de l’orateur BGP de la passerelle de réseau local. BgpSettings
Connexions Liste de toutes les connexions VPN à la passerelle. vpnConnection[]
enableBgpRouteTranslationForNat Activez la traduction d’itinéraires BGP pour NAT sur ce VpnGateway. Bool
isRoutingPreferenceInternet Activez la propriété Préférence de routage pour l’interface IP publique du VpnGateway. Bool
natRules Liste de toutes les règles nat associées à la passerelle. VpnGatewayNatRule[]
virtualHub VirtualHub auquel appartient la passerelle. SubResource
vpnGatewayScaleUnit Unité d’échelle pour cette passerelle vpn. Int

VpnNatRuleMapping

Nom Description Valeur
addressSpace Espace d’adressage pour le mappage NatRule vpn. corde
portRange Plage de ports pour le mappage NatRule vpn. corde

VpnSiteLinkConnection

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la connexion de lien de site VPN. vpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nom Description Valeur
connectionBandwidth Bande passante attendue en MBITs/S. Int
sortieNatRules Liste des natRules de sortie. SubResource[]
enableBgp Indicateur EnableBgp. Bool
enableRateLimiting Indicateur EnableBgp. Bool
ingressNatRules Liste des natRules d’entrée. SubResource[]
ipsecPolicies Stratégies IPSec à prendre en compte par cette connexion. IpsecPolicy []
routingWeight Poids du routage pour la connexion VPN. Int
sharedKey SharedKey pour la connexion vpn. corde
useLocalAzureIpAddress Utilisez l’adresse IP Azure locale pour lancer la connexion. Bool
usePolicyBasedTrafficSelectors Activez les sélecteurs de trafic basés sur des stratégies. Bool
vpnConnectionProtocolType Protocole de connexion utilisé pour cette connexion. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses utilisé par cette connexion. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Mode de connexion de liaison VPN. 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink ID du lien de site vpn connecté. SubResource

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
crée des ressources Virtual WAN Ce modèle vous permet de créer des ressources virtual WAN, notamment Virtual WAN, Virtual Hub, passerelle VPN, site VPN et connexion VPN.

Définition de ressource de modèle ARM

Le type de ressource vpnGateways peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Network/vpnGateways, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

BgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. corde
bgpPeeringAddresses Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP. Int

GatewayCustomBgpIpAddressIpConfiguration

Nom Description Valeur
customBgpIpAddress BgpPeeringAddress personnalisé qui appartient à IpconfigurationId. chaîne (obligatoire)
ipConfigurationId IpconfigurationId de ipconfiguration qui appartient à la passerelle. chaîne (obligatoire)

IPConfigurationBgpPeeringAddress

Nom Description Valeur
customBgpIpAddresses Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP. string[]
ipconfigurationId ID de la configuration IP qui appartient à la passerelle. corde

IpsecPolicy

Nom Description Valeur
dhGroup Groupe DH utilisé dans la phase 1 de IKE pour la sa initiale. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
'ECP256'
'ECP384'
'None' (obligatoire)
ikeEncryption Algorithme de chiffrement IKE (phase IKE 2). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES256' (obligatoire)
ikeIntegrity Algorithme d’intégrité IKE (phase IKE 2). 'GCMAES128'
'GCMAES256'
'MD5'
'SHA1'
'SHA256'
'SHA384' (obligatoire)
ipsecEncryption Algorithme de chiffrement IPSec (phase IKE 1). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES192'
'GCMAES256'
'None' (obligatoire)
ipsecIntegrity Algorithme d’intégrité IPSec (phase IKE 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
'MD5'
'SHA1'
'SHA256' (obligatoire)
pfsGroup Groupe Pfs utilisé dans la phase IKE 2 pour la nouvelle SAP enfant. 'ECP256'
'ECP384'
'None'
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
'PFSMM' (obligatoire)
saDataSizeKilobytes La taille de charge utile IPSec Security Association (également appelée mode rapide ou sa phase 2) en Ko pour un tunnel VPN de site à site. int (obligatoire)
saLifeTimeSeconds Durée de vie de l’association de sécurité IPSec (également appelée mode rapide ou sa phase 2) en secondes pour un tunnel VPN de site à site. int (obligatoire)

Microsoft.Network/vpnGateways

Nom Description Valeur
apiVersion Version de l’API '2023-05-01'
emplacement Emplacement des ressources. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de la passerelle VPN. VpnGatewayProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Network/vpnGateways'

PropagatedRouteTable

Nom Description Valeur
Id Liste des ID de ressource de tous les RouteTables. SubResource[]
Étiquettes Liste des étiquettes. string[]

ResourceTags

Nom Description Valeur

RoutingConfiguration

Nom Description Valeur
associatedRouteTable Id de ressource RouteTable associé à ce RoutingConfiguration. SubResource
inboundRouteMap ID de ressource de RouteMap associé à ce RoutingConfiguration pour les itinéraires appris entrants. SubResource
outboundRouteMap ID de ressource de l’ObjetRouteMap associé à ce RoutingConfiguration pour les itinéraires publiés sortants. SubResource
propagatedRouteTables Liste des RoutesTables pour publier les itinéraires vers. PropagéeRouteTable
vnetRoutes Liste des itinéraires qui contrôlent le routage à partir de VirtualHub vers une connexion de réseau virtuel. de réseau virtuel

StaticRoute

Nom Description Valeur
addressPrefixes Liste de tous les préfixes d’adresse. string[]
nom Nom de StaticRoute unique au sein d’un réseau virtuel. corde
nextHopIpAddress Adresse IP du tronçon suivant. corde

StaticRoutesConfig

Nom Description Valeur
vnetLocalRouteOverrideCriteria Paramètre déterminant si l’appliance virtuelle réseau dans le réseau virtuel spoke est contournée pour le trafic avec la destination en spoke. 'Contains'
'Égal'

Sous-ressource

Nom Description Valeur
id ID de ressource. corde

TrafficSelectorPolicy

Nom Description Valeur
localAddressRanges Collection d’espaces d’adressage locaux au format CIDR. string[] (obligatoire)
remoteAddressRanges Collection d’espaces d’adressage distants au format CIDR. string[] (obligatoire)

VnetRoute

Nom Description Valeur
staticRoutes Liste de tous les itinéraires statiques. staticRoute[]
staticRoutesConfig Configuration des itinéraires statiques sur ce HubVnetConnection. StaticRoutesConfig

VpnConnection

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la connexion VPN. vpnConnectionProperties

VpnConnectionProperties

Nom Description Valeur
connectionBandwidth Bande passante attendue en MBITs/S. Int
dpdTimeoutSeconds Délai DPD en secondes pour la connexion VPN. Int
enableBgp Indicateur EnableBgp. Bool
enableInternetSecurity Activer la sécurité Internet. Bool
enableRateLimiting Indicateur EnableBgp. Bool
ipsecPolicies Stratégies IPSec à prendre en compte par cette connexion. IpsecPolicy []
remoteVpnSite ID du site vpn connecté. SubResource
routingConfiguration Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion. routingConfiguration
routingWeight Poids du routage pour la connexion VPN. Int
sharedKey SharedKey pour la connexion vpn. corde
trafficSelectorPolicies Stratégies de sélecteur de trafic à prendre en compte par cette connexion. TrafficSelectorPolicy[]
useLocalAzureIpAddress Utilisez l’adresse IP Azure locale pour lancer la connexion. Bool
usePolicyBasedTrafficSelectors Activez les sélecteurs de trafic basés sur des stratégies. Bool
vpnConnectionProtocolType Protocole de connexion utilisé pour cette connexion. 'IKEv1'
'IKEv2'
vpnLinkConnections Liste de toutes les connexions de site vpn à la passerelle. VpnSiteLinkConnection[]

VpnGatewayNatRule

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la règle NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nom Description Valeur
externalMappings Mappage externe d’adresse IP privée pour NAT. VpnNatRuleMapping[]
internalMappings Mappage interne d’adresse IP privée pour NAT. VpnNatRuleMapping[]
ipConfigurationId L’ID de configuration IP à cette règle NAT s’applique. corde
mode Direction NAT source d’un NAT VPN. 'EgressSnat'
'IngressSnat'
type Type de règle NAT pour VPN NAT. 'Dynamique'
'Static'

VpnGatewayProperties

Nom Description Valeur
bgpSettings Paramètres de l’orateur BGP de la passerelle de réseau local. BgpSettings
Connexions Liste de toutes les connexions VPN à la passerelle. vpnConnection[]
enableBgpRouteTranslationForNat Activez la traduction d’itinéraires BGP pour NAT sur ce VpnGateway. Bool
isRoutingPreferenceInternet Activez la propriété Préférence de routage pour l’interface IP publique du VpnGateway. Bool
natRules Liste de toutes les règles nat associées à la passerelle. VpnGatewayNatRule[]
virtualHub VirtualHub auquel appartient la passerelle. SubResource
vpnGatewayScaleUnit Unité d’échelle pour cette passerelle vpn. Int

VpnNatRuleMapping

Nom Description Valeur
addressSpace Espace d’adressage pour le mappage NatRule vpn. corde
portRange Plage de ports pour le mappage NatRule vpn. corde

VpnSiteLinkConnection

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la connexion de lien de site VPN. vpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nom Description Valeur
connectionBandwidth Bande passante attendue en MBITs/S. Int
sortieNatRules Liste des natRules de sortie. SubResource[]
enableBgp Indicateur EnableBgp. Bool
enableRateLimiting Indicateur EnableBgp. Bool
ingressNatRules Liste des natRules d’entrée. SubResource[]
ipsecPolicies Stratégies IPSec à prendre en compte par cette connexion. IpsecPolicy []
routingWeight Poids du routage pour la connexion VPN. Int
sharedKey SharedKey pour la connexion vpn. corde
useLocalAzureIpAddress Utilisez l’adresse IP Azure locale pour lancer la connexion. Bool
usePolicyBasedTrafficSelectors Activez les sélecteurs de trafic basés sur des stratégies. Bool
vpnConnectionProtocolType Protocole de connexion utilisé pour cette connexion. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses utilisé par cette connexion. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Mode de connexion de liaison VPN. 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink ID du lien de site vpn connecté. SubResource

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
déploiement multi-hub Azure Virtual WAN (vWAN)

Déployer sur Azure 		Ce modèle vous permet de créer un déploiement multi-hub Azure Virtual WAN (vWAN), y compris toutes les passerelles et connexions de réseau virtuel.
déploiement multi-hub Azure vWAN avec des tables de routage personnalisées

Déployer sur Azure 		Ce modèle vous permet de créer un déploiement multi-hub Azure Virtual WAN (vWAN), y compris toutes les passerelles et connexions de réseau virtuel, et d’illustrer l’utilisation des tables de routage pour le routage personnalisé.
crée des ressources Virtual WAN

Déployer sur Azure 		Ce modèle vous permet de créer des ressources virtual WAN, notamment Virtual WAN, Virtual Hub, passerelle VPN, site VPN et connexion VPN.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource vpnGateways peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Network/vpnGateways, ajoutez le terraform suivant à votre modèle.

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

Valeurs de propriété

BgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. corde
bgpPeeringAddresses Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP. Int

GatewayCustomBgpIpAddressIpConfiguration

Nom Description Valeur
customBgpIpAddress BgpPeeringAddress personnalisé qui appartient à IpconfigurationId. chaîne (obligatoire)
ipConfigurationId IpconfigurationId de ipconfiguration qui appartient à la passerelle. chaîne (obligatoire)

IPConfigurationBgpPeeringAddress

Nom Description Valeur
customBgpIpAddresses Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP. string[]
ipconfigurationId ID de la configuration IP qui appartient à la passerelle. corde

IpsecPolicy

Nom Description Valeur
dhGroup Groupe DH utilisé dans la phase 1 de IKE pour la sa initiale. 'DHGroup1'
'DHGroup14'
'DHGroup2'
'DHGroup2048'
'DHGroup24'
'ECP256'
'ECP384'
'None' (obligatoire)
ikeEncryption Algorithme de chiffrement IKE (phase IKE 2). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES256' (obligatoire)
ikeIntegrity Algorithme d’intégrité IKE (phase IKE 2). 'GCMAES128'
'GCMAES256'
'MD5'
'SHA1'
'SHA256'
'SHA384' (obligatoire)
ipsecEncryption Algorithme de chiffrement IPSec (phase IKE 1). 'AES128'
'AES192'
'AES256'
'DES'
'DES3'
'GCMAES128'
'GCMAES192'
'GCMAES256'
'None' (obligatoire)
ipsecIntegrity Algorithme d’intégrité IPSec (phase IKE 1). 'GCMAES128'
'GCMAES192'
'GCMAES256'
'MD5'
'SHA1'
'SHA256' (obligatoire)
pfsGroup Groupe Pfs utilisé dans la phase IKE 2 pour la nouvelle SAP enfant. 'ECP256'
'ECP384'
'None'
'PFS1'
'PFS14'
'PFS2'
'PFS2048'
'PFS24'
'PFSMM' (obligatoire)
saDataSizeKilobytes La taille de charge utile IPSec Security Association (également appelée mode rapide ou sa phase 2) en Ko pour un tunnel VPN de site à site. int (obligatoire)
saLifeTimeSeconds Durée de vie de l’association de sécurité IPSec (également appelée mode rapide ou sa phase 2) en secondes pour un tunnel VPN de site à site. int (obligatoire)

Microsoft.Network/vpnGateways

Nom Description Valeur
emplacement Emplacement des ressources. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de la passerelle VPN. VpnGatewayProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Network/vpnGateways@2023-05-01 »

PropagatedRouteTable

Nom Description Valeur
Id Liste des ID de ressource de tous les RouteTables. SubResource[]
Étiquettes Liste des étiquettes. string[]

ResourceTags

Nom Description Valeur

RoutingConfiguration

Nom Description Valeur
associatedRouteTable Id de ressource RouteTable associé à ce RoutingConfiguration. SubResource
inboundRouteMap ID de ressource de RouteMap associé à ce RoutingConfiguration pour les itinéraires appris entrants. SubResource
outboundRouteMap ID de ressource de l’ObjetRouteMap associé à ce RoutingConfiguration pour les itinéraires publiés sortants. SubResource
propagatedRouteTables Liste des RoutesTables pour publier les itinéraires vers. PropagéeRouteTable
vnetRoutes Liste des itinéraires qui contrôlent le routage à partir de VirtualHub vers une connexion de réseau virtuel. de réseau virtuel

StaticRoute

Nom Description Valeur
addressPrefixes Liste de tous les préfixes d’adresse. string[]
nom Nom de StaticRoute unique au sein d’un réseau virtuel. corde
nextHopIpAddress Adresse IP du tronçon suivant. corde

StaticRoutesConfig

Nom Description Valeur
vnetLocalRouteOverrideCriteria Paramètre déterminant si l’appliance virtuelle réseau dans le réseau virtuel spoke est contournée pour le trafic avec la destination en spoke. 'Contains'
'Égal'

Sous-ressource

Nom Description Valeur
id ID de ressource. corde

TrafficSelectorPolicy

Nom Description Valeur
localAddressRanges Collection d’espaces d’adressage locaux au format CIDR. string[] (obligatoire)
remoteAddressRanges Collection d’espaces d’adressage distants au format CIDR. string[] (obligatoire)

VnetRoute

Nom Description Valeur
staticRoutes Liste de tous les itinéraires statiques. staticRoute[]
staticRoutesConfig Configuration des itinéraires statiques sur ce HubVnetConnection. StaticRoutesConfig

VpnConnection

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la connexion VPN. vpnConnectionProperties

VpnConnectionProperties

Nom Description Valeur
connectionBandwidth Bande passante attendue en MBITs/S. Int
dpdTimeoutSeconds Délai DPD en secondes pour la connexion VPN. Int
enableBgp Indicateur EnableBgp. Bool
enableInternetSecurity Activer la sécurité Internet. Bool
enableRateLimiting Indicateur EnableBgp. Bool
ipsecPolicies Stratégies IPSec à prendre en compte par cette connexion. IpsecPolicy []
remoteVpnSite ID du site vpn connecté. SubResource
routingConfiguration Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion. routingConfiguration
routingWeight Poids du routage pour la connexion VPN. Int
sharedKey SharedKey pour la connexion vpn. corde
trafficSelectorPolicies Stratégies de sélecteur de trafic à prendre en compte par cette connexion. TrafficSelectorPolicy[]
useLocalAzureIpAddress Utilisez l’adresse IP Azure locale pour lancer la connexion. Bool
usePolicyBasedTrafficSelectors Activez les sélecteurs de trafic basés sur des stratégies. Bool
vpnConnectionProtocolType Protocole de connexion utilisé pour cette connexion. 'IKEv1'
'IKEv2'
vpnLinkConnections Liste de toutes les connexions de site vpn à la passerelle. VpnSiteLinkConnection[]

VpnGatewayNatRule

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la règle NAT VpnGateway. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Nom Description Valeur
externalMappings Mappage externe d’adresse IP privée pour NAT. VpnNatRuleMapping[]
internalMappings Mappage interne d’adresse IP privée pour NAT. VpnNatRuleMapping[]
ipConfigurationId L’ID de configuration IP à cette règle NAT s’applique. corde
mode Direction NAT source d’un NAT VPN. 'EgressSnat'
'IngressSnat'
type Type de règle NAT pour VPN NAT. 'Dynamique'
'Static'

VpnGatewayProperties

Nom Description Valeur
bgpSettings Paramètres de l’orateur BGP de la passerelle de réseau local. BgpSettings
Connexions Liste de toutes les connexions VPN à la passerelle. vpnConnection[]
enableBgpRouteTranslationForNat Activez la traduction d’itinéraires BGP pour NAT sur ce VpnGateway. Bool
isRoutingPreferenceInternet Activez la propriété Préférence de routage pour l’interface IP publique du VpnGateway. Bool
natRules Liste de toutes les règles nat associées à la passerelle. VpnGatewayNatRule[]
virtualHub VirtualHub auquel appartient la passerelle. SubResource
vpnGatewayScaleUnit Unité d’échelle pour cette passerelle vpn. Int

VpnNatRuleMapping

Nom Description Valeur
addressSpace Espace d’adressage pour le mappage NatRule vpn. corde
portRange Plage de ports pour le mappage NatRule vpn. corde

VpnSiteLinkConnection

Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés Propriétés de la connexion de lien de site VPN. vpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Nom Description Valeur
connectionBandwidth Bande passante attendue en MBITs/S. Int
sortieNatRules Liste des natRules de sortie. SubResource[]
enableBgp Indicateur EnableBgp. Bool
enableRateLimiting Indicateur EnableBgp. Bool
ingressNatRules Liste des natRules d’entrée. SubResource[]
ipsecPolicies Stratégies IPSec à prendre en compte par cette connexion. IpsecPolicy []
routingWeight Poids du routage pour la connexion VPN. Int
sharedKey SharedKey pour la connexion vpn. corde
useLocalAzureIpAddress Utilisez l’adresse IP Azure locale pour lancer la connexion. Bool
usePolicyBasedTrafficSelectors Activez les sélecteurs de trafic basés sur des stratégies. Bool
vpnConnectionProtocolType Protocole de connexion utilisé pour cette connexion. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses utilisé par cette connexion. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Mode de connexion de liaison VPN. 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink ID du lien de site vpn connecté. SubResource