共用方式為


Microsoft.Network ExpressRoutePorts 2024-01-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@2024-01-01' = {
  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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

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
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

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": "2024-01-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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

Microsoft.Network/ExpressRoutePorts

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

ResourceTags

Name Description Value

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@2024-01-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

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

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
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/ExpressRoutePorts@2024-01-01"

ResourceTags

Name Description Value