Share via

Microsoft.Network expressRouteCircuits 2016-06-01

Bicep resource definition

The expressRouteCircuits resource type can be deployed with operations that target:

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

Resource format

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

resource symbolicname 'Microsoft.Network/expressRouteCircuits@2016-06-01' = {
  scope: resourceSymbolicName or scope
  etag: 'string'
  ___location: 'string'
  name: 'string'
  properties: {
    allowClassicOperations: bool
    authorizations: [
      {
        etag: 'string'
        id: 'string'
        name: 'string'
        properties: {
          authorizationKey: 'string'
          authorizationUseStatus: 'string'
          provisioningState: 'string'
        }
      }
    ]
    circuitProvisioningState: 'string'
    gatewayManagerEtag: 'string'
    peerings: [
      {
        etag: 'string'
        id: 'string'
        name: 'string'
        properties: {
          azureASN: int
          gatewayManagerEtag: 'string'
          lastModifiedBy: 'string'
          microsoftPeeringConfig: {
            advertisedPublicPrefixes: [
              'string'
            ]
            advertisedPublicPrefixesState: 'string'
            customerASN: int
            routingRegistryName: 'string'
          }
          peerASN: int
          peeringType: 'string'
          primaryAzurePort: 'string'
          primaryPeerAddressPrefix: 'string'
          provisioningState: 'string'
          secondaryAzurePort: 'string'
          secondaryPeerAddressPrefix: 'string'
          sharedKey: 'string'
          state: 'string'
          stats: {
            primarybytesIn: int
            primarybytesOut: int
            secondarybytesIn: int
            secondarybytesOut: int
          }
          vlanId: int
        }
      }
    ]
    provisioningState: 'string'
    serviceKey: 'string'
    serviceProviderNotes: 'string'
    serviceProviderProperties: {
      bandwidthInMbps: int
      peeringLocation: 'string'
      serviceProviderName: 'string'
    }
    serviceProviderProvisioningState: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/expressRouteCircuits

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
___location Resource ___location string
name The resource name string (required)
properties Properties of ExpressRouteCircuit ExpressRouteCircuitPropertiesFormat
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
sku Gets or sets sku ExpressRouteCircuitSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

AuthorizationPropertiesFormat

Name Description Value
authorizationKey Gets or sets the authorization key string
authorizationUseStatus Gets or sets AuthorizationUseStatus 'Available'
'InUse'
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string

ExpressRouteCircuitAuthorization

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties AuthorizationPropertiesFormat

ExpressRouteCircuitPeering

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

Name Description Value
advertisedPublicPrefixes Gets or sets the reference of AdvertisedPublicPrefixes string[]
advertisedPublicPrefixesState Gets or sets AdvertisedPublicPrefixState of the Peering resource 'Configured'
'Configuring'
'NotConfigured'
'ValidationNeeded'
customerASN Gets or Sets CustomerAsn of the peering. int
routingRegistryName Gets or Sets RoutingRegistryName of the config. string

ExpressRouteCircuitPeeringPropertiesFormat

Name Description Value
azureASN Gets or sets the azure ASN int
gatewayManagerEtag Gets or sets the GatewayManager Etag string
lastModifiedBy Gets whether the provider or the customer last modified the peering string
microsoftPeeringConfig Gets or sets the Microsoft peering config ExpressRouteCircuitPeeringConfig
peerASN Gets or sets the peer ASN int
peeringType Gets or sets PeeringType 'AzurePrivatePeering'
'AzurePublicPeering'
'MicrosoftPeering'
primaryAzurePort Gets or sets the primary port string
primaryPeerAddressPrefix Gets or sets the primary address prefix string
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
secondaryAzurePort Gets or sets the secondary port string
secondaryPeerAddressPrefix Gets or sets the secondary address prefix string
sharedKey Gets or sets the shared key string
state Gets or sets state of Peering 'Disabled'
'Enabled'
stats Gets or peering stats ExpressRouteCircuitStats
vlanId Gets or sets the vlan id int

ExpressRouteCircuitPropertiesFormat

Name Description Value
allowClassicOperations allow classic operations bool
authorizations Gets or sets list of authorizations ExpressRouteCircuitAuthorization[]
circuitProvisioningState Gets or sets CircuitProvisioningState state of the resource string
gatewayManagerEtag Gets or sets the GatewayManager Etag string
peerings Gets or sets list of peerings ExpressRouteCircuitPeering[]
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
serviceKey Gets or sets ServiceKey string
serviceProviderNotes Gets or sets ServiceProviderNotes string
serviceProviderProperties Gets or sets ServiceProviderProperties ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState Gets or sets ServiceProviderProvisioningState state of the resource 'Deprovisioning'
'NotProvisioned'
'Provisioned'
'Provisioning'

ExpressRouteCircuitServiceProviderProperties

Name Description Value
bandwidthInMbps Gets or sets BandwidthInMbps. int
peeringLocation Gets or sets peering ___location. string
serviceProviderName Gets or sets serviceProviderName. string

ExpressRouteCircuitSku

Name Description Value
family Gets or sets family of the sku. 'MeteredData'
'UnlimitedData'
name Gets or sets name of the sku. string
tier Gets or sets tier of the sku. 'Premium'
'Standard'

ExpressRouteCircuitStats

Name Description Value
primarybytesIn Gets BytesIn of the peering. int
primarybytesOut Gets BytesOut of the peering. int
secondarybytesIn Gets BytesIn of the peering. int
secondarybytesOut Gets BytesOut of the peering. int

ResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
ExpressRoute Circuit AVM Resource Module for ExpressRoute Circuit

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create an ExpressRoute Circuit This template creates an ExpressRoute Circuit for a specified Service Provider and SKU
ExpressRoute circuit with private peering and Azure VNet This template configure ExpressRoute Microsoft peering, deploy an Azure VNet with Expressroute gateway and link the VNet to the ExpressRoute circuit

ARM template resource definition

The expressRouteCircuits resource type can be deployed with operations that target:

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

Resource format

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

{
  "type": "Microsoft.Network/expressRouteCircuits",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "___location": "string",
  "properties": {
    "allowClassicOperations": "bool",
    "authorizations": [
      {
        "etag": "string",
        "id": "string",
        "name": "string",
        "properties": {
          "authorizationKey": "string",
          "authorizationUseStatus": "string",
          "provisioningState": "string"
        }
      }
    ],
    "circuitProvisioningState": "string",
    "gatewayManagerEtag": "string",
    "peerings": [
      {
        "etag": "string",
        "id": "string",
        "name": "string",
        "properties": {
          "azureASN": "int",
          "gatewayManagerEtag": "string",
          "lastModifiedBy": "string",
          "microsoftPeeringConfig": {
            "advertisedPublicPrefixes": [ "string" ],
            "advertisedPublicPrefixesState": "string",
            "customerASN": "int",
            "routingRegistryName": "string"
          },
          "peerASN": "int",
          "peeringType": "string",
          "primaryAzurePort": "string",
          "primaryPeerAddressPrefix": "string",
          "provisioningState": "string",
          "secondaryAzurePort": "string",
          "secondaryPeerAddressPrefix": "string",
          "sharedKey": "string",
          "state": "string",
          "stats": {
            "primarybytesIn": "int",
            "primarybytesOut": "int",
            "secondarybytesIn": "int",
            "secondarybytesOut": "int"
          },
          "vlanId": "int"
        }
      }
    ],
    "provisioningState": "string",
    "serviceKey": "string",
    "serviceProviderNotes": "string",
    "serviceProviderProperties": {
      "bandwidthInMbps": "int",
      "peeringLocation": "string",
      "serviceProviderName": "string"
    },
    "serviceProviderProvisioningState": "string"
  },
  "sku": {
    "family": "string",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/expressRouteCircuits

Name Description Value
apiVersion The api version '2016-06-01'
etag Gets a unique read-only string that changes whenever the resource is updated string
___location Resource ___location string
name The resource name string (required)
properties Properties of ExpressRouteCircuit ExpressRouteCircuitPropertiesFormat
sku Gets or sets sku ExpressRouteCircuitSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/expressRouteCircuits'

AuthorizationPropertiesFormat

Name Description Value
authorizationKey Gets or sets the authorization key string
authorizationUseStatus Gets or sets AuthorizationUseStatus 'Available'
'InUse'
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string

ExpressRouteCircuitAuthorization

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties AuthorizationPropertiesFormat

ExpressRouteCircuitPeering

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

Name Description Value
advertisedPublicPrefixes Gets or sets the reference of AdvertisedPublicPrefixes string[]
advertisedPublicPrefixesState Gets or sets AdvertisedPublicPrefixState of the Peering resource 'Configured'
'Configuring'
'NotConfigured'
'ValidationNeeded'
customerASN Gets or Sets CustomerAsn of the peering. int
routingRegistryName Gets or Sets RoutingRegistryName of the config. string

ExpressRouteCircuitPeeringPropertiesFormat

Name Description Value
azureASN Gets or sets the azure ASN int
gatewayManagerEtag Gets or sets the GatewayManager Etag string
lastModifiedBy Gets whether the provider or the customer last modified the peering string
microsoftPeeringConfig Gets or sets the Microsoft peering config ExpressRouteCircuitPeeringConfig
peerASN Gets or sets the peer ASN int
peeringType Gets or sets PeeringType 'AzurePrivatePeering'
'AzurePublicPeering'
'MicrosoftPeering'
primaryAzurePort Gets or sets the primary port string
primaryPeerAddressPrefix Gets or sets the primary address prefix string
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
secondaryAzurePort Gets or sets the secondary port string
secondaryPeerAddressPrefix Gets or sets the secondary address prefix string
sharedKey Gets or sets the shared key string
state Gets or sets state of Peering 'Disabled'
'Enabled'
stats Gets or peering stats ExpressRouteCircuitStats
vlanId Gets or sets the vlan id int

ExpressRouteCircuitPropertiesFormat

Name Description Value
allowClassicOperations allow classic operations bool
authorizations Gets or sets list of authorizations ExpressRouteCircuitAuthorization[]
circuitProvisioningState Gets or sets CircuitProvisioningState state of the resource string
gatewayManagerEtag Gets or sets the GatewayManager Etag string
peerings Gets or sets list of peerings ExpressRouteCircuitPeering[]
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
serviceKey Gets or sets ServiceKey string
serviceProviderNotes Gets or sets ServiceProviderNotes string
serviceProviderProperties Gets or sets ServiceProviderProperties ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState Gets or sets ServiceProviderProvisioningState state of the resource 'Deprovisioning'
'NotProvisioned'
'Provisioned'
'Provisioning'

ExpressRouteCircuitServiceProviderProperties

Name Description Value
bandwidthInMbps Gets or sets BandwidthInMbps. int
peeringLocation Gets or sets peering ___location. string
serviceProviderName Gets or sets serviceProviderName. string

ExpressRouteCircuitSku

Name Description Value
family Gets or sets family of the sku. 'MeteredData'
'UnlimitedData'
name Gets or sets name of the sku. string
tier Gets or sets tier of the sku. 'Premium'
'Standard'

ExpressRouteCircuitStats

Name Description Value
primarybytesIn Gets BytesIn of the peering. int
primarybytesOut Gets BytesOut of the peering. int
secondarybytesIn Gets BytesIn of the peering. int
secondarybytesOut Gets BytesOut of the peering. int

ResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure 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

Terraform (AzAPI provider) resource definition

The expressRouteCircuits resource type can be deployed with operations that target:

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits@2016-06-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      allowClassicOperations = bool
      authorizations = [
        {
          etag = "string"
          id = "string"
          name = "string"
          properties = {
            authorizationKey = "string"
            authorizationUseStatus = "string"
            provisioningState = "string"
          }
        }
      ]
      circuitProvisioningState = "string"
      gatewayManagerEtag = "string"
      peerings = [
        {
          etag = "string"
          id = "string"
          name = "string"
          properties = {
            azureASN = int
            gatewayManagerEtag = "string"
            lastModifiedBy = "string"
            microsoftPeeringConfig = {
              advertisedPublicPrefixes = [
                "string"
              ]
              advertisedPublicPrefixesState = "string"
              customerASN = int
              routingRegistryName = "string"
            }
            peerASN = int
            peeringType = "string"
            primaryAzurePort = "string"
            primaryPeerAddressPrefix = "string"
            provisioningState = "string"
            secondaryAzurePort = "string"
            secondaryPeerAddressPrefix = "string"
            sharedKey = "string"
            state = "string"
            stats = {
              primarybytesIn = int
              primarybytesOut = int
              secondarybytesIn = int
              secondarybytesOut = int
            }
            vlanId = int
          }
        }
      ]
      provisioningState = "string"
      serviceKey = "string"
      serviceProviderNotes = "string"
      serviceProviderProperties = {
        bandwidthInMbps = int
        peeringLocation = "string"
        serviceProviderName = "string"
      }
      serviceProviderProvisioningState = "string"
    }
    sku = {
      family = "string"
      name = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.Network/expressRouteCircuits

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
___location Resource ___location string
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties Properties of ExpressRouteCircuit ExpressRouteCircuitPropertiesFormat
sku Gets or sets sku ExpressRouteCircuitSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/expressRouteCircuits@2016-06-01"

AuthorizationPropertiesFormat

Name Description Value
authorizationKey Gets or sets the authorization key string
authorizationUseStatus Gets or sets AuthorizationUseStatus 'Available'
'InUse'
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string

ExpressRouteCircuitAuthorization

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties AuthorizationPropertiesFormat

ExpressRouteCircuitPeering

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

Name Description Value
advertisedPublicPrefixes Gets or sets the reference of AdvertisedPublicPrefixes string[]
advertisedPublicPrefixesState Gets or sets AdvertisedPublicPrefixState of the Peering resource 'Configured'
'Configuring'
'NotConfigured'
'ValidationNeeded'
customerASN Gets or Sets CustomerAsn of the peering. int
routingRegistryName Gets or Sets RoutingRegistryName of the config. string

ExpressRouteCircuitPeeringPropertiesFormat

Name Description Value
azureASN Gets or sets the azure ASN int
gatewayManagerEtag Gets or sets the GatewayManager Etag string
lastModifiedBy Gets whether the provider or the customer last modified the peering string
microsoftPeeringConfig Gets or sets the Microsoft peering config ExpressRouteCircuitPeeringConfig
peerASN Gets or sets the peer ASN int
peeringType Gets or sets PeeringType 'AzurePrivatePeering'
'AzurePublicPeering'
'MicrosoftPeering'
primaryAzurePort Gets or sets the primary port string
primaryPeerAddressPrefix Gets or sets the primary address prefix string
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
secondaryAzurePort Gets or sets the secondary port string
secondaryPeerAddressPrefix Gets or sets the secondary address prefix string
sharedKey Gets or sets the shared key string
state Gets or sets state of Peering 'Disabled'
'Enabled'
stats Gets or peering stats ExpressRouteCircuitStats
vlanId Gets or sets the vlan id int

ExpressRouteCircuitPropertiesFormat

Name Description Value
allowClassicOperations allow classic operations bool
authorizations Gets or sets list of authorizations ExpressRouteCircuitAuthorization[]
circuitProvisioningState Gets or sets CircuitProvisioningState state of the resource string
gatewayManagerEtag Gets or sets the GatewayManager Etag string
peerings Gets or sets list of peerings ExpressRouteCircuitPeering[]
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
serviceKey Gets or sets ServiceKey string
serviceProviderNotes Gets or sets ServiceProviderNotes string
serviceProviderProperties Gets or sets ServiceProviderProperties ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState Gets or sets ServiceProviderProvisioningState state of the resource 'Deprovisioning'
'NotProvisioned'
'Provisioned'
'Provisioning'

ExpressRouteCircuitServiceProviderProperties

Name Description Value
bandwidthInMbps Gets or sets BandwidthInMbps. int
peeringLocation Gets or sets peering ___location. string
serviceProviderName Gets or sets serviceProviderName. string

ExpressRouteCircuitSku

Name Description Value
family Gets or sets family of the sku. 'MeteredData'
'UnlimitedData'
name Gets or sets name of the sku. string
tier Gets or sets tier of the sku. 'Premium'
'Standard'

ExpressRouteCircuitStats

Name Description Value
primarybytesIn Gets BytesIn of the peering. int
primarybytesOut Gets BytesOut of the peering. int
secondarybytesIn Gets BytesIn of the peering. int
secondarybytesOut Gets BytesOut of the peering. int

ResourceTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying ExpressRoute circuit.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "ExpressRoutePort" {
  type      = "Microsoft.Network/ExpressRoutePorts@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      bandwidthInGbps = 10
      encapsulation   = "Dot1Q"
      peeringLocation = "CDC-Canberra"
    }
  }
  schema_validation_enabled = false
  ignore_casing             = true
  response_export_values    = ["*"]
}

resource "azapi_resource" "expressRouteCircuit" {
  type      = "Microsoft.Network/expressRouteCircuits@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      authorizationKey = ""
      bandwidthInGbps  = 5
      expressRoutePort = {
        id = azapi_resource.ExpressRoutePort.id
      }
    }
    sku = {
      family = "MeteredData"
      name   = "Premium_MeteredData"
      tier   = "Premium"
    }
  }
  schema_validation_enabled = false
  ignore_casing             = true
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
ExpressRoute Circuit AVM Resource Module for ExpressRoute Circuit