Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-01-01
- 2024-10-01
- 2024-07-01
- 2024-05-01
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-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@2022-07-01' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  ___location: 'string'
  name: 'string'
  properties: {
    bandwidthInGbps: int
    billingType: 'string'
    encapsulation: 'string'
    links: [
      {
        id: 'string'
        name: 'string'
        properties: {
          adminState: 'string'
          macSecConfig: {
            cakSecretIdentifier: 'string'
            cipher: 'string'
            cknSecretIdentifier: 'string'
            sciState: 'string'
          }
        }
      }
    ]
    peeringLocation: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}
Property Values
Microsoft.Network/ExpressRoutePorts
| Name | Description | Value | 
|---|---|---|
| identity | The identity of ExpressRoutePort, if configured. | ManagedServiceIdentity | 
| ___location | Resource ___location. | string | 
| name | The resource name | string (required) | 
| properties | ExpressRoutePort properties. | ExpressRoutePortPropertiesFormat | 
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. | 
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates | 
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Name | Description | Value | 
|---|
ExpressRouteLink
| 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 | 
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' | 
ExpressRouteLinkPropertiesFormat
| Name | Description | Value | 
|---|---|---|
| adminState | Administrative state of the physical port. | 'Disabled' 'Enabled' | 
| macSecConfig | MacSec configuration. | ExpressRouteLinkMacSecConfig | 
ExpressRoutePortPropertiesFormat
| Name | Description | Value | 
|---|---|---|
| bandwidthInGbps | Bandwidth of procured ports in Gbps. | int | 
| billingType | The billing type of the ExpressRoutePort resource. | 'MeteredData' 'UnlimitedData' | 
| 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 | 
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}'. | ManagedServiceIdentityUserAssignedIdentities | 
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value | 
|---|
ResourceTags
| Name | Description | Value | 
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description | 
|---|---|
| ExpressRoute Port | AVM Resource Module for ExpressRoute Port | 
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": "2022-07-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "___location": "string",
  "properties": {
    "bandwidthInGbps": "int",
    "billingType": "string",
    "encapsulation": "string",
    "links": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "adminState": "string",
          "macSecConfig": {
            "cakSecretIdentifier": "string",
            "cipher": "string",
            "cknSecretIdentifier": "string",
            "sciState": "string"
          }
        }
      }
    ],
    "peeringLocation": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}
Property Values
Microsoft.Network/ExpressRoutePorts
| Name | Description | Value | 
|---|---|---|
| apiVersion | The api version | '2022-07-01' | 
| identity | The identity of ExpressRoutePort, if configured. | ManagedServiceIdentity | 
| ___location | Resource ___location. | string | 
| name | The resource name | string (required) | 
| properties | ExpressRoutePort properties. | ExpressRoutePortPropertiesFormat | 
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates | 
| type | The resource type | 'Microsoft.Network/ExpressRoutePorts' | 
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Name | Description | Value | 
|---|
ExpressRouteLink
| 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 | 
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' | 
ExpressRouteLinkPropertiesFormat
| Name | Description | Value | 
|---|---|---|
| adminState | Administrative state of the physical port. | 'Disabled' 'Enabled' | 
| macSecConfig | MacSec configuration. | ExpressRouteLinkMacSecConfig | 
ExpressRoutePortPropertiesFormat
| Name | Description | Value | 
|---|---|---|
| bandwidthInGbps | Bandwidth of procured ports in Gbps. | int | 
| billingType | The billing type of the ExpressRoutePort resource. | 'MeteredData' 'UnlimitedData' | 
| 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 | 
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}'. | ManagedServiceIdentityUserAssignedIdentities | 
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value | 
|---|
ResourceTags
| Name | Description | Value | 
|---|
Usage Examples
Terraform (AzAPI provider) 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 Terraform to your template.
resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/ExpressRoutePorts@2022-07-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      bandwidthInGbps = int
      billingType = "string"
      encapsulation = "string"
      links = [
        {
          id = "string"
          name = "string"
          properties = {
            adminState = "string"
            macSecConfig = {
              cakSecretIdentifier = "string"
              cipher = "string"
              cknSecretIdentifier = "string"
              sciState = "string"
            }
          }
        }
      ]
      peeringLocation = "string"
    }
  }
}
Property Values
Microsoft.Network/ExpressRoutePorts
| Name | Description | Value | 
|---|---|---|
| identity | The identity of ExpressRoutePort, if configured. | ManagedServiceIdentity | 
| ___location | Resource ___location. | string | 
| name | The resource name | string (required) | 
| parent_id | The ID of the resource to apply this extension resource to. | string (required) | 
| properties | ExpressRoutePort properties. | ExpressRoutePortPropertiesFormat | 
| tags | Resource tags | Dictionary of tag names and values. | 
| type | The resource type | "Microsoft.Network/ExpressRoutePorts@2022-07-01" | 
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Name | Description | Value | 
|---|
ExpressRouteLink
| 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 | 
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' | 
ExpressRouteLinkPropertiesFormat
| Name | Description | Value | 
|---|---|---|
| adminState | Administrative state of the physical port. | 'Disabled' 'Enabled' | 
| macSecConfig | MacSec configuration. | ExpressRouteLinkMacSecConfig | 
ExpressRoutePortPropertiesFormat
| Name | Description | Value | 
|---|---|---|
| bandwidthInGbps | Bandwidth of procured ports in Gbps. | int | 
| billingType | The billing type of the ExpressRoutePort resource. | 'MeteredData' 'UnlimitedData' | 
| 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 | 
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}'. | ManagedServiceIdentityUserAssignedIdentities | 
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value | 
|---|
ResourceTags
| Name | Description | Value | 
|---|
Usage Examples
Terraform Samples
A basic example of deploying Express Route Port.
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"
}
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
      billingType     = "MeteredData"
      encapsulation   = "Dot1Q"
      peeringLocation = "Airtel-Chennai2-CLS"
    }
    tags = {
      ENV = "Test"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}