Microsoft.Network/expressRouteGateways - Bicep, ARM template & Terraform AzAPI reference

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.Network/expressRouteGateways@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    allowNonVirtualWanTraffic: bool
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    expressRouteConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          authorizationKey: 'string'
          enableInternetSecurity: bool
          enablePrivateLinkFastPath: bool
          expressRouteCircuitPeering: {
            id: 'string'
          }
          expressRouteGatewayBypass: bool
          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
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
  }
}

Valeurs de propriété

expressRouteGateways

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

ExpressRouteGatewayProperties

Nom	Description	Valeur
allowNonVirtualWanTraffic	Configure cette passerelle pour accepter le trafic à partir de réseaux non Virtual WAN.	Bool
autoScaleConfiguration	Configuration de la mise à l’échelle automatique.	ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections	Liste des connexions ExpressRoute à la passerelle ExpressRoute.	expressRouteConnection[]
virtualHub	Hub virtuel où la passerelle ExpressRoute est ou sera déployée.	VirtualHubId (obligatoire)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

Nom	Description	Valeur
limites	Nombre minimal et maximal d’unités d’échelle à déployer.	ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

Nom	Description	Valeur
max	Nombre maximal d’unités d’échelle déployées pour la passerelle ExpressRoute.	Int
Min	Nombre minimal d’unités d’échelle déployées pour la passerelle ExpressRoute.	Int

ExpressRouteConnection

Nom	Description	Valeur
id	ID de ressource.	corde
nom	Nom de la ressource.	chaîne (obligatoire)
Propriétés	Propriétés de la connexion express route.	ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

Nom	Description	Valeur
authorizationKey	Clé d’autorisation pour établir la connexion.	corde
enableInternetSecurity	Activer la sécurité Internet.	Bool
enablePrivateLinkFastPath	Contournez la passerelle ExpressRoute lors de l’accès aux liaisons privées. ExpressRoute FastPath (expressRouteGatewayBypass) doit être activé.	Bool
expressRouteCircuitPeering	Peering de circuit ExpressRoute.	ExpressRouteCircuitPeeringId (obligatoire)
expressRouteGatewayBypass	Activez FastPath pour le hub de pare-feu vWan.	Bool
routingConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.	routingConfiguration
routingWeight	Poids de routage associé à la connexion.	Int

ExpressRouteCircuitPeeringId

Nom	Description	Valeur
id	ID du peering de circuits ExpressRoute.	corde

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

Sous-ressource

Nom	Description	Valeur
id	ID de ressource.	corde

PropagatedRouteTable

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

VnetRoute

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

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'

VirtualHubId

Nom	Description	Valeur
id	URI de ressource pour le hub virtuel où la passerelle ExpressRoute est ou sera déployée. La ressource Virtual Hub et la ressource de passerelle ExpressRoute résident dans le même abonnement.	corde

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)	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é.

Définition de ressource de modèle ARM

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

{
  "type": "Microsoft.Network/expressRouteGateways",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "allowNonVirtualWanTraffic": "bool",
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "expressRouteConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "authorizationKey": "string",
          "enableInternetSecurity": "bool",
          "enablePrivateLinkFastPath": "bool",
          "expressRouteCircuitPeering": {
            "id": "string"
          },
          "expressRouteGatewayBypass": "bool",
          "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"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    }
  }
}

Valeurs de propriété

expressRouteGateways

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

ExpressRouteGatewayProperties

Nom	Description	Valeur
allowNonVirtualWanTraffic	Configure cette passerelle pour accepter le trafic à partir de réseaux non Virtual WAN.	Bool
autoScaleConfiguration	Configuration de la mise à l’échelle automatique.	ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections	Liste des connexions ExpressRoute à la passerelle ExpressRoute.	expressRouteConnection[]
virtualHub	Hub virtuel où la passerelle ExpressRoute est ou sera déployée.	VirtualHubId (obligatoire)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

Nom	Description	Valeur
limites	Nombre minimal et maximal d’unités d’échelle à déployer.	ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

Nom	Description	Valeur
max	Nombre maximal d’unités d’échelle déployées pour la passerelle ExpressRoute.	Int
Min	Nombre minimal d’unités d’échelle déployées pour la passerelle ExpressRoute.	Int

ExpressRouteConnection

Nom	Description	Valeur
id	ID de ressource.	corde
nom	Nom de la ressource.	chaîne (obligatoire)
Propriétés	Propriétés de la connexion express route.	ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

Nom	Description	Valeur
authorizationKey	Clé d’autorisation pour établir la connexion.	corde
enableInternetSecurity	Activer la sécurité Internet.	Bool
enablePrivateLinkFastPath	Contournez la passerelle ExpressRoute lors de l’accès aux liaisons privées. ExpressRoute FastPath (expressRouteGatewayBypass) doit être activé.	Bool
expressRouteCircuitPeering	Peering de circuit ExpressRoute.	ExpressRouteCircuitPeeringId (obligatoire)
expressRouteGatewayBypass	Activez FastPath pour le hub de pare-feu vWan.	Bool
routingConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.	routingConfiguration
routingWeight	Poids de routage associé à la connexion.	Int

ExpressRouteCircuitPeeringId

Nom	Description	Valeur
id	ID du peering de circuits ExpressRoute.	corde

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

Sous-ressource

Nom	Description	Valeur
id	ID de ressource.	corde

PropagatedRouteTable

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

VnetRoute

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

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'

VirtualHubId

Nom	Description	Valeur
id	URI de ressource pour le hub virtuel où la passerelle ExpressRoute est ou sera déployée. La ressource Virtual Hub et la ressource de passerelle ExpressRoute résident dans le même abonnement.	corde

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)	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é.

Définition de ressource Terraform (fournisseur AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteGateways@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allowNonVirtualWanTraffic = bool
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      expressRouteConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            authorizationKey = "string"
            enableInternetSecurity = bool
            enablePrivateLinkFastPath = bool
            expressRouteCircuitPeering = {
              id = "string"
            }
            expressRouteGatewayBypass = bool
            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
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
    }
  })
}

Valeurs de propriété

expressRouteGateways

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Network/expressRouteGateways@2023-11-01 »
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Emplacement des ressources.	corde
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
étiquettes	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes.
Propriétés	Propriétés de la passerelle express route.	ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

Nom	Description	Valeur
allowNonVirtualWanTraffic	Configure cette passerelle pour accepter le trafic à partir de réseaux non Virtual WAN.	Bool
autoScaleConfiguration	Configuration de la mise à l’échelle automatique.	ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections	Liste des connexions ExpressRoute à la passerelle ExpressRoute.	expressRouteConnection[]
virtualHub	Hub virtuel où la passerelle ExpressRoute est ou sera déployée.	VirtualHubId (obligatoire)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

Nom	Description	Valeur
limites	Nombre minimal et maximal d’unités d’échelle à déployer.	ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

Nom	Description	Valeur
max	Nombre maximal d’unités d’échelle déployées pour la passerelle ExpressRoute.	Int
Min	Nombre minimal d’unités d’échelle déployées pour la passerelle ExpressRoute.	Int

ExpressRouteConnection

Nom	Description	Valeur
id	ID de ressource.	corde
nom	Nom de la ressource.	chaîne (obligatoire)
Propriétés	Propriétés de la connexion express route.	ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

Nom	Description	Valeur
authorizationKey	Clé d’autorisation pour établir la connexion.	corde
enableInternetSecurity	Activer la sécurité Internet.	Bool
enablePrivateLinkFastPath	Contournez la passerelle ExpressRoute lors de l’accès aux liaisons privées. ExpressRoute FastPath (expressRouteGatewayBypass) doit être activé.	Bool
expressRouteCircuitPeering	Peering de circuit ExpressRoute.	ExpressRouteCircuitPeeringId (obligatoire)
expressRouteGatewayBypass	Activez FastPath pour le hub de pare-feu vWan.	Bool
routingConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.	routingConfiguration
routingWeight	Poids de routage associé à la connexion.	Int

ExpressRouteCircuitPeeringId

Nom	Description	Valeur
id	ID du peering de circuits ExpressRoute.	corde

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

Sous-ressource

Nom	Description	Valeur
id	ID de ressource.	corde

PropagatedRouteTable

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

VnetRoute

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

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 »

VirtualHubId

Nom	Description	Valeur
id	URI de ressource pour le hub virtuel où la passerelle ExpressRoute est ou sera déployée. La ressource Virtual Hub et la ressource de passerelle ExpressRoute résident dans le même abonnement.	corde

Partager via

Microsoft.Network expressRouteGateways

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

expressRouteGateways

ExpressRouteGatewayProperties

ExpressRouteGatewayPropertiesAutoScaleConfiguration

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteConnection

ExpressRouteConnectionProperties

ExpressRouteCircuitPeeringId

RoutingConfiguration

Sous-ressource

PropagatedRouteTable

VnetRoute

StaticRoute

StaticRoutesConfig

VirtualHubId

Modèles de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

expressRouteGateways

ExpressRouteGatewayProperties

ExpressRouteGatewayPropertiesAutoScaleConfiguration

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteConnection

ExpressRouteConnectionProperties

ExpressRouteCircuitPeeringId

RoutingConfiguration

Sous-ressource

PropagatedRouteTable

VnetRoute

StaticRoute

StaticRoutesConfig

VirtualHubId

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

expressRouteGateways

ExpressRouteGatewayProperties

ExpressRouteGatewayPropertiesAutoScaleConfiguration

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteConnection

ExpressRouteConnectionProperties

ExpressRouteCircuitPeeringId

RoutingConfiguration

Sous-ressource

PropagatedRouteTable

VnetRoute

StaticRoute

StaticRoutesConfig

VirtualHubId

Commentaires

Ressources supplémentaires