Module expressroute-circuit

expressRouteCircuit

Property	Value	Description
general (required)	general
sku	sku	The SKU.
allowClassicOperations	bool	Allow classic operations.
authorizationKey	string	The authorizationKey.
authorizations	authorizations[]	The list of authorizations.
bandwidthInGbps	int	The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
circuitProvisioningState	string	The CircuitProvisioningState state of the resource.
enableDirectPortRateLimit	bool	Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
expressRoutePort	expressRoutePort	The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
gatewayManagerEtag	string	The GatewayManager Etag.
globalReachEnabled	bool	Flag denoting global reach status.
peerings	peerings[]	The list of peerings.
serviceKey	string	The ServiceKey.
serviceProviderNotes	string	The ServiceProviderNotes.
serviceProviderProperties	serviceProviderProperties	The ServiceProviderProperties.

sku

Property	Value	Description
family (required)	'MeteredData' 'UnlimitedData'	The family of the SKU.
tier (required)	'Basic' 'Local' 'Premium' 'Standard'	The tier of the SKU.

properties

Property	Value	Description
azureASN	int	The Azure ASN.
connections	connections[]	The list of circuit connections associated with Azure Private Peering for this circuit.
gatewayManagerEtag	string	The GatewayManager Etag.
ipv6PeeringConfig	ipv6PeeringConfig	The IPv6 peering configuration.
microsoftPeeringConfig	microsoftPeeringConfig	The Microsoft peering configuration.
peerASN	int	The peer ASN.
peeringType	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'	The peering type.
primaryAzurePort	string	The primary port.
primaryPeerAddressPrefix	string	The primary address prefix.
routeFilter	routeFilter	The reference to the RouteFilter resource.
secondaryAzurePort	string	The secondary port.
secondaryPeerAddressPrefix	string	The secondary address prefix.
sharedKey	string	The shared key.
state	'Disabled' 'Enabled'	The state of the peering.
vlanId	int	The VLAN ID.

authorizations

Property	Value	Description
id (required)	string	Resource ID.
name (required)	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties (required)	properties	Properties of the express route circuit authorization.

expressRoutePort

Property	Value	Description
id (required)	string	Resource ID.

expressRouteCircuitPeering

Property	Value	Description
id (required)	string	Resource ID.

ipv6CircuitConnectionConfig

Property	Value	Description
addressPrefix (required)	string	/125 IP address space to carve out customer addresses for global reach.

peerExpressRouteCircuitPeering

Property	Value	Description
id (required)	string	Resource ID.

connections

Property	Value	Description
id (required)	string	Resource ID.
name (required)	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties (required)	properties	Properties of the express route circuit connection.

advertisedPublicPrefixInfo

Property	Value	Description
prefix (required)	string	Advertised Public Prefix.
signature (required)	string	Signed string generated by encrypting validationId with a private key.
validationId (required)	string	Validation string that contains circuit peering info.

microsoftPeeringConfig

Property	Value	Description
advertisedCommunities	string[]	The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes	string[]	The reference to AdvertisedPublicPrefixes.
advertisedPublicPrefixInfo	advertisedPublicPrefixInfo[]	List of Prefix information required to perform validation.
customerASN	int	The CustomerASN of the peering.
legacyMode	int	The legacy mode of the peering.
routingRegistryName	string	The RoutingRegistryName of the configuration.

ipv6PeeringConfig

Property	Value	Description
microsoftPeeringConfig (required)	microsoftPeeringConfig	The Microsoft peering configuration.

routeFilter

Property	Value	Description
id (required)	string	Resource ID.

peerings

Property	Value	Description
id (required)	string	Resource ID.
name (required)	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties (required)	properties	Properties of the express route circuit peering.

serviceProviderProperties

Property	Value	Description
bandwidthInMbps (required)	int	The BandwidthInMbps.
peeringLocation (required)	string	The peering location.
serviceProviderName (required)	string	The service provider name.

naming

Property	Value	Description
forceFunctionAsFullName	bool	Use the function value as the full name of the resource
abbreviation	string	Override the abbreviation of this resource with this parameter
environment	string	The resource environment (for example: dev, tst, acc, prd)
location	string	The resource location (for example: weu, we, westeurope)
customer	string	The name of the customer
delimiter	string	The delimiter between resources (default: -)
nameFormat	Array containing any of: 'abbreviation' 'customer' 'environment' 'function' 'location' 'param1' 'param2' 'param3' 'useCaseName'	The order of the array defines the order of elements in the naming scheme
param1	string	Extra parameter self defined
param2	string	Extra parameter self defined
param3	string	Extra parameter self defined
function (required)	string	Function of the resource [can be app, db, security,...]
useCaseName	string	Name of the use case [can be hub, spoke,...]
suffix	string	Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...]
forceDefaultNaming	bool	Force the CAF naming instead of default company naming

resourceLock

Property	Value	Description
name	string	Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period.
level (required)	'CanNotDelete' 'ReadOnly'	The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again
notes	string	Notes about the lock. Maximum of 512 characters.
owners	resourceLockOwner[]	The owners of the lock

resourceLockOwner

Property	Value	Description
applicationId (required)	string	The application ID of the lock owner.

roleAssignment

Property	Value	Description
principalId (required)	string	The principal ID
roleDefinitionId (required)	string	The role definition ID, data file can be used for this
condition	string	Condition on the role assignment
conditionVersion	string	Version of the condition. Currently the only accepted value is "2.0"
delegatedManagedIdentityResourceId	string	Id of the delegated managed identity resource
description	string	Description of role assignment

general

Property	Value	Description
tags	object	Tags of the resource [hashtable]
location (required)	string	Location of the resource
naming (required)	naming	Naming module of the resource
resourceGroupName (required)	string	Name of the resource group where the resource should be located
sharedNaming (required)	naming	Reference to the default naming
roleAssignments	roleAssignment[]	Role assignments on the resource
resourceLocks	resourceLock[]	Resource Locks on the resource

Changelog

1.0.0 (2025-10-13)

⚠ BREAKING CHANGES

• add initial version

Features

• add initial version