Microsoft.Network expressRouteGateways/expressRouteConnections 2024-01-01

• Latest
• 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

Bicep resource definition

The expressRouteGateways/expressRouteConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteGateways/expressRouteConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/expressRouteGateways/expressRouteConnections@2024-01-01' = {
  parent: resourceSymbolicName
  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
  }
}

Property Values

Microsoft.Network/expressRouteGateways/expressRouteConnections

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: expressRouteGateways
properties	Properties of the express route connection.	ExpressRouteConnectionProperties

ExpressRouteCircuitPeeringId

Name	Description	Value
id	The ID of the ExpressRoute circuit peering.	string

ExpressRouteConnectionProperties

Name	Description	Value
authorizationKey	Authorization key to establish the connection.	string
enableInternetSecurity	Enable internet security.	bool
enablePrivateLinkFastPath	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.	bool
expressRouteCircuitPeering	The ExpressRoute circuit peering.	ExpressRouteCircuitPeeringId (required)
expressRouteGatewayBypass	Enable FastPath to vWan Firewall hub.	bool
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration
routingWeight	The routing weight associated to the connection.	int

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
inboundRouteMap	The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.	SubResource
outboundRouteMap	The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	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'

SubResource

Name	Description	Value
id	Resource ID.	string

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]
staticRoutesConfig	Configuration for static routes on this HubVnetConnection.	StaticRoutesConfig

ARM template resource definition

The expressRouteGateways/expressRouteConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteGateways/expressRouteConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/expressRouteGateways/expressRouteConnections",
  "apiVersion": "2024-01-01",
  "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"
  }
}

Property Values

Microsoft.Network/expressRouteGateways/expressRouteConnections

Name	Description	Value
apiVersion	The api version	'2024-01-01'
name	The resource name	string (required)
properties	Properties of the express route connection.	ExpressRouteConnectionProperties
type	The resource type	'Microsoft.Network/expressRouteGateways/expressRouteConnections'

ExpressRouteCircuitPeeringId

Name	Description	Value
id	The ID of the ExpressRoute circuit peering.	string

ExpressRouteConnectionProperties

Name	Description	Value
authorizationKey	Authorization key to establish the connection.	string
enableInternetSecurity	Enable internet security.	bool
enablePrivateLinkFastPath	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.	bool
expressRouteCircuitPeering	The ExpressRoute circuit peering.	ExpressRouteCircuitPeeringId (required)
expressRouteGatewayBypass	Enable FastPath to vWan Firewall hub.	bool
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration
routingWeight	The routing weight associated to the connection.	int

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
inboundRouteMap	The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.	SubResource
outboundRouteMap	The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	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'

SubResource

Name	Description	Value
id	Resource ID.	string

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]
staticRoutesConfig	Configuration for static routes on this HubVnetConnection.	StaticRoutesConfig

Usage Examples

Terraform (AzAPI provider) resource definition

The expressRouteGateways/expressRouteConnections 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/expressRouteConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteGateways/expressRouteConnections@2024-01-01"
  name = "string"
  parent_id = "string"
  body = {
    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
    }
  }
}

Property Values

Microsoft.Network/expressRouteGateways/expressRouteConnections

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: expressRouteGateways
properties	Properties of the express route connection.	ExpressRouteConnectionProperties
type	The resource type	"Microsoft.Network/expressRouteGateways/expressRouteConnections@2024-01-01"

ExpressRouteCircuitPeeringId

Name	Description	Value
id	The ID of the ExpressRoute circuit peering.	string

ExpressRouteConnectionProperties

Name	Description	Value
authorizationKey	Authorization key to establish the connection.	string
enableInternetSecurity	Enable internet security.	bool
enablePrivateLinkFastPath	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.	bool
expressRouteCircuitPeering	The ExpressRoute circuit peering.	ExpressRouteCircuitPeeringId (required)
expressRouteGatewayBypass	Enable FastPath to vWan Firewall hub.	bool
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration
routingWeight	The routing weight associated to the connection.	int

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
inboundRouteMap	The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.	SubResource
outboundRouteMap	The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	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'

SubResource

Name	Description	Value
id	Resource ID.	string

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]
staticRoutesConfig	Configuration for static routes on this HubVnetConnection.	StaticRoutesConfig