Microsoft.Peering peerings template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.Peering/peerings",
  "apiVersion": "2019-08-01-preview",
  "sku": {
    "name": "string",
    "tier": "string",
    "family": "string",
    "size": "string"
  },
  "kind": "string",
  "properties": {
    "direct": {
      "connections": [
        {
          "bandwidthInMbps": "integer",
          "provisionedBandwidthInMbps": "integer",
          "sessionAddressProvider": "string",
          "useForPeeringService": "boolean",
          "peeringDBFacilityId": "integer",
          "bgpSession": {
            "sessionPrefixV4": "string",
            "sessionPrefixV6": "string",
            "peerSessionIPv4Address": "string",
            "peerSessionIPv6Address": "string",
            "maxPrefixesAdvertisedV4": "integer",
            "maxPrefixesAdvertisedV6": "integer",
            "md5AuthenticationKey": "string"
          },
          "connectionIdentifier": "string"
        }
      ],
      "useForPeeringService": "boolean",
      "peerAsn": {
        "id": "string"
      },
      "directPeeringType": "string"
    },
    "exchange": {
      "connections": [
        {
          "peeringDBFacilityId": "integer",
          "bgpSession": {
            "sessionPrefixV4": "string",
            "sessionPrefixV6": "string",
            "peerSessionIPv4Address": "string",
            "peerSessionIPv6Address": "string",
            "maxPrefixesAdvertisedV4": "integer",
            "maxPrefixesAdvertisedV6": "integer",
            "md5AuthenticationKey": "string"
          },
          "connectionIdentifier": "string"
        }
      ],
      "peerAsn": {
        "id": "string"
      }
    },
    "peeringLocation": "string"
  },
  "location": "string",
  "tags": {}
}

Property values

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

Microsoft.Peering/peerings object

Name Type Required Value
name string Yes The name of the peering.
type enum Yes Microsoft.Peering/peerings
apiVersion enum Yes 2019-08-01-preview
sku object Yes The SKU that defines the tier and kind of the peering. - PeeringSku object
kind enum Yes The kind of the peering. - Direct or Exchange
properties object Yes The properties that define a peering. - PeeringProperties object
location string Yes The location of the resource.
tags object No The resource tags.

PeeringSku object

Name Type Required Value
name enum No The name of the peering SKU. - Basic_Exchange_Free, Basic_Direct_Free, Premium_Direct_Free, Premium_Exchange_Metered, Premium_Direct_Metered, Premium_Direct_Unlimited
tier enum No The tier of the peering SKU. - Basic or Premium
family enum No The family of the peering SKU. - Direct or Exchange
size enum No The size of the peering SKU. - Free, Metered, Unlimited

PeeringProperties object

Name Type Required Value
direct object No The properties that define a direct peering. - PeeringPropertiesDirect object
exchange object No The properties that define an exchange peering. - PeeringPropertiesExchange object
peeringLocation string No The location of the peering.

PeeringPropertiesDirect object

Name Type Required Value
connections array No The set of connections that constitute a direct peering. - DirectConnection object
useForPeeringService boolean No The flag that indicates whether or not the peering is used for peering service.
peerAsn object No The reference of the peer ASN. - SubResource object
directPeeringType enum No The type of direct peering. - Edge, Transit, Cdn, Internal

PeeringPropertiesExchange object

Name Type Required Value
connections array No The set of connections that constitute an exchange peering. - ExchangeConnection object
peerAsn object No The reference of the peer ASN. - SubResource object

DirectConnection object

Name Type Required Value
bandwidthInMbps integer No The bandwidth of the connection.
provisionedBandwidthInMbps integer No The bandwidth that is actually provisioned.
sessionAddressProvider enum No The field indicating if Microsoft provides session ip addresses. - Microsoft or Peer
useForPeeringService boolean No The flag that indicates whether or not the connection is used for peering service.
peeringDBFacilityId integer No The PeeringDB.com ID of the facility at which the connection has to be set up.
bgpSession object No The BGP session associated with the connection. - BgpSession object
connectionIdentifier string No The unique identifier (GUID) for the connection.

SubResource object

Name Type Required Value
id string No The identifier of the referenced resource.

ExchangeConnection object

Name Type Required Value
peeringDBFacilityId integer No The PeeringDB.com ID of the facility at which the connection has to be set up.
bgpSession object No The BGP session associated with the connection. - BgpSession object
connectionIdentifier string No The unique identifier (GUID) for the connection.

BgpSession object

Name Type Required Value
sessionPrefixV4 string No The IPv4 prefix that contains both ends' IPv4 addresses.
sessionPrefixV6 string No The IPv6 prefix that contains both ends' IPv6 addresses.
peerSessionIPv4Address string No The IPv4 session address on peer's end.
peerSessionIPv6Address string No The IPv6 session address on peer's end.
maxPrefixesAdvertisedV4 integer No The maximum number of prefixes advertised over the IPv4 session.
maxPrefixesAdvertisedV6 integer No The maximum number of prefixes advertised over the IPv6 session.
md5AuthenticationKey string No The MD5 authentication key of the session.