Microsoft.Network vpnGateways 2023-06-01

• dernière
• 2024-07-01
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01

Définition de ressource Bicep

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

• groupes de ressources - Consultez commandes de déploiement de 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 bicep suivant à votre modèle.

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

Valeurs de propriété

Microsoft.Network/vpnGateways

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

BgpSettings

Nom	Descriptif	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	Descriptif	Valeur
customBgpIpAddress	BgpPeeringAddress personnalisé qui appartient à IpconfigurationId.	chaîne (obligatoire)
ipConfigurationId	IpconfigurationId de ipconfiguration qui appartient à la passerelle.	chaîne (obligatoire)

IPConfigurationBgpPeeringAddress

Nom	Descriptif	Valeur
customBgpIpAddresses	Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP.	chaîne de caractères[]
ipconfigurationId	ID de la configuration IP qui appartient à la passerelle.	corde

IpsecPolicy

Nom	Descriptif	Valeur
dhGroup	Groupe DH utilisé dans la phase 1 de IKE pour la sa initiale.	'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' « ECP256 » « ECP384 » 'None' (obligatoire)
ikeCryptage	Algorithme de chiffrement IKE (phase IKE 2).	'AES128' 'AES192' « AES256 » 'DES' 'DES3' 'GCMAES128' 'GCMAES256' (obligatoire)
ikeIntégrité	Algorithme d’intégrité IKE (phase IKE 2).	'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' (obligatoire)
ipsecCryptage	Algorithme de chiffrement IPSec (phase IKE 1).	'AES128' 'AES192' « AES256 » 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' (obligatoire)
ipsecIntégrité	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 » « Aucun » '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)

PropagatedRouteTable

Nom	Descriptif	Valeur
Id	Liste des ID de ressource de tous les RouteTables.	Sous-Ressource[]
Étiquettes	Liste des étiquettes.	chaîne de caractères[]

ResourceTags

Nom	Descriptif	Valeur

routageconfiguration

Nom	Descriptif	Valeur
associatedRouteTable	Id de ressource RouteTable associé à ce RoutingConfiguration.	Sous-ressource
inboundRouteMap	ID de ressource de RouteMap associé à ce RoutingConfiguration pour les itinéraires appris entrants.	Sous-ressource
sortantRouteMap	ID de ressource de l’ObjetRouteMap associé à ce RoutingConfiguration pour les itinéraires publiés sortants.	Sous-ressource
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	Descriptif	Valeur
adressePréfixes	Liste de tous les préfixes d’adresse.	chaîne de caractères[]
nom	Nom de StaticRoute unique au sein d’un réseau virtuel.	corde
suivantHopIpAddress	Adresse IP du tronçon suivant.	corde

StaticRoutesConfig

Nom	Descriptif	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.	'Contient' 'Égal'

Sous-ressource

Nom	Descriptif	Valeur
pièce d'identité	ID de ressource.	corde

TrafficSelectorPolicy

Nom	Descriptif	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	Descriptif	Valeur
staticRoutes	Liste de tous les itinéraires statiques.	staticRoute[]
staticRoutesConfig	Configuration des itinéraires statiques sur ce HubVnetConnection.	StaticRoutesConfig

Connexion VPN

Nom	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
connexionBande passante	Bande passante attendue en MBITs/S.	Int
dpdTimeoutSeconds	Délai DPD en secondes pour la connexion VPN.	Int
enableBgp	Indicateur EnableBgp.	Bool
activerInternetSecurity	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é.	Sous-ressource
routageConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.	routingConfiguration
routingPoids	Poids du routage pour la connexion VPN.	Int
clé partagée	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	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
mappages externes	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' 'EntréeSnat'
type	Type de règle NAT pour VPN NAT.	'Dynamique' « Statique »

VpnGatewayPropriétés

Nom	Descriptif	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[]
hubhub virtuel	VirtualHub auquel appartient la passerelle.	Sous-ressource
vpnGatewayScaleUnit	Unité d’échelle pour cette passerelle vpn.	Int

VpnNatRuleMapping

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

VpnSiteLinkConnection

Nom	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
connexionBande passante	Bande passante attendue en MBITs/S.	Int
sortieNatRules	Liste des natRules de sortie.	Sous-Ressource[]
enableBgp	Indicateur EnableBgp.	Bool
enableRateLimiting	Indicateur EnableBgp.	Bool
ingressNatRules	Liste des natRules d’entrée.	Sous-Ressource[]
ipsecPolicies	Stratégies IPSec à prendre en compte par cette connexion.	IpsecPolicy []
routingPoids	Poids du routage pour la connexion VPN.	Int
clé partagée	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.	Valeur par défaut 'InitiateurOnly' 'Répondeur uniquement'
vpnSiteLink	ID du lien de site vpn connecté.	Sous-ressource

Exemples d’utilisation

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module	Descriptif
passerelle VPN	Module de ressources AVM pour la passerelle VPN

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep	Descriptif
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 :

• groupes de ressources - Consultez commandes de déploiement de 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 code JSON suivant à votre modèle.

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

Valeurs de propriété

Microsoft.Network/vpnGateways

Nom	Descriptif	Valeur
apiVersion	Version de l’API	'2023-06-01'
emplacement	Emplacement des ressources.	corde
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés de la passerelle VPN.	VpnGatewayPropriétés
é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 »

BgpSettings

Nom	Descriptif	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	Descriptif	Valeur
customBgpIpAddress	BgpPeeringAddress personnalisé qui appartient à IpconfigurationId.	chaîne (obligatoire)
ipConfigurationId	IpconfigurationId de ipconfiguration qui appartient à la passerelle.	chaîne (obligatoire)

IPConfigurationBgpPeeringAddress

Nom	Descriptif	Valeur
customBgpIpAddresses	Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP.	chaîne de caractères[]
ipconfigurationId	ID de la configuration IP qui appartient à la passerelle.	corde

IpsecPolicy

Nom	Descriptif	Valeur
dhGroup	Groupe DH utilisé dans la phase 1 de IKE pour la sa initiale.	'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' « ECP256 » « ECP384 » 'None' (obligatoire)
ikeCryptage	Algorithme de chiffrement IKE (phase IKE 2).	'AES128' 'AES192' « AES256 » 'DES' 'DES3' 'GCMAES128' 'GCMAES256' (obligatoire)
ikeIntégrité	Algorithme d’intégrité IKE (phase IKE 2).	'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' (obligatoire)
ipsecCryptage	Algorithme de chiffrement IPSec (phase IKE 1).	'AES128' 'AES192' « AES256 » 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' (obligatoire)
ipsecIntégrité	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 » « Aucun » '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)

PropagatedRouteTable

Nom	Descriptif	Valeur
Id	Liste des ID de ressource de tous les RouteTables.	Sous-Ressource[]
Étiquettes	Liste des étiquettes.	chaîne de caractères[]

ResourceTags

Nom	Descriptif	Valeur

routageconfiguration

Nom	Descriptif	Valeur
associatedRouteTable	Id de ressource RouteTable associé à ce RoutingConfiguration.	Sous-ressource
inboundRouteMap	ID de ressource de RouteMap associé à ce RoutingConfiguration pour les itinéraires appris entrants.	Sous-ressource
sortantRouteMap	ID de ressource de l’ObjetRouteMap associé à ce RoutingConfiguration pour les itinéraires publiés sortants.	Sous-ressource
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	Descriptif	Valeur
adressePréfixes	Liste de tous les préfixes d’adresse.	chaîne de caractères[]
nom	Nom de StaticRoute unique au sein d’un réseau virtuel.	corde
suivantHopIpAddress	Adresse IP du tronçon suivant.	corde

StaticRoutesConfig

Nom	Descriptif	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.	'Contient' 'Égal'

Sous-ressource

Nom	Descriptif	Valeur
pièce d'identité	ID de ressource.	corde

TrafficSelectorPolicy

Nom	Descriptif	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	Descriptif	Valeur
staticRoutes	Liste de tous les itinéraires statiques.	staticRoute[]
staticRoutesConfig	Configuration des itinéraires statiques sur ce HubVnetConnection.	StaticRoutesConfig

Connexion VPN

Nom	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
connexionBande passante	Bande passante attendue en MBITs/S.	Int
dpdTimeoutSeconds	Délai DPD en secondes pour la connexion VPN.	Int
enableBgp	Indicateur EnableBgp.	Bool
activerInternetSecurity	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é.	Sous-ressource
routageConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.	routingConfiguration
routingPoids	Poids du routage pour la connexion VPN.	Int
clé partagée	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	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
mappages externes	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' 'EntréeSnat'
type	Type de règle NAT pour VPN NAT.	'Dynamique' « Statique »

VpnGatewayPropriétés

Nom	Descriptif	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[]
hubhub virtuel	VirtualHub auquel appartient la passerelle.	Sous-ressource
vpnGatewayScaleUnit	Unité d’échelle pour cette passerelle vpn.	Int

VpnNatRuleMapping

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

VpnSiteLinkConnection

Nom	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
connexionBande passante	Bande passante attendue en MBITs/S.	Int
sortieNatRules	Liste des natRules de sortie.	Sous-Ressource[]
enableBgp	Indicateur EnableBgp.	Bool
enableRateLimiting	Indicateur EnableBgp.	Bool
ingressNatRules	Liste des natRules d’entrée.	Sous-Ressource[]
ipsecPolicies	Stratégies IPSec à prendre en compte par cette connexion.	IpsecPolicy []
routingPoids	Poids du routage pour la connexion VPN.	Int
clé partagée	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.	Valeur par défaut 'InitiateurOnly' 'Répondeur uniquement'
vpnSiteLink	ID du lien de site vpn connecté.	Sous-ressource

Exemples d’utilisation

Modèles de démarrage rapide Azure

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

Modèle	Descriptif
déploiement multi-hub Azure Virtual WAN (vWAN)	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	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	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-06-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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
    }
  }
}

Valeurs de propriété

Microsoft.Network/vpnGateways

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

BgpSettings

Nom	Descriptif	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	Descriptif	Valeur
customBgpIpAddress	BgpPeeringAddress personnalisé qui appartient à IpconfigurationId.	chaîne (obligatoire)
ipConfigurationId	IpconfigurationId de ipconfiguration qui appartient à la passerelle.	chaîne (obligatoire)

IPConfigurationBgpPeeringAddress

Nom	Descriptif	Valeur
customBgpIpAddresses	Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP.	chaîne de caractères[]
ipconfigurationId	ID de la configuration IP qui appartient à la passerelle.	corde

IpsecPolicy

Nom	Descriptif	Valeur
dhGroup	Groupe DH utilisé dans la phase 1 de IKE pour la sa initiale.	'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' « ECP256 » « ECP384 » 'None' (obligatoire)
ikeCryptage	Algorithme de chiffrement IKE (phase IKE 2).	'AES128' 'AES192' « AES256 » 'DES' 'DES3' 'GCMAES128' 'GCMAES256' (obligatoire)
ikeIntégrité	Algorithme d’intégrité IKE (phase IKE 2).	'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' (obligatoire)
ipsecCryptage	Algorithme de chiffrement IPSec (phase IKE 1).	'AES128' 'AES192' « AES256 » 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' (obligatoire)
ipsecIntégrité	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 » « Aucun » '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)

PropagatedRouteTable

Nom	Descriptif	Valeur
Id	Liste des ID de ressource de tous les RouteTables.	Sous-Ressource[]
Étiquettes	Liste des étiquettes.	chaîne de caractères[]

ResourceTags

Nom	Descriptif	Valeur

routageconfiguration

Nom	Descriptif	Valeur
associatedRouteTable	Id de ressource RouteTable associé à ce RoutingConfiguration.	Sous-ressource
inboundRouteMap	ID de ressource de RouteMap associé à ce RoutingConfiguration pour les itinéraires appris entrants.	Sous-ressource
sortantRouteMap	ID de ressource de l’ObjetRouteMap associé à ce RoutingConfiguration pour les itinéraires publiés sortants.	Sous-ressource
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	Descriptif	Valeur
adressePréfixes	Liste de tous les préfixes d’adresse.	chaîne de caractères[]
nom	Nom de StaticRoute unique au sein d’un réseau virtuel.	corde
suivantHopIpAddress	Adresse IP du tronçon suivant.	corde

StaticRoutesConfig

Nom	Descriptif	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.	'Contient' 'Égal'

Sous-ressource

Nom	Descriptif	Valeur
pièce d'identité	ID de ressource.	corde

TrafficSelectorPolicy

Nom	Descriptif	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	Descriptif	Valeur
staticRoutes	Liste de tous les itinéraires statiques.	staticRoute[]
staticRoutesConfig	Configuration des itinéraires statiques sur ce HubVnetConnection.	StaticRoutesConfig

Connexion VPN

Nom	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
connexionBande passante	Bande passante attendue en MBITs/S.	Int
dpdTimeoutSeconds	Délai DPD en secondes pour la connexion VPN.	Int
enableBgp	Indicateur EnableBgp.	Bool
activerInternetSecurity	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é.	Sous-ressource
routageConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.	routingConfiguration
routingPoids	Poids du routage pour la connexion VPN.	Int
clé partagée	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	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
mappages externes	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' 'EntréeSnat'
type	Type de règle NAT pour VPN NAT.	'Dynamique' « Statique »

VpnGatewayPropriétés

Nom	Descriptif	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[]
hubhub virtuel	VirtualHub auquel appartient la passerelle.	Sous-ressource
vpnGatewayScaleUnit	Unité d’échelle pour cette passerelle vpn.	Int

VpnNatRuleMapping

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

VpnSiteLinkConnection

Nom	Descriptif	Valeur
pièce d'identité	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	Descriptif	Valeur
connexionBande passante	Bande passante attendue en MBITs/S.	Int
sortieNatRules	Liste des natRules de sortie.	Sous-Ressource[]
enableBgp	Indicateur EnableBgp.	Bool
enableRateLimiting	Indicateur EnableBgp.	Bool
ingressNatRules	Liste des natRules d’entrée.	Sous-Ressource[]
ipsecPolicies	Stratégies IPSec à prendre en compte par cette connexion.	IpsecPolicy []
routingPoids	Poids du routage pour la connexion VPN.	Int
clé partagée	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.	Valeur par défaut 'InitiateurOnly' 'Répondeur uniquement'
vpnSiteLink	ID du lien de site vpn connecté.	Sous-ressource