Microsoft.Peering peerings 2019-08-01-preview

The peerings resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Peering/peerings resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Peering/peerings@2019-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  properties: {
    direct: {
      connections: [
        {
          bandwidthInMbps: int
          bgpSession: {
            maxPrefixesAdvertisedV4: int
            maxPrefixesAdvertisedV6: int
            md5AuthenticationKey: 'string'
            peerSessionIPv4Address: 'string'
            peerSessionIPv6Address: 'string'
            sessionPrefixV4: 'string'
            sessionPrefixV6: 'string'
          }
          connectionIdentifier: 'string'
          peeringDBFacilityId: int
          provisionedBandwidthInMbps: int
          sessionAddressProvider: 'string'
          useForPeeringService: bool
        }
      ]
      directPeeringType: 'string'
      peerAsn: {
        id: 'string'
      }
      useForPeeringService: bool
    }
    exchange: {
      connections: [
        {
          bgpSession: {
            maxPrefixesAdvertisedV4: int
            maxPrefixesAdvertisedV6: int
            md5AuthenticationKey: 'string'
            peerSessionIPv4Address: 'string'
            peerSessionIPv6Address: 'string'
            sessionPrefixV4: 'string'
            sessionPrefixV6: 'string'
          }
          connectionIdentifier: 'string'
          peeringDBFacilityId: int
        }
      ]
      peerAsn: {
        id: 'string'
      }
    }
    peeringLocation: 'string'
  }
}

Property values

peerings

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Peering/peerings'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2019-08-01-preview'
name The resource name string (required)
location The location of the resource. string (required)
tags The resource tags. Dictionary of tag names and values. See Tags in templates
sku The SKU that defines the tier and kind of the peering. PeeringSku (required)
kind The kind of the peering. 'Direct'
'Exchange'
properties The properties that define connectivity to the Microsoft Cloud Edge. PeeringProperties

PeeringProperties

Name Description Value
direct The properties that define a direct peering. PeeringPropertiesDirect
exchange The properties that define an exchange peering. PeeringPropertiesExchange
peeringLocation The location of the peering. string

PeeringPropertiesDirect

Name Description Value
connections The set of connections that constitute a direct peering. DirectConnection[]
directPeeringType The type of direct peering. 'Cdn'
'Edge'
'Internal'
'Transit'
peerAsn The sub resource. SubResource
useForPeeringService The flag that indicates whether or not the peering is used for peering service. bool

DirectConnection

Name Description Value
bandwidthInMbps The bandwidth of the connection. int
bgpSession The properties that define a BGP session. BgpSession
connectionIdentifier The unique identifier (GUID) for the connection. string
peeringDBFacilityId The PeeringDB.com ID of the facility at which the connection has to be set up. int
provisionedBandwidthInMbps The bandwidth that is actually provisioned. int
sessionAddressProvider The field indicating if Microsoft provides session ip addresses. 'Microsoft'
'Peer'
useForPeeringService The flag that indicates whether or not the connection is used for peering service. bool

BgpSession

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

SubResource

Name Description Value
id The identifier of the referenced resource. string

PeeringPropertiesExchange

Name Description Value
connections The set of connections that constitute an exchange peering. ExchangeConnection[]
peerAsn The sub resource. SubResource

ExchangeConnection

Name Description Value
bgpSession The properties that define a BGP session. BgpSession
connectionIdentifier The unique identifier (GUID) for the connection. string
peeringDBFacilityId The PeeringDB.com ID of the facility at which the connection has to be set up. int

PeeringSku

Name Description Value
family The family of the peering SKU. 'Direct'
'Exchange'
name The name of the peering SKU. 'Basic_Direct_Free'
'Basic_Exchange_Free'
'Premium_Direct_Free'
'Premium_Direct_Metered'
'Premium_Direct_Unlimited'
'Premium_Exchange_Metered'
size The size of the peering SKU. 'Free'
'Metered'
'Unlimited'
tier The tier of the peering SKU. 'Basic'
'Premium'