The name of the StaticRoute that is unique within a VnetRoute.
string
nextHopIpAddress
The ip address of the next hop.
string
StaticRoutesConfig
Name
Description
Value
vnetLocalRouteOverrideCriteria
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
'Contains' 'Equal'
VirtualHubId
Name
Description
Value
id
The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.
string
Quickstart templates
The following quickstart templates deploy this resource type.
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment, including all gateways and VNET connections, and demonstrate the usage of Route Tables for custom routing.
ARM template resource definition
The expressRouteGateways resource type can be deployed with operations that target:
The name of the StaticRoute that is unique within a VnetRoute.
string
nextHopIpAddress
The ip address of the next hop.
string
StaticRoutesConfig
Name
Description
Value
vnetLocalRouteOverrideCriteria
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
'Contains' 'Equal'
VirtualHubId
Name
Description
Value
id
The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.
string
Quickstart templates
The following quickstart templates deploy this resource type.
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment, including all gateways and VNET connections, and demonstrate the usage of Route Tables for custom routing.
Terraform (AzAPI provider) resource definition
The expressRouteGateways resource type can be deployed with operations that target:
Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/expressRouteGateways resource, add the following Terraform to your template.
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"
}
}
})
}
The name of the StaticRoute that is unique within a VnetRoute.
string
nextHopIpAddress
The ip address of the next hop.
string
StaticRoutesConfig
Name
Description
Value
vnetLocalRouteOverrideCriteria
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
"Contains" "Equal"
VirtualHubId
Name
Description
Value
id
The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.
string
Feedback
Was this page helpful?
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.