Share via

Microsoft.Network ExpressRoutePorts 2018-11-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@2018-11-01' = {
  scope: resourceSymbolicName or scope
  ___location: 'string'
  name: 'string'
  properties: {
    bandwidthInGbps: int
    encapsulation: 'string'
    links: [
      {
        id: 'string'
        name: 'string'
        properties: {
          adminState: 'string'
        }
      }
    ]
    peeringLocation: 'string'
    resourceGuid: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/ExpressRoutePorts

Name Description Value
___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
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'

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
resourceGuid The resource GUID property of the ExpressRoutePort resource. string

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": "2018-11-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "bandwidthInGbps": "int",
    "encapsulation": "string",
    "links": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "adminState": "string"
        }
      }
    ],
    "peeringLocation": "string",
    "resourceGuid": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/ExpressRoutePorts

Name Description Value
apiVersion The api version '2018-11-01'
___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'
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'

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
resourceGuid The resource GUID property of the ExpressRoutePort resource. string

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@2018-11-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      bandwidthInGbps = int
      encapsulation = "string"
      links = [
        {
          id = "string"
          name = "string"
          properties = {
            adminState = "string"
          }
        }
      ]
      peeringLocation = "string"
      resourceGuid = "string"
    }
  }
}

Property Values

Microsoft.Network/ExpressRoutePorts

Name Description Value
___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@2018-11-01"
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'

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
resourceGuid The resource GUID property of the ExpressRoutePort resource. string

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    = ["*"]
}