Microsoft.Network expressRouteCrossConnections template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.Network/expressRouteCrossConnections",
  "apiVersion": "2019-04-01",
  "location": "string",
  "tags": {},
  "properties": {
    "peeringLocation": "string",
    "bandwidthInMbps": "integer",
    "expressRouteCircuit": {
      "id": "string"
    },
    "serviceProviderNotes": "string",
    "peerings": [
      {
        "id": "string",
        "properties": {
          "peeringType": "string",
          "state": "string",
          "peerASN": "integer",
          "primaryPeerAddressPrefix": "string",
          "secondaryPeerAddressPrefix": "string",
          "sharedKey": "string",
          "vlanId": "integer",
          "microsoftPeeringConfig": {
            "advertisedPublicPrefixes": [
              "string"
            ],
            "advertisedCommunities": [
              "string"
            ],
            "advertisedPublicPrefixesState": "string",
            "legacyMode": "integer",
            "customerASN": "integer",
            "routingRegistryName": "string"
          },
          "ipv6PeeringConfig": {
            "primaryPeerAddressPrefix": "string",
            "secondaryPeerAddressPrefix": "string",
            "microsoftPeeringConfig": {
              "advertisedPublicPrefixes": [
                "string"
              ],
              "advertisedCommunities": [
                "string"
              ],
              "advertisedPublicPrefixesState": "string",
              "legacyMode": "integer",
              "customerASN": "integer",
              "routingRegistryName": "string"
            },
            "routeFilter": {
              "id": "string"
            },
            "state": "string"
          }
        },
        "name": "string"
      }
    ]
  },
  "resources": []
}

Property values

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

Microsoft.Network/expressRouteCrossConnections object

Name Type Required Value
name string Yes The name of the ExpressRouteCrossConnection.
type enum Yes Microsoft.Network/expressRouteCrossConnections
apiVersion enum Yes 2019-04-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Properties of the express route cross connection. - ExpressRouteCrossConnectionProperties object
resources array No peerings

ExpressRouteCrossConnectionProperties object

Name Type Required Value
peeringLocation string No The peering location of the ExpressRoute circuit.
bandwidthInMbps integer No The circuit bandwidth In Mbps.
expressRouteCircuit object No The ExpressRouteCircuit. - ExpressRouteCircuitReference object
serviceProviderNotes string No Additional read only notes set by the connectivity provider.
peerings array No The list of peerings. - ExpressRouteCrossConnectionPeering object

ExpressRouteCircuitReference object

Name Type Required Value
id string No Corresponding Express Route Circuit Id.

ExpressRouteCrossConnectionPeering object

Name Type Required Value
id string No Resource ID.
properties object No Properties of the express route cross connection peering. - ExpressRouteCrossConnectionPeeringProperties object
name string No Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

ExpressRouteCrossConnectionPeeringProperties object

Name Type Required Value
peeringType enum No The peering type. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering
state enum No The peering state. - Disabled or Enabled
peerASN integer No The peer ASN.
primaryPeerAddressPrefix string No The primary address prefix.
secondaryPeerAddressPrefix string No The secondary address prefix.
sharedKey string No The shared key.
vlanId integer No The VLAN ID.
microsoftPeeringConfig object No The Microsoft peering configuration. - ExpressRouteCircuitPeeringConfig object
ipv6PeeringConfig object No The IPv6 peering configuration. - Ipv6ExpressRouteCircuitPeeringConfig object

ExpressRouteCircuitPeeringConfig object

Name Type Required Value
advertisedPublicPrefixes array No The reference of AdvertisedPublicPrefixes. - string
advertisedCommunities array No The communities of bgp peering. Specified for microsoft peering. - string
advertisedPublicPrefixesState enum No The advertised public prefix state of the Peering resource. - NotConfigured, Configuring, Configured, ValidationNeeded
legacyMode integer No The legacy mode of the peering.
customerASN integer No The CustomerASN of the peering.
routingRegistryName string No The RoutingRegistryName of the configuration.

Ipv6ExpressRouteCircuitPeeringConfig object

Name Type Required Value
primaryPeerAddressPrefix string No The primary address prefix.
secondaryPeerAddressPrefix string No The secondary address prefix.
microsoftPeeringConfig object No The Microsoft peering configuration. - ExpressRouteCircuitPeeringConfig object
routeFilter object No The reference of the RouteFilter resource. - SubResource object
state enum No The state of peering. - Disabled or Enabled

SubResource object

Name Type Required Value
id string No Resource ID.