Microsoft.Network ExpressRoutePorts 2020-05-01

The ExpressRoutePorts resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Network/ExpressRoutePorts resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Network/ExpressRoutePorts@2020-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  properties: {
    bandwidthInGbps: int
    encapsulation: 'string'
    links: [
        id: 'string'
        name: 'string'
        properties: {
          adminState: 'string'
          macSecConfig: {
            cakSecretIdentifier: 'string'
            cipher: 'string'
            cknSecretIdentifier: 'string'
    peeringLocation: 'string'

Property values


Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
identity Identity for the resource. ManagedServiceIdentity
properties Properties specific to ExpressRoutePort resources. ExpressRoutePortPropertiesFormat


Name Description Value
type The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. 'None'
'SystemAssigned, UserAssigned'
userAssignedIdentities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. object


Name Description Value
bandwidthInGbps Bandwidth of procured ports in Gbps. int
encapsulation Encapsulation method on physical ports. 'Dot1Q'
links The set of physical links of the ExpressRoutePort resource. ExpressRouteLink[]
peeringLocation The name of the peering location that the ExpressRoutePort is mapped to physically. string
Name Description Value
id Resource ID. string
name Name of child port resource that is unique among child port resources of the parent. string
properties Properties specific to ExpressRouteLink resources. ExpressRouteLinkPropertiesFormat


Name Description Value
adminState Administrative state of the physical port. 'Disabled'
macSecConfig ExpressRouteLink Mac Security Configuration. ExpressRouteLinkMacSecConfig


Name Description Value
cakSecretIdentifier Keyvault Secret Identifier URL containing Mac security CAK key. string
cipher Mac security cipher. 'GcmAes128'
cknSecretIdentifier Keyvault Secret Identifier URL containing Mac security CKN key. string