Microsoft.Network ExpressRoutePorts 2021-08-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/ExpressRoutePorts@2021-08-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'
            sciState: 'string'
          }
        }
      }
    ]
    peeringLocation: 'string'
  }
}

Property values

ExpressRoutePorts

Name Description Value
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
identity The identity of ExpressRoutePort, if configured. ManagedServiceIdentity
properties ExpressRoutePort properties. ExpressRoutePortPropertiesFormat

ManagedServiceIdentity

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'
'SystemAssigned, UserAssigned'
'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

ExpressRoutePortPropertiesFormat

Name Description Value
bandwidthInGbps Bandwidth of procured ports in Gbps. int
encapsulation Encapsulation method on physical ports. 'Dot1Q'
'QinQ'
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 ExpressRouteLink properties. ExpressRouteLinkPropertiesFormat

ExpressRouteLinkPropertiesFormat

Name Description Value
adminState Administrative state of the physical port. 'Disabled'
'Enabled'
macSecConfig MacSec configuration. ExpressRouteLinkMacSecConfig

ExpressRouteLinkMacSecConfig

Name Description Value
cakSecretIdentifier Keyvault Secret Identifier URL containing Mac security CAK key. string
cipher Mac security cipher. 'GcmAes128'
'GcmAes256'
'GcmAesXpn128'
'GcmAesXpn256'
cknSecretIdentifier Keyvault Secret Identifier URL containing Mac security CKN key. string
sciState Sci mode enabled/disabled. 'Disabled'
'Enabled'

ARM template resource definition

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

{
  "type": "Microsoft.Network/ExpressRoutePorts",
  "apiVersion": "2021-08-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",
            "sciState": "string"
          }
        }
      }
    ],
    "peeringLocation": "string"
  }
}

Property values

ExpressRoutePorts

Name Description Value
type The resource type 'Microsoft.Network/ExpressRoutePorts'
apiVersion The resource api version '2021-08-01'
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
identity The identity of ExpressRoutePort, if configured. ManagedServiceIdentity
properties ExpressRoutePort properties. ExpressRoutePortPropertiesFormat

ManagedServiceIdentity

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'
'SystemAssigned, UserAssigned'
'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

ExpressRoutePortPropertiesFormat

Name Description Value
bandwidthInGbps Bandwidth of procured ports in Gbps. int
encapsulation Encapsulation method on physical ports. 'Dot1Q'
'QinQ'
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 ExpressRouteLink properties. ExpressRouteLinkPropertiesFormat

ExpressRouteLinkPropertiesFormat

Name Description Value
adminState Administrative state of the physical port. 'Disabled'
'Enabled'
macSecConfig MacSec configuration. ExpressRouteLinkMacSecConfig

ExpressRouteLinkMacSecConfig

Name Description Value
cakSecretIdentifier Keyvault Secret Identifier URL containing Mac security CAK key. string
cipher Mac security cipher. 'GcmAes128'
'GcmAes256'
'GcmAesXpn128'
'GcmAesXpn256'
cknSecretIdentifier Keyvault Secret Identifier URL containing Mac security CKN key. string
sciState Sci mode enabled/disabled. 'Disabled'
'Enabled'

Terraform (AzAPI provider) resource definition

The ExpressRoutePorts 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/ExpressRoutePorts resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/ExpressRoutePorts@2021-08-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      bandwidthInGbps = int
      encapsulation = "string"
      links = [
        {
          id = "string"
          name = "string"
          properties = {
            adminState = "string"
            macSecConfig = {
              cakSecretIdentifier = "string"
              cipher = "string"
              cknSecretIdentifier = "string"
              sciState = "string"
            }
          }
        }
      ]
      peeringLocation = "string"
    }
  })
}

Property values

ExpressRoutePorts

Name Description Value
type The resource type "Microsoft.Network/ExpressRoutePorts@2021-08-01"
name The resource name string (required)
location Resource location. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
identity The identity of ExpressRoutePort, if configured. ManagedServiceIdentity
properties ExpressRoutePort properties. ExpressRoutePortPropertiesFormat

ManagedServiceIdentity

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. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids 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}'. Array of user identity IDs.

ExpressRoutePortPropertiesFormat

Name Description Value
bandwidthInGbps Bandwidth of procured ports in Gbps. int
encapsulation Encapsulation method on physical ports. "Dot1Q"
"QinQ"
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 ExpressRouteLink properties. ExpressRouteLinkPropertiesFormat

ExpressRouteLinkPropertiesFormat

Name Description Value
adminState Administrative state of the physical port. "Disabled"
"Enabled"
macSecConfig MacSec configuration. ExpressRouteLinkMacSecConfig

ExpressRouteLinkMacSecConfig

Name Description Value
cakSecretIdentifier Keyvault Secret Identifier URL containing Mac security CAK key. string
cipher Mac security cipher. "GcmAes128"
"GcmAes256"
"GcmAesXpn128"
"GcmAesXpn256"
cknSecretIdentifier Keyvault Secret Identifier URL containing Mac security CKN key. string
sciState Sci mode enabled/disabled. "Disabled"
"Enabled"