Microsoft.Network ExpressRoutePorts 2020-03-01

  • 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": "2020-03-01",
  "location": "string",
  "tags": {},
  "properties": {
    "peeringLocation": "string",
    "bandwidthInGbps": "integer",
    "encapsulation": "string",
    "links": [
      {
        "id": "string",
        "properties": {
          "adminState": "string",
          "macSecConfig": {
            "cknSecretIdentifier": "string",
            "cakSecretIdentifier": "string",
            "cipher": "string"
          }
        },
        "name": "string"
      }
    ]
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  }
}

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 2020-03-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes ExpressRoutePort properties. - ExpressRoutePortPropertiesFormat object
identity object No The identity of ExpressRoutePort, if configured. - ManagedServiceIdentity 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

ManagedServiceIdentity object

Name Type Required Value
type enum No 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, UserAssigned, SystemAssigned, UserAssigned, None
userAssignedIdentities object No 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}'.

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
macSecConfig object No MacSec configuration. - ExpressRouteLinkMacSecConfig object

ExpressRouteLinkMacSecConfig object

Name Type Required Value
cknSecretIdentifier string No Keyvault Secret Identifier URL containing Mac security CKN key.
cakSecretIdentifier string No Keyvault Secret Identifier URL containing Mac security CAK key.
cipher enum No Mac security cipher. - gcm-aes-128 or gcm-aes-256