Microsoft.Network ExpressRoutePorts template reference

  • 2 minutes to read

Template format

To create a Microsoft.Network/ExpressRoutePorts resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/ExpressRoutePorts",
  "apiVersion": "2019-06-01",
  "location": "string",
  "tags": {},
  "properties": {
    "peeringLocation": "string",
    "bandwidthInGbps": "integer",
    "encapsulation": "string",
    "links": [
      {
        "id": "string",
        "properties": {
          "adminState": "string"
        },
        "name": "string"
      }
    ],
    "resourceGuid": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/ExpressRoutePorts object

Name Type Required Value
name string Yes The name of the ExpressRoutePort resource.
type enum Yes Microsoft.Network/ExpressRoutePorts
apiVersion enum Yes 2019-06-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes ExpressRoutePort properties. - ExpressRoutePortPropertiesFormat object

ExpressRoutePortPropertiesFormat object

Name Type Required Value
peeringLocation string No The name of the peering location that the ExpressRoutePort is mapped to physically.
bandwidthInGbps integer No Bandwidth of procured ports in Gbps.
encapsulation enum No Encapsulation method on physical ports. - Dot1Q or QinQ
links array No The set of physical links of the ExpressRoutePort resource. - ExpressRouteLink object
resourceGuid string No The resource GUID property of the ExpressRoutePort resource.

Name Type Required Value
id string No Resource ID.
properties object No ExpressRouteLink properties. - ExpressRouteLinkPropertiesFormat object
name string No Name of child port resource that is unique among child port resources of the parent.

ExpressRouteLinkPropertiesFormat object

Name Type Required Value
adminState enum No Administrative state of the physical port. - Enabled or Disabled