Microsoft.Network expressRouteCircuits 2020-03-01

The expressRouteCircuits resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Network/expressRouteCircuits resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Network/expressRouteCircuits@2020-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    family: 'string'
    name: 'string'
    tier: 'string'
  }
  properties: {
    allowClassicOperations: bool
    authorizations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          authorizationKey: 'string'
          authorizationUseStatus: 'string'
        }
      }
    ]
    bandwidthInGbps: int
    circuitProvisioningState: 'string'
    expressRoutePort: {
      id: 'string'
    }
    gatewayManagerEtag: 'string'
    globalReachEnabled: bool
    peerings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          azureASN: int
          connections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                addressPrefix: 'string'
                authorizationKey: 'string'
                expressRouteCircuitPeering: {
                  id: 'string'
                }
                ipv6CircuitConnectionConfig: {
                  addressPrefix: 'string'
                }
                peerExpressRouteCircuitPeering: {
                  id: 'string'
                }
              }
            }
          ]
          expressRouteConnection: {}
          gatewayManagerEtag: 'string'
          ipv6PeeringConfig: {
            microsoftPeeringConfig: {
              advertisedCommunities: [ 'string' ]
              advertisedPublicPrefixes: [ 'string' ]
              customerASN: int
              legacyMode: int
              routingRegistryName: 'string'
            }
            primaryPeerAddressPrefix: 'string'
            routeFilter: {
              id: 'string'
            }
            secondaryPeerAddressPrefix: 'string'
            state: 'string'
          }
          microsoftPeeringConfig: {
            advertisedCommunities: [ 'string' ]
            advertisedPublicPrefixes: [ 'string' ]
            customerASN: int
            legacyMode: int
            routingRegistryName: 'string'
          }
          peerASN: int
          peeringType: 'string'
          primaryAzurePort: 'string'
          primaryPeerAddressPrefix: 'string'
          routeFilter: {
            id: 'string'
          }
          secondaryAzurePort: 'string'
          secondaryPeerAddressPrefix: 'string'
          sharedKey: 'string'
          state: 'string'
          stats: {
            primarybytesIn: int
            primarybytesOut: int
            secondarybytesIn: int
            secondarybytesOut: int
          }
          vlanId: int
        }
      }
    ]
    serviceKey: 'string'
    serviceProviderNotes: 'string'
    serviceProviderProperties: {
      bandwidthInMbps: int
      peeringLocation: 'string'
      serviceProviderName: 'string'
    }
    serviceProviderProvisioningState: 'string'
  }
}

Property values

expressRouteCircuits

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Network/expressRouteCircuits'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-03-01'
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Contains SKU in an ExpressRouteCircuit. ExpressRouteCircuitSku
properties Properties of ExpressRouteCircuit. ExpressRouteCircuitPropertiesFormat

ExpressRouteCircuitPropertiesFormat

Name Description Value
allowClassicOperations Allow classic operations. bool
authorizations The list of authorizations. ExpressRouteCircuitAuthorization[]
bandwidthInGbps The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. int
circuitProvisioningState The CircuitProvisioningState state of the resource. string
expressRoutePort Reference to another subresource. SubResource
gatewayManagerEtag The GatewayManager Etag. string
globalReachEnabled Flag denoting global reach status. bool
peerings The list of peerings. ExpressRouteCircuitPeering[]
serviceKey The ServiceKey. string
serviceProviderNotes The ServiceProviderNotes. string
serviceProviderProperties Contains ServiceProviderProperties in an ExpressRouteCircuit. ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState The ServiceProviderProvisioningState state of the resource. 'Deprovisioning'
'NotProvisioned'
'Provisioned'
'Provisioning'

ExpressRouteCircuitAuthorization

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of ExpressRouteCircuitAuthorization. AuthorizationPropertiesFormat

AuthorizationPropertiesFormat

Name Description Value
authorizationKey The authorization key. string
authorizationUseStatus The authorization use status. 'Available'
'InUse'

SubResource

Name Description Value
id Resource ID. string

ExpressRouteCircuitPeering

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of the express route circuit peering. ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringPropertiesFormat

Name Description Value
azureASN The Azure ASN. int
connections The list of circuit connections associated with Azure Private Peering for this circuit. ExpressRouteCircuitConnection[]
expressRouteConnection The ID of the ExpressRouteConnection. ExpressRouteConnectionId
gatewayManagerEtag The GatewayManager Etag. string
ipv6PeeringConfig Contains IPv6 peering config. Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig Specifies the peering configuration. ExpressRouteCircuitPeeringConfig
peerASN The peer ASN. int
peeringType The peering type. 'AzurePrivatePeering'
'AzurePublicPeering'
'MicrosoftPeering'
primaryAzurePort The primary port. string
primaryPeerAddressPrefix The primary address prefix. string
routeFilter Reference to another subresource. SubResource
secondaryAzurePort The secondary port. string
secondaryPeerAddressPrefix The secondary address prefix. string
sharedKey The shared key. string
state The state of peering. 'Disabled'
'Enabled'
stats Contains stats associated with the peering. ExpressRouteCircuitStats
vlanId The VLAN ID. int

ExpressRouteCircuitConnection

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of the express route circuit connection. ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitConnectionPropertiesFormat

Name Description Value
addressPrefix /29 IP address space to carve out Customer addresses for tunnels. string
authorizationKey The authorization key. string
expressRouteCircuitPeering Reference to another subresource. SubResource
ipv6CircuitConnectionConfig IPv6 Circuit Connection properties for global reach. Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering Reference to another subresource. SubResource

Ipv6CircuitConnectionConfig

Name Description Value
addressPrefix /125 IP address space to carve out customer addresses for global reach. string

ExpressRouteConnectionId

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Ipv6ExpressRouteCircuitPeeringConfig

Name Description Value
microsoftPeeringConfig Specifies the peering configuration. ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix The primary address prefix. string
routeFilter Reference to another subresource. SubResource
secondaryPeerAddressPrefix The secondary address prefix. string
state The state of peering. 'Disabled'
'Enabled'

ExpressRouteCircuitPeeringConfig

Name Description Value
advertisedCommunities The communities of bgp peering. Specified for microsoft peering. string[]
advertisedPublicPrefixes The reference to AdvertisedPublicPrefixes. string[]
customerASN The CustomerASN of the peering. int
legacyMode The legacy mode of the peering. int
routingRegistryName The RoutingRegistryName of the configuration. string

ExpressRouteCircuitStats

Name Description Value
primarybytesIn The Primary BytesIn of the peering. int
primarybytesOut The primary BytesOut of the peering. int
secondarybytesIn The secondary BytesIn of the peering. int
secondarybytesOut The secondary BytesOut of the peering. int

ExpressRouteCircuitServiceProviderProperties

Name Description Value
bandwidthInMbps The BandwidthInMbps. int
peeringLocation The peering location. string
serviceProviderName The serviceProviderName. string

ExpressRouteCircuitSku

Name Description Value
family The family of the SKU. 'MeteredData'
'UnlimitedData'
name The name of the SKU. string
tier The tier of the SKU. 'Basic'
'Local'
'Premium'
'Standard'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an ExpressRoute Circuit

Deploy to Azure
This template creates an ExpressRoute Circuit for a specified Service Provider and SKU
Create an ExpressRoute Circuit with BGP Peering

Deploy to Azure
This template creates an ExpressRoute Circuit and an AzurePrublicPeering BGP Peering, for a specified Service Provider and SKU
ExpressRoute circuit with private peering and Azure VNet

Deploy to Azure
This template configure ExpressRoute Microsoft peering, deploy an Azure VNet with Expressroute gateway and link the VNet to the ExpressRoute circuit