Microsoft.Network expressRouteCircuits 2020-08-01

• Latest
• 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
• 2018-07-01
• 2018-06-01
• 2018-04-01
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01
• 2017-03-30
• 2017-03-01
• 2016-12-01
• 2016-09-01
• 2016-06-01
• 2016-03-30
• 2015-06-15
• 2015-05-01-preview

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@2020-08-01' = {
  location: 'string'
  name: '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'
  }
  sku: {
    family: 'string'
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AuthorizationPropertiesFormat

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

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 the express route circuit authorization.	AuthorizationPropertiesFormat

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 Express Route Circuit Private Peering Resource of the circuit initiating connection.	SubResource
ipv6CircuitConnectionConfig	IPv6 Address PrefixProperties of the express route circuit connection.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Reference to Express Route Circuit Private Peering Resource of the peered circuit.	SubResource

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

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

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 ExpressRoute connection.	ExpressRouteConnectionId
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryAzurePort	The primary port.	string
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
stats	The peering stats of express route circuit.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

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	The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.	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	The ServiceProviderProperties.	ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource.	'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.	'MeteredData' 'UnlimitedData'
name	The name of the SKU.	string
tier	The tier of the SKU.	'Basic' 'Local' 'Premium' 'Standard'

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

ExpressRouteConnectionId

Name	Description	Value

Ipv6CircuitConnectionConfig

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

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCircuits

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route circuit.	ExpressRouteCircuitPropertiesFormat
sku	The SKU.	ExpressRouteCircuitSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string

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": "2020-08-01",
  "name": "string",
  "location": "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"
  },
  "sku": {
    "family": "string",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AuthorizationPropertiesFormat

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

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 the express route circuit authorization.	AuthorizationPropertiesFormat

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 Express Route Circuit Private Peering Resource of the circuit initiating connection.	SubResource
ipv6CircuitConnectionConfig	IPv6 Address PrefixProperties of the express route circuit connection.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Reference to Express Route Circuit Private Peering Resource of the peered circuit.	SubResource

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

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

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 ExpressRoute connection.	ExpressRouteConnectionId
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryAzurePort	The primary port.	string
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
stats	The peering stats of express route circuit.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

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	The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.	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	The ServiceProviderProperties.	ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource.	'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.	'MeteredData' 'UnlimitedData'
name	The name of the SKU.	string
tier	The tier of the SKU.	'Basic' 'Local' 'Premium' 'Standard'

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

ExpressRouteConnectionId

Name	Description	Value

Ipv6CircuitConnectionConfig

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

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCircuits

Name	Description	Value
apiVersion	The api version	'2020-08-01'
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route circuit.	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

SubResource

Name	Description	Value
id	Resource ID.	string

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@2020-08-01"
  name = "string"
  location = "string"
  sku = {
    family = "string"
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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

AuthorizationPropertiesFormat

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

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 the express route circuit authorization.	AuthorizationPropertiesFormat

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 Express Route Circuit Private Peering Resource of the circuit initiating connection.	SubResource
ipv6CircuitConnectionConfig	IPv6 Address PrefixProperties of the express route circuit connection.	Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering	Reference to Express Route Circuit Private Peering Resource of the peered circuit.	SubResource

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

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

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 ExpressRoute connection.	ExpressRouteConnectionId
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryAzurePort	The primary port.	string
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
stats	The peering stats of express route circuit.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

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	The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.	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	The ServiceProviderProperties.	ExpressRouteCircuitServiceProviderProperties
serviceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource.	'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.	'MeteredData' 'UnlimitedData'
name	The name of the SKU.	string
tier	The tier of the SKU.	'Basic' 'Local' 'Premium' 'Standard'

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

ExpressRouteConnectionId

Name	Description	Value

Ipv6CircuitConnectionConfig

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

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCircuits

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route circuit.	ExpressRouteCircuitPropertiesFormat
sku	The SKU.	ExpressRouteCircuitSku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/expressRouteCircuits@2020-08-01"

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string