An ExpressRoute circuit is a dedicated link to Azure to provide communication with Azure services without traversing the Internet. It requires some coordination with a networking provider for these circuits, so some information, such as the service provider and peering location must be obtained from Azure reference documentation. The ExpressRoute builder creates an ExpressRoute circuit and enables Azure private peering and Microsoft peering.

  • ExpressRoute Namespace (Microsoft.Network/expressRouteCircuits)

ExpressRoute Builder (expressRoute)

service_providerConnectivity service provider from Azure reference documentation
peering_locationConnectivity peering location from Azure reference documentation
tierStandard or Premium
familyMetered or Unlimited data
bandwidthBandwidth in Mbps for the circuit
add_authorizationsAdds names of authorization keys to be created on the new circuit.
add_peeringsAdds peering details for the circuit - can add Azure Private and Microsoft peerings

ExpressRoute Peering Builder (peering)

| Applies To | Keyword | Purpose | |-|-| | peering_type | A network CIDR block of 4 IP addresses (/30) for the ExpressRoute primary circuit | | peer_asn | Peer Autonomous System Number - this is a uniquely assigned number for the peer network, typically provided by the service provider in agreement with Microsoft | | azure_asn | Azure Autonomous System Number - Microsoft oftent uses AS 12076 for Azure public, Azure private and Microsoft peering | | primary_prefix | A network CIDR block of 4 IP addresses (/30) for the ExpressRoute primary circuit | | secondary_prefix | A network CIDR block of 4 IP addresses (/30) for the ExpressRoute secondary circuit | | vlan | A unique VLAN ID for the peering | | shared_key | An optional shared key the service provider may specify for the peering |

Configuration Members

ServiceKeyAn ARM expression path to get the service key on the newly created circuit.
AuthorizationKeyAn ARM expression path to get an authorization key by name.


open Farmer
open Farmer.Builders
open Farmer.ExpressRoute

let circuit = expressRoute {
    name "my-express-route"
    service_provider "Equinix"
    peering_location "New York"
    tier Premium
    family MeteredData
    bandwidth 1000<Mbps>
    add_authorizations [
    add_peerings [
        peering {
            peering_type AzurePrivatePeering
            peer_asn 55277L
            azure_asn 12076
            primary_prefix (IPAddressCidr.parse "")
            secondary_prefix (IPAddressCidr.parse "")
            vlan 2406

arm {
    add_resource circuit
    output "er-service-key" circuit.ServiceKey
    output "auth-key" (er.AuthorizationKey "authkey1")