Microsoft.Network expressRouteCrossConnections/peerings 2019-12-01

Template format

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

{
  "name": "string",
  "type": "Microsoft.Network/expressRouteCrossConnections/peerings",
  "apiVersion": "2019-12-01",
  "properties": {
    "peeringType": "string",
    "state": "string",
    "peerASN": "integer",
    "primaryPeerAddressPrefix": "string",
    "secondaryPeerAddressPrefix": "string",
    "sharedKey": "string",
    "vlanId": "integer",
    "microsoftPeeringConfig": {
      "advertisedPublicPrefixes": [
        "string"
      ],
      "advertisedCommunities": [
        "string"
      ],
      "legacyMode": "integer",
      "customerASN": "integer",
      "routingRegistryName": "string"
    },
    "ipv6PeeringConfig": {
      "primaryPeerAddressPrefix": "string",
      "secondaryPeerAddressPrefix": "string",
      "microsoftPeeringConfig": {
        "advertisedPublicPrefixes": [
          "string"
        ],
        "advertisedCommunities": [
          "string"
        ],
        "legacyMode": "integer",
        "customerASN": "integer",
        "routingRegistryName": "string"
      },
      "routeFilter": {
        "id": "string"
      },
      "state": "string"
    }
  }
}

Property values

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

Microsoft.Network/expressRouteCrossConnections/peerings object

Name Type Required Value
name string Yes The name of the peering.
type enum Yes peerings
-or-
Microsoft.Network/expressRouteCrossConnections/peerings

See Set name and type for child resources.
apiVersion enum Yes 2019-12-01
properties object Yes Properties of the express route cross connection peering. - ExpressRouteCrossConnectionPeeringProperties object

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 to AdvertisedPublicPrefixes. - string
advertisedCommunities array No The communities of bgp peering. Specified for microsoft peering. - string
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 to 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.