Microsoft.Network expressRouteCrossConnections/peerings template reference

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": "2018-11-01",
  "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",
        "location": "string",
        "tags": {},
        "properties": {
          "rules": [
            {
              "id": "string",
              "properties": {
                "access": "string",
                "routeFilterRuleType": "Community",
                "communities": [
                  "string"
                ]
              },
              "name": "string",
              "location": "string"
            }
          ],
          "peerings": [
            {
              "id": "string",
              "properties": {
                "peeringType": "string",
                "state": "string",
                "azureASN": "integer",
                "peerASN": "integer",
                "primaryPeerAddressPrefix": "string",
                "secondaryPeerAddressPrefix": "string",
                "primaryAzurePort": "string",
                "secondaryAzurePort": "string",
                "sharedKey": "string",
                "vlanId": "integer",
                "microsoftPeeringConfig": {
                  "advertisedPublicPrefixes": [
                    "string"
                  ],
                  "advertisedCommunities": [
                    "string"
                  ],
                  "advertisedPublicPrefixesState": "string",
                  "legacyMode": "integer",
                  "customerASN": "integer",
                  "routingRegistryName": "string"
                },
                "stats": {
                  "primarybytesIn": "integer",
                  "primarybytesOut": "integer",
                  "secondarybytesIn": "integer",
                  "secondarybytesOut": "integer"
                },
                "routeFilter": "RouteFilter",
                "ipv6PeeringConfig": "Ipv6ExpressRouteCircuitPeeringConfig",
                "expressRouteConnection": {},
                "connections": [
                  {
                    "id": "string",
                    "properties": {
                      "expressRouteCircuitPeering": {
                        "id": "string"
                      },
                      "peerExpressRouteCircuitPeering": {
                        "id": "string"
                      },
                      "addressPrefix": "string",
                      "authorizationKey": "string"
                    },
                    "name": "string"
                  }
                ]
              },
              "name": "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 2018-11-01
properties object Yes 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 of AdvertisedPublicPrefixes. - string
advertisedCommunities array No The communities of bgp peering. Specified for microsoft peering - string
advertisedPublicPrefixesState enum No AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - 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. - RouteFilter object
state enum No The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled

RouteFilter object

Name Type Required Value
id string No Resource ID.
location string No Resource location.
tags object No Resource tags.
properties object No RouteFilterPropertiesFormat object

RouteFilterPropertiesFormat object

Name Type Required Value
rules array No Collection of RouteFilterRules contained within a route filter. - RouteFilterRule object
peerings array No A collection of references to express route circuit peerings. - ExpressRouteCircuitPeering object

RouteFilterRule object

Name Type Required Value
id string No Resource ID.
properties object No RouteFilterRulePropertiesFormat object
name string No The name of the resource that is unique within a resource group. This name can be used to access the resource.
location string No Resource location.

ExpressRouteCircuitPeering object

Name Type Required Value
id string No Resource ID.
properties object No ExpressRouteCircuitPeeringPropertiesFormat 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.

RouteFilterRulePropertiesFormat object

Name Type Required Value
access enum Yes The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny
routeFilterRuleType enum Yes The rule type of the rule. Valid value is: 'Community' - Community
communities array Yes The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string

ExpressRouteCircuitPeeringPropertiesFormat object

Name Type Required Value
peeringType enum No The peering type. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering
state enum No The peering state. - Disabled or Enabled
azureASN integer No The Azure ASN.
peerASN integer No The peer ASN.
primaryPeerAddressPrefix string No The primary address prefix.
secondaryPeerAddressPrefix string No The secondary address prefix.
primaryAzurePort string No The primary port.
secondaryAzurePort string No The secondary port.
sharedKey string No The shared key.
vlanId integer No The VLAN ID.
microsoftPeeringConfig object No The Microsoft peering configuration. - ExpressRouteCircuitPeeringConfig object
stats object No Gets peering stats. - ExpressRouteCircuitStats object
routeFilter object No The reference of the RouteFilter resource. - RouteFilter object
ipv6PeeringConfig object No The IPv6 peering configuration. - Ipv6ExpressRouteCircuitPeeringConfig object
expressRouteConnection object No The ExpressRoute connection. - ExpressRouteConnectionId object
connections array No The list of circuit connections associated with Azure Private Peering for this circuit. - ExpressRouteCircuitConnection object

ExpressRouteCircuitStats object

Name Type Required Value
primarybytesIn integer No Gets BytesIn of the peering.
primarybytesOut integer No Gets BytesOut of the peering.
secondarybytesIn integer No Gets BytesIn of the peering.
secondarybytesOut integer No Gets BytesOut of the peering.

ExpressRouteCircuitConnection object

Name Type Required Value
id string No Resource ID.
properties object No ExpressRouteCircuitConnectionPropertiesFormat 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.

ExpressRouteCircuitConnectionPropertiesFormat object

Name Type Required Value
expressRouteCircuitPeering object No Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. - SubResource object
peerExpressRouteCircuitPeering object No Reference to Express Route Circuit Private Peering Resource of the peered circuit. - SubResource object
addressPrefix string No /29 IP address space to carve out Customer addresses for tunnels.
authorizationKey string No The authorization key.

SubResource object

Name Type Required Value
id string No Resource ID.