Microsoft.Network virtualNetworkGateways 2024-05-01

Définition de ressource Bicep

Le type de ressource virtualNetworkGateways 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/virtualNetworkGateways, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2024-05-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: bool
    adminState: 'string'
    allowRemoteVnetTraffic: bool
    allowVirtualWanTraffic: bool
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    customRoutes: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    disableIPSecReplayProtection: bool
    enableBgp: bool
    enableBgpRouteTranslationForNat: bool
    enableDnsForwarding: bool
    enablePrivateIpAddress: bool
    gatewayDefaultSite: {
      id: 'string'
    }
    gatewayType: 'string'
    ipConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateIPAllocationMethod: 'string'
          publicIPAddress: {
            id: 'string'
          }
          subnet: {
            id: 'string'
          }
        }
      }
    ]
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    resiliencyModel: 'string'
    sku: {
      name: 'string'
      tier: 'string'
    }
    virtualNetworkGatewayPolicyGroups: [
      {
        id: 'string'
        name: 'string'
        properties: {
          isDefault: bool
          policyMembers: [
            {
              attributeType: 'string'
              attributeValue: 'string'
              name: 'string'
            }
          ]
          priority: int
        }
      }
    ]
    vNetExtendedLocationResourceId: 'string'
    vpnClientConfiguration: {
      aadAudience: 'string'
      aadIssuer: 'string'
      aadTenant: 'string'
      radiusServerAddress: 'string'
      radiusServers: [
        {
          radiusServerAddress: 'string'
          radiusServerScore: int
          radiusServerSecret: 'string'
        }
      ]
      radiusServerSecret: 'string'
      vngClientConnectionConfigurations: [
        {
          id: 'string'
          name: 'string'
          properties: {
            virtualNetworkGatewayPolicyGroups: [
              {
                id: 'string'
              }
            ]
            vpnClientAddressPool: {
              addressPrefixes: [
                'string'
              ]
              ipamPoolPrefixAllocations: [
                {
                  numberOfIpAddresses: 'string'
                  pool: {
                    id: 'string'
                  }
                }
              ]
            }
          }
        }
      ]
      vpnAuthenticationTypes: [
        'string'
      ]
      vpnClientAddressPool: {
        addressPrefixes: [
          'string'
        ]
        ipamPoolPrefixAllocations: [
          {
            numberOfIpAddresses: 'string'
            pool: {
              id: 'string'
            }
          }
        ]
      }
      vpnClientIpsecPolicies: [
        {
          dhGroup: 'string'
          ikeEncryption: 'string'
          ikeIntegrity: 'string'
          ipsecEncryption: 'string'
          ipsecIntegrity: 'string'
          pfsGroup: 'string'
          saDataSizeKilobytes: int
          saLifeTimeSeconds: int
        }
      ]
      vpnClientProtocols: [
        'string'
      ]
      vpnClientRevokedCertificates: [
        {
          id: 'string'
          name: 'string'
          properties: {
            thumbprint: 'string'
          }
        }
      ]
      vpnClientRootCertificates: [
        {
          id: 'string'
          name: 'string'
          properties: {
            publicCertData: 'string'
          }
        }
      ]
    }
    vpnGatewayGeneration: 'string'
    vpnType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

AddressSpace

BgpSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ExtendedLocation

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

IPConfigurationBgpPeeringAddress

IpsecPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Sous-ressource

VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayAutoScaleConfiguration

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Exemples de démarrage rapide

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

Définition de ressource de modèle ARM

Le type de ressource virtualNetworkGateways 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/virtualNetworkGateways, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Network/virtualNetworkGateways",
  "apiVersion": "2024-05-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "activeActive": "bool",
    "adminState": "string",
    "allowRemoteVnetTraffic": "bool",
    "allowVirtualWanTraffic": "bool",
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "customRoutes": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "disableIPSecReplayProtection": "bool",
    "enableBgp": "bool",
    "enableBgpRouteTranslationForNat": "bool",
    "enableDnsForwarding": "bool",
    "enablePrivateIpAddress": "bool",
    "gatewayDefaultSite": {
      "id": "string"
    },
    "gatewayType": "string",
    "ipConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateIPAllocationMethod": "string",
          "publicIPAddress": {
            "id": "string"
          },
          "subnet": {
            "id": "string"
          }
        }
      }
    ],
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "resiliencyModel": "string",
    "sku": {
      "name": "string",
      "tier": "string"
    },
    "virtualNetworkGatewayPolicyGroups": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "isDefault": "bool",
          "policyMembers": [
            {
              "attributeType": "string",
              "attributeValue": "string",
              "name": "string"
            }
          ],
          "priority": "int"
        }
      }
    ],
    "vNetExtendedLocationResourceId": "string",
    "vpnClientConfiguration": {
      "aadAudience": "string",
      "aadIssuer": "string",
      "aadTenant": "string",
      "radiusServerAddress": "string",
      "radiusServers": [
        {
          "radiusServerAddress": "string",
          "radiusServerScore": "int",
          "radiusServerSecret": "string"
        }
      ],
      "radiusServerSecret": "string",
      "vngClientConnectionConfigurations": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "virtualNetworkGatewayPolicyGroups": [
              {
                "id": "string"
              }
            ],
            "vpnClientAddressPool": {
              "addressPrefixes": [ "string" ],
              "ipamPoolPrefixAllocations": [
                {
                  "numberOfIpAddresses": "string",
                  "pool": {
                    "id": "string"
                  }
                }
              ]
            }
          }
        }
      ],
      "vpnAuthenticationTypes": [ "string" ],
      "vpnClientAddressPool": {
        "addressPrefixes": [ "string" ],
        "ipamPoolPrefixAllocations": [
          {
            "numberOfIpAddresses": "string",
            "pool": {
              "id": "string"
            }
          }
        ]
      },
      "vpnClientIpsecPolicies": [
        {
          "dhGroup": "string",
          "ikeEncryption": "string",
          "ikeIntegrity": "string",
          "ipsecEncryption": "string",
          "ipsecIntegrity": "string",
          "pfsGroup": "string",
          "saDataSizeKilobytes": "int",
          "saLifeTimeSeconds": "int"
        }
      ],
      "vpnClientProtocols": [ "string" ],
      "vpnClientRevokedCertificates": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "thumbprint": "string"
          }
        }
      ],
      "vpnClientRootCertificates": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "publicCertData": "string"
          }
        }
      ]
    },
    "vpnGatewayGeneration": "string",
    "vpnType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

AddressSpace

BgpSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ExtendedLocation

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

IPConfigurationBgpPeeringAddress

IpsecPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Sous-ressource

VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayAutoScaleConfiguration

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Modèles de démarrage rapide

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

Modèle	Description
App Service Environment avec le serveur principal Azure SQL	Ce modèle crée un environnement App Service avec un back-end Azure SQL, ainsi que des points de terminaison privés, ainsi que des ressources associées généralement utilisées dans un environnement privé/isolé.
interrégionS CF BOSH	Ce modèle vous aide à configurer les ressources nécessaires pour déployer BOSH et Cloud Foundry dans deux régions sur Azure.
Connecter un circuit ExpressRoute à un réseau virtuel	Ce modèle crée un réseau virtuel, une passerelle ExpresRoute et une connexion à un circuit ExpressRoute approvisionné et activé avec AzurePrivatePeering configuré.
Créer un réseau virtuel BGP sur une connexion de réseau virtuel	Ce modèle vous permet de connecter deux réseaux virtuels à l’aide de passerelles de réseau virtuel et de BGP
Créer un environnement DevTest avec des VPN P2S et IIS	Ce modèle crée un environnement DevTest simple avec un VPN point à site et IIS sur un serveur Windows, qui est un excellent moyen de commencer.
créer un de passerelle point à site	Ce modèle vous permet de créer une connexion point à site à l’aide de VirtualNetworkGateways
créer une passerelle point à site avec Azure AD	Ce modèle déploie une passerelle de réseau virtuel VPN configurée avec une connexion point à site Azure Active Directory
créer une connexion VPN de site à site	Ce modèle vous permet de créer une connexion VPN de site à site à l’aide de passerelles de réseau virtuel
créer une connexion VPN de site à site avec de machine virtuelle	Ce modèle vous permet de créer une connexion VPN de site à site à l’aide de passerelles de réseau virtuel
Créer une connexion de réseau virtuel à réseau virtuel entre deux régions	Ce modèle vous permet de connecter deux réseaux virtuels dans différentes régions à l’aide de passerelles de réseau virtuel
Créer un mi SQL avec une connexion point à site configurée	Déployez Azure Sql Database Managed Instance (SQL MI) et la passerelle de réseau virtuel configurée pour une connexion point à site à l’intérieur du nouveau réseau virtuel.
Créer trois réseaux virtuels pour illustrer les connexions BGP transitives	Ce modèle déploie trois réseaux virtuels connectés à l’aide de passerelles de réseau virtuel et de connexions compatibles BGP
Créer un réseau virtuel avec deux sous-réseaux, un réseau local et une passerelle	Ce modèle crée un réseau virtuel, 2 sous-réseaux et une passerelle
Déployer un bac à sable de topologie hub-and-spoke	Ce modèle crée une configuration de topologie hub-and-spoke de base. Il crée un réseau virtuel Hub avec des sous-réseaux DMZ, Management, Shared and Gateway (éventuellement), avec deux réseaux virtuels Spoke (développement et production) contenant chacun un sous-réseau de charge de travail. Il déploie également une Jump-Host Windows sur le sous-réseau de gestion du hub et établit des peerings de réseaux virtuels entre le hub et les deux spokes.
Déployer la géoréplication HBase	Ce modèle vous permet de configurer un environnement Azure pour la réplication HBase dans deux régions différentes avec une connexion de réseau virtuel à réseau virtuel VPN.
circuit ExpressRoute avec peering privé et de réseau virtuel Azure	Ce modèle configure le peering Microsoft ExpressRoute, déploie un réseau virtuel Azure avec la passerelle ExpressRoute et lie le réseau virtuel au circuit ExpressRoute
étendre un réseau virtuel Azure existant à une configuration multi-réseau virtuel	Ce modèle vous permet d’étendre un environnement de réseau virtuel unique existant à un environnement multi-réseau virtuel qui s’étend sur deux régions de centre de données à l’aide de passerelles de réseau virtuel à réseau virtuel
VPN de site à site avec des passerelles VPN actives avec BGP	Ce modèle vous permet de déployer un VPN de site à site entre deux réseaux virtuels avec des passerelles VPN dans la configuration active-active avec BGP. Chaque passerelle VPN Azure résout le nom de domaine complet des homologues distants pour déterminer l’adresse IP publique de la passerelle VPN distante. Le modèle s’exécute comme prévu dans les régions Azure avec des zones de disponibilité.
utiliser le Pare-feu Azure comme proxy DNS dans une topologie Hub & Spoke	Cet exemple montre comment déployer une topologie hub-spoke dans Azure à l’aide du Pare-feu Azure. Le réseau virtuel hub agit comme un point central de connectivité à de nombreux réseaux virtuels spoke connectés au réseau virtuel hub via le peering de réseaux virtuels.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource virtualNetworkGateways 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/virtualNetworkGateways, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2024-05-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      activeActive = bool
      adminState = "string"
      allowRemoteVnetTraffic = bool
      allowVirtualWanTraffic = bool
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      customRoutes = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      disableIPSecReplayProtection = bool
      enableBgp = bool
      enableBgpRouteTranslationForNat = bool
      enableDnsForwarding = bool
      enablePrivateIpAddress = bool
      gatewayDefaultSite = {
        id = "string"
      }
      gatewayType = "string"
      ipConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            privateIPAllocationMethod = "string"
            publicIPAddress = {
              id = "string"
            }
            subnet = {
              id = "string"
            }
          }
        }
      ]
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      resiliencyModel = "string"
      sku = {
        name = "string"
        tier = "string"
      }
      virtualNetworkGatewayPolicyGroups = [
        {
          id = "string"
          name = "string"
          properties = {
            isDefault = bool
            policyMembers = [
              {
                attributeType = "string"
                attributeValue = "string"
                name = "string"
              }
            ]
            priority = int
          }
        }
      ]
      vNetExtendedLocationResourceId = "string"
      vpnClientConfiguration = {
        aadAudience = "string"
        aadIssuer = "string"
        aadTenant = "string"
        radiusServerAddress = "string"
        radiusServers = [
          {
            radiusServerAddress = "string"
            radiusServerScore = int
            radiusServerSecret = "string"
          }
        ]
        radiusServerSecret = "string"
        vngClientConnectionConfigurations = [
          {
            id = "string"
            name = "string"
            properties = {
              virtualNetworkGatewayPolicyGroups = [
                {
                  id = "string"
                }
              ]
              vpnClientAddressPool = {
                addressPrefixes = [
                  "string"
                ]
                ipamPoolPrefixAllocations = [
                  {
                    numberOfIpAddresses = "string"
                    pool = {
                      id = "string"
                    }
                  }
                ]
              }
            }
          }
        ]
        vpnAuthenticationTypes = [
          "string"
        ]
        vpnClientAddressPool = {
          addressPrefixes = [
            "string"
          ]
          ipamPoolPrefixAllocations = [
            {
              numberOfIpAddresses = "string"
              pool = {
                id = "string"
              }
            }
          ]
        }
        vpnClientIpsecPolicies = [
          {
            dhGroup = "string"
            ikeEncryption = "string"
            ikeIntegrity = "string"
            ipsecEncryption = "string"
            ipsecIntegrity = "string"
            pfsGroup = "string"
            saDataSizeKilobytes = int
            saLifeTimeSeconds = int
          }
        ]
        vpnClientProtocols = [
          "string"
        ]
        vpnClientRevokedCertificates = [
          {
            id = "string"
            name = "string"
            properties = {
              thumbprint = "string"
            }
          }
        ]
        vpnClientRootCertificates = [
          {
            id = "string"
            name = "string"
            properties = {
              publicCertData = "string"
            }
          }
        ]
      }
      vpnGatewayGeneration = "string"
      vpnType = "string"
    }
  })
}

Valeurs de propriété

AddressSpace

BgpSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ExtendedLocation

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

IPConfigurationBgpPeeringAddress

IpsecPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Sous-ressource

VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayAutoScaleConfiguration

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping