Microsoft.Network expressRouteCrossConnections 2020-05-01

• Latest
• 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
• 2018-07-01
• 2018-06-01
• 2018-04-01
• 2018-02-01

Bicep resource definition

The expressRouteCrossConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteCrossConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/expressRouteCrossConnections@2020-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bandwidthInMbps: int
    expressRouteCircuit: {
      id: 'string'
    }
    peeringLocation: 'string'
    peerings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          gatewayManagerEtag: 'string'
          ipv6PeeringConfig: {
            microsoftPeeringConfig: {
              advertisedCommunities: [
                'string'
              ]
              advertisedPublicPrefixes: [
                'string'
              ]
              customerASN: int
              legacyMode: int
              routingRegistryName: 'string'
            }
            primaryPeerAddressPrefix: 'string'
            routeFilter: {
              id: 'string'
            }
            secondaryPeerAddressPrefix: 'string'
            state: 'string'
          }
          microsoftPeeringConfig: {
            advertisedCommunities: [
              'string'
            ]
            advertisedPublicPrefixes: [
              'string'
            ]
            customerASN: int
            legacyMode: int
            routingRegistryName: 'string'
          }
          peerASN: int
          peeringType: 'string'
          primaryPeerAddressPrefix: 'string'
          secondaryPeerAddressPrefix: 'string'
          sharedKey: 'string'
          state: 'string'
          vlanId: int
        }
      }
    ]
    serviceProviderNotes: 'string'
    serviceProviderProvisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference to AdvertisedPublicPrefixes.	string[]
customerASN	The CustomerASN of the peering.	int
legacyMode	The legacy mode of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCircuitReference

Name	Description	Value
id	Corresponding Express Route Circuit Id.	string

ExpressRouteCrossConnectionPeering

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the express route cross connection peering.	ExpressRouteCrossConnectionPeeringProperties

ExpressRouteCrossConnectionPeeringProperties

Name	Description	Value
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryPeerAddressPrefix	The primary address prefix.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
vlanId	The VLAN ID.	int

ExpressRouteCrossConnectionProperties

Name	Description	Value
bandwidthInMbps	The circuit bandwidth In Mbps.	int
expressRouteCircuit	The ExpressRouteCircuit.	ExpressRouteCircuitReference
peeringLocation	The peering location of the ExpressRoute circuit.	string
peerings	The list of peerings.	ExpressRouteCrossConnectionPeering[]
serviceProviderNotes	Additional read only notes set by the connectivity provider.	string
serviceProviderProvisioningState	The provisioning state of the circuit in the connectivity provider system.	'Deprovisioning' 'NotProvisioned' 'Provisioned' 'Provisioning'

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCrossConnections

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route cross connection.	ExpressRouteCrossConnectionProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string

ARM template resource definition

The expressRouteCrossConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteCrossConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/expressRouteCrossConnections",
  "apiVersion": "2020-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bandwidthInMbps": "int",
    "expressRouteCircuit": {
      "id": "string"
    },
    "peeringLocation": "string",
    "peerings": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "gatewayManagerEtag": "string",
          "ipv6PeeringConfig": {
            "microsoftPeeringConfig": {
              "advertisedCommunities": [ "string" ],
              "advertisedPublicPrefixes": [ "string" ],
              "customerASN": "int",
              "legacyMode": "int",
              "routingRegistryName": "string"
            },
            "primaryPeerAddressPrefix": "string",
            "routeFilter": {
              "id": "string"
            },
            "secondaryPeerAddressPrefix": "string",
            "state": "string"
          },
          "microsoftPeeringConfig": {
            "advertisedCommunities": [ "string" ],
            "advertisedPublicPrefixes": [ "string" ],
            "customerASN": "int",
            "legacyMode": "int",
            "routingRegistryName": "string"
          },
          "peerASN": "int",
          "peeringType": "string",
          "primaryPeerAddressPrefix": "string",
          "secondaryPeerAddressPrefix": "string",
          "sharedKey": "string",
          "state": "string",
          "vlanId": "int"
        }
      }
    ],
    "serviceProviderNotes": "string",
    "serviceProviderProvisioningState": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference to AdvertisedPublicPrefixes.	string[]
customerASN	The CustomerASN of the peering.	int
legacyMode	The legacy mode of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCircuitReference

Name	Description	Value
id	Corresponding Express Route Circuit Id.	string

ExpressRouteCrossConnectionPeering

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the express route cross connection peering.	ExpressRouteCrossConnectionPeeringProperties

ExpressRouteCrossConnectionPeeringProperties

Name	Description	Value
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryPeerAddressPrefix	The primary address prefix.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
vlanId	The VLAN ID.	int

ExpressRouteCrossConnectionProperties

Name	Description	Value
bandwidthInMbps	The circuit bandwidth In Mbps.	int
expressRouteCircuit	The ExpressRouteCircuit.	ExpressRouteCircuitReference
peeringLocation	The peering location of the ExpressRoute circuit.	string
peerings	The list of peerings.	ExpressRouteCrossConnectionPeering[]
serviceProviderNotes	Additional read only notes set by the connectivity provider.	string
serviceProviderProvisioningState	The provisioning state of the circuit in the connectivity provider system.	'Deprovisioning' 'NotProvisioned' 'Provisioned' 'Provisioning'

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCrossConnections

Name	Description	Value
apiVersion	The api version	'2020-05-01'
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route cross connection.	ExpressRouteCrossConnectionProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/expressRouteCrossConnections'

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string

Terraform (AzAPI provider) resource definition

The expressRouteCrossConnections 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/expressRouteCrossConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCrossConnections@2020-05-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      bandwidthInMbps = int
      expressRouteCircuit = {
        id = "string"
      }
      peeringLocation = "string"
      peerings = [
        {
          id = "string"
          name = "string"
          properties = {
            gatewayManagerEtag = "string"
            ipv6PeeringConfig = {
              microsoftPeeringConfig = {
                advertisedCommunities = [
                  "string"
                ]
                advertisedPublicPrefixes = [
                  "string"
                ]
                customerASN = int
                legacyMode = int
                routingRegistryName = "string"
              }
              primaryPeerAddressPrefix = "string"
              routeFilter = {
                id = "string"
              }
              secondaryPeerAddressPrefix = "string"
              state = "string"
            }
            microsoftPeeringConfig = {
              advertisedCommunities = [
                "string"
              ]
              advertisedPublicPrefixes = [
                "string"
              ]
              customerASN = int
              legacyMode = int
              routingRegistryName = "string"
            }
            peerASN = int
            peeringType = "string"
            primaryPeerAddressPrefix = "string"
            secondaryPeerAddressPrefix = "string"
            sharedKey = "string"
            state = "string"
            vlanId = int
          }
        }
      ]
      serviceProviderNotes = "string"
      serviceProviderProvisioningState = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference to AdvertisedPublicPrefixes.	string[]
customerASN	The CustomerASN of the peering.	int
legacyMode	The legacy mode of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCircuitReference

Name	Description	Value
id	Corresponding Express Route Circuit Id.	string

ExpressRouteCrossConnectionPeering

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the express route cross connection peering.	ExpressRouteCrossConnectionPeeringProperties

ExpressRouteCrossConnectionPeeringProperties

Name	Description	Value
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryPeerAddressPrefix	The primary address prefix.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
vlanId	The VLAN ID.	int

ExpressRouteCrossConnectionProperties

Name	Description	Value
bandwidthInMbps	The circuit bandwidth In Mbps.	int
expressRouteCircuit	The ExpressRouteCircuit.	ExpressRouteCircuitReference
peeringLocation	The peering location of the ExpressRoute circuit.	string
peerings	The list of peerings.	ExpressRouteCrossConnectionPeering[]
serviceProviderNotes	Additional read only notes set by the connectivity provider.	string
serviceProviderProvisioningState	The provisioning state of the circuit in the connectivity provider system.	'Deprovisioning' 'NotProvisioned' 'Provisioned' 'Provisioning'

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCrossConnections

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route cross connection.	ExpressRouteCrossConnectionProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/expressRouteCrossConnections@2020-05-01"

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource ID.	string