Microsoft.Network expressRouteCircuits/peerings

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/expressRouteCircuits/peerings@2025-01-01' = {
  parent: resourceSymbolicName
  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'
        ]
        advertisedPublicPrefixInfo: [
          {
            prefix: 'string'
            signature: 'string'
            validationId: 'string'
          }
        ]
        customerASN: int
        legacyMode: int
        routingRegistryName: 'string'
      }
      primaryPeerAddressPrefix: 'string'
      routeFilter: {
        id: 'string'
      }
      secondaryPeerAddressPrefix: 'string'
      state: 'string'
    }
    microsoftPeeringConfig: {
      advertisedCommunities: [
        'string'
      ]
      advertisedPublicPrefixes: [
        'string'
      ]
      advertisedPublicPrefixInfo: [
        {
          prefix: 'string'
          signature: 'string'
          validationId: '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
  }
}

Property Values

Microsoft.Network/expressRouteCircuits/peerings

AdvertisedPublicPrefixProperties

ExpressRouteCircuitConnection

ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitStats

ExpressRouteConnectionId

Ipv6CircuitConnectionConfig

Ipv6ExpressRouteCircuitPeeringConfig

SubResource

Usage Examples

Azure Quickstart Samples

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

ARM template resource definition

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

{
  "type": "Microsoft.Network/expressRouteCircuits/peerings",
  "apiVersion": "2025-01-01",
  "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" ],
        "advertisedPublicPrefixInfo": [
          {
            "prefix": "string",
            "signature": "string",
            "validationId": "string"
          }
        ],
        "customerASN": "int",
        "legacyMode": "int",
        "routingRegistryName": "string"
      },
      "primaryPeerAddressPrefix": "string",
      "routeFilter": {
        "id": "string"
      },
      "secondaryPeerAddressPrefix": "string",
      "state": "string"
    },
    "microsoftPeeringConfig": {
      "advertisedCommunities": [ "string" ],
      "advertisedPublicPrefixes": [ "string" ],
      "advertisedPublicPrefixInfo": [
        {
          "prefix": "string",
          "signature": "string",
          "validationId": "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"
  }
}

Property Values

Microsoft.Network/expressRouteCircuits/peerings

AdvertisedPublicPrefixProperties

ExpressRouteCircuitConnection

ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitStats

ExpressRouteConnectionId

Ipv6CircuitConnectionConfig

Ipv6ExpressRouteCircuitPeeringConfig

SubResource

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
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/peerings 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/peerings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits/peerings@2025-01-01"
  name = "string"
  parent_id = "string"
  body = {
    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"
          ]
          advertisedPublicPrefixInfo = [
            {
              prefix = "string"
              signature = "string"
              validationId = "string"
            }
          ]
          customerASN = int
          legacyMode = int
          routingRegistryName = "string"
        }
        primaryPeerAddressPrefix = "string"
        routeFilter = {
          id = "string"
        }
        secondaryPeerAddressPrefix = "string"
        state = "string"
      }
      microsoftPeeringConfig = {
        advertisedCommunities = [
          "string"
        ]
        advertisedPublicPrefixes = [
          "string"
        ]
        advertisedPublicPrefixInfo = [
          {
            prefix = "string"
            signature = "string"
            validationId = "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
    }
  }
}

Property Values

Microsoft.Network/expressRouteCircuits/peerings

AdvertisedPublicPrefixProperties

ExpressRouteCircuitConnection

ExpressRouteCircuitConnectionPropertiesFormat

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitStats

ExpressRouteConnectionId

Ipv6CircuitConnectionConfig

Ipv6ExpressRouteCircuitPeeringConfig

SubResource

Usage Examples

Terraform Samples

A basic example of deploying ExpressRoute Circuit Peering.

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"
}

variable "express_route_shared_key" {
  type        = string
  description = "The shared key for the Express Route circuit peering"
  sensitive   = true
}

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
  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    = ["*"]
}

resource "azapi_resource" "peering" {
  type      = "Microsoft.Network/expressRouteCircuits/peerings@2022-07-01"
  parent_id = azapi_resource.expressRouteCircuit.id
  name      = "AzurePrivatePeering"
  body = {
    properties = {
      azureASN                   = 12076
      gatewayManagerEtag         = ""
      peerASN                    = 100
      peeringType                = "AzurePrivatePeering"
      primaryPeerAddressPrefix   = "192.168.1.0/30"
      secondaryPeerAddressPrefix = "192.168.2.0/30"
      sharedKey                  = var.express_route_shared_key
      state                      = "Enabled"
      vlanId                     = 100
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}