Microsoft.Network expressRouteCircuits 2016-09-01

Article
10/24/2024

Bicep resource definition

The expressRouteCircuits 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/expressRouteCircuits resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/expressRouteCircuits@2016-09-01' = {
  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

AuthorizationPropertiesFormat

Name	Description	Value
authorizationKey	The authorization key.	string
authorizationUseStatus	AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.	'Available' 'InUse'
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and '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	The reference of AdvertisedPublicPrefixes.	string[]
advertisedPublicPrefixesState	AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.	'Configured' 'Configuring' 'NotConfigured' 'ValidationNeeded'
customerASN	The CustomerASN of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCircuitPeeringPropertiesFormat

Name	Description	Value
azureASN	The Azure ASN.	int
gatewayManagerEtag	The GatewayManager Etag.	string
lastModifiedBy	Gets whether the provider or the customer last modified the peering.	string
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int
peeringType	The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryAzurePort	The primary port.	string
primaryPeerAddressPrefix	The primary address prefix.	string
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The state of peering. Possible values are: 'Disabled' and 'Enabled'	'Disabled' 'Enabled'
stats	Gets peering stats.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitPropertiesFormat

Name	Description	Value
allowClassicOperations	Allow classic operations	bool
authorizations	The list of authorizations.	ExpressRouteCircuitAuthorization[]
circuitProvisioningState	The CircuitProvisioningState state of the resource.	string
gatewayManagerEtag	The GatewayManager Etag.	string
peerings	The list of peerings.	ExpressRouteCircuitPeering[]
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
serviceKey	The ServiceKey.	string
serviceProviderNotes	The ServiceProviderNotes.	string
serviceProviderProperties	The ServiceProviderProperties.	ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.	'Deprovisioning' 'NotProvisioned' 'Provisioned' 'Provisioning'

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. Possible values are: 'UnlimitedData' and 'MeteredData'.	'MeteredData' 'UnlimitedData'
name	The name of the SKU.	string
tier	The tier of the SKU. Possible values are 'Standard' and 'Premium'.	'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

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
sku	The SKU.	ExpressRouteCircuitSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceTags

Name	Description	Value

Quickstart samples

The following quickstart samples deploy 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:

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/expressRouteCircuits resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/expressRouteCircuits",
  "apiVersion": "2016-09-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

AuthorizationPropertiesFormat

Name	Description	Value
authorizationKey	The authorization key.	string
authorizationUseStatus	AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.	'Available' 'InUse'
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and '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	The reference of AdvertisedPublicPrefixes.	string[]
advertisedPublicPrefixesState	AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.	'Configured' 'Configuring' 'NotConfigured' 'ValidationNeeded'
customerASN	The CustomerASN of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCircuitPeeringPropertiesFormat

Name	Description	Value
azureASN	The Azure ASN.	int
gatewayManagerEtag	The GatewayManager Etag.	string
lastModifiedBy	Gets whether the provider or the customer last modified the peering.	string
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int
peeringType	The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryAzurePort	The primary port.	string
primaryPeerAddressPrefix	The primary address prefix.	string
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The state of peering. Possible values are: 'Disabled' and 'Enabled'	'Disabled' 'Enabled'
stats	Gets peering stats.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitPropertiesFormat

Name	Description	Value
allowClassicOperations	Allow classic operations	bool
authorizations	The list of authorizations.	ExpressRouteCircuitAuthorization[]
circuitProvisioningState	The CircuitProvisioningState state of the resource.	string
gatewayManagerEtag	The GatewayManager Etag.	string
peerings	The list of peerings.	ExpressRouteCircuitPeering[]
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
serviceKey	The ServiceKey.	string
serviceProviderNotes	The ServiceProviderNotes.	string
serviceProviderProperties	The ServiceProviderProperties.	ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.	'Deprovisioning' 'NotProvisioned' 'Provisioned' 'Provisioning'

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. Possible values are: 'UnlimitedData' and 'MeteredData'.	'MeteredData' 'UnlimitedData'
name	The name of the SKU.	string
tier	The tier of the SKU. Possible values are 'Standard' and 'Premium'.	'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

Microsoft.Network/expressRouteCircuits

Name	Description	Value
apiVersion	The api version	'2016-09-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	The SKU.	ExpressRouteCircuitSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/expressRouteCircuits'

ResourceTags

Name	Description	Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create an ExpressRoute Circuit	This template creates an ExpressRoute Circuit for a specified Service Provider and SKU
Create an ExpressRoute Circuit with BGP Peering	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	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:

Resource groups

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-09-01"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    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

AuthorizationPropertiesFormat

Name	Description	Value
authorizationKey	The authorization key.	string
authorizationUseStatus	AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.	'Available' 'InUse'
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and '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	The reference of AdvertisedPublicPrefixes.	string[]
advertisedPublicPrefixesState	AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.	'Configured' 'Configuring' 'NotConfigured' 'ValidationNeeded'
customerASN	The CustomerASN of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCircuitPeeringPropertiesFormat

Name	Description	Value
azureASN	The Azure ASN.	int
gatewayManagerEtag	The GatewayManager Etag.	string
lastModifiedBy	Gets whether the provider or the customer last modified the peering.	string
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int
peeringType	The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryAzurePort	The primary port.	string
primaryPeerAddressPrefix	The primary address prefix.	string
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The state of peering. Possible values are: 'Disabled' and 'Enabled'	'Disabled' 'Enabled'
stats	Gets peering stats.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitPropertiesFormat

Name	Description	Value
allowClassicOperations	Allow classic operations	bool
authorizations	The list of authorizations.	ExpressRouteCircuitAuthorization[]
circuitProvisioningState	The CircuitProvisioningState state of the resource.	string
gatewayManagerEtag	The GatewayManager Etag.	string
peerings	The list of peerings.	ExpressRouteCircuitPeering[]
provisioningState	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
serviceKey	The ServiceKey.	string
serviceProviderNotes	The ServiceProviderNotes.	string
serviceProviderProperties	The ServiceProviderProperties.	ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.	'Deprovisioning' 'NotProvisioned' 'Provisioned' 'Provisioning'

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. Possible values are: 'UnlimitedData' and 'MeteredData'.	'MeteredData' 'UnlimitedData'
name	The name of the SKU.	string
tier	The tier of the SKU. Possible values are 'Standard' and 'Premium'.	'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

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
sku	The SKU.	ExpressRouteCircuitSku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/expressRouteCircuits@2016-09-01"

ResourceTags

Name	Description	Value

Share via

Microsoft.Network expressRouteCircuits 2016-09-01

Bicep resource definition

Resource format

Property values

AuthorizationPropertiesFormat

ExpressRouteCircuitAuthorization

ExpressRouteCircuitPeering

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPropertiesFormat

ExpressRouteCircuitServiceProviderProperties

ExpressRouteCircuitSku

ExpressRouteCircuitStats

Microsoft.Network/expressRouteCircuits

ResourceTags

Quickstart samples

ARM template resource definition

Resource format

Property values

AuthorizationPropertiesFormat

ExpressRouteCircuitAuthorization

ExpressRouteCircuitPeering

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPropertiesFormat

ExpressRouteCircuitServiceProviderProperties

ExpressRouteCircuitSku

ExpressRouteCircuitStats

Microsoft.Network/expressRouteCircuits

ResourceTags

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

AuthorizationPropertiesFormat

ExpressRouteCircuitAuthorization

ExpressRouteCircuitPeering

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPropertiesFormat

ExpressRouteCircuitServiceProviderProperties

ExpressRouteCircuitSku

ExpressRouteCircuitStats

Microsoft.Network/expressRouteCircuits

ResourceTags

Feedback

Additional resources