Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The peerings resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Peering/peerings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Peering/peerings@2025-05-01' = {
kind: 'string'
location: 'string'
name: 'string'
properties: {
connectivityProbes: [
{
azureRegion: 'string'
endpoint: 'string'
protocol: 'string'
}
]
direct: {
connections: [
{
bandwidthInMbps: int
bgpSession: {
maxPrefixesAdvertisedV4: int
maxPrefixesAdvertisedV6: int
md5AuthenticationKey: 'string'
microsoftSessionIPv4Address: 'string'
microsoftSessionIPv6Address: 'string'
peerSessionIPv4Address: 'string'
peerSessionIPv6Address: 'string'
sessionPrefixV4: 'string'
sessionPrefixV6: 'string'
}
connectionIdentifier: 'string'
peeringDBFacilityId: int
sessionAddressProvider: 'string'
useForPeeringService: bool
}
]
directPeeringType: 'string'
peerAsn: {
id: 'string'
}
}
exchange: {
connections: [
{
bgpSession: {
maxPrefixesAdvertisedV4: int
maxPrefixesAdvertisedV6: int
md5AuthenticationKey: 'string'
microsoftSessionIPv4Address: 'string'
microsoftSessionIPv6Address: 'string'
peerSessionIPv4Address: 'string'
peerSessionIPv6Address: 'string'
sessionPrefixV4: 'string'
sessionPrefixV6: 'string'
}
connectionIdentifier: 'string'
peeringDBFacilityId: int
}
]
peerAsn: {
id: 'string'
}
}
peeringLocation: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Peering/peerings
| Name | Description | Value |
|---|---|---|
| kind | The kind of the peering. | 'Direct' 'Exchange' (required) |
| location | The location of the resource. | string (required) |
| name | The resource name | string Constraints: Pattern = [A-Za-z0-9_.-]{1,63} (required) |
| properties | The properties that define a peering. | PeeringProperties |
| sku | The SKU that defines the tier and kind of the peering. | PeeringSku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 |
| microsoftSessionIPv4Address | The IPv4 session address on Microsoft's end. | string |
| microsoftSessionIPv6Address | The IPv6 session address on Microsoft's end. | 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 |
ConnectivityProbe
| Name | Description | Value |
|---|---|---|
| azureRegion | The Azure region where traffic will originate from for the connectivity probe. | string |
| endpoint | The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. | string |
| protocol | The protocol of the traffic that will be sent for the connectivity probe. | 'ICMP' 'None' 'TCP' |
DirectConnection
| Name | Description | Value |
|---|---|---|
| bandwidthInMbps | The bandwidth of the connection. | int |
| bgpSession | The BGP session associated with the connection. | 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 |
| 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 |
ExchangeConnection
| Name | Description | Value |
|---|---|---|
| bgpSession | The BGP session associated with the connection. | 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 |
PeeringProperties
| Name | Description | Value |
|---|---|---|
| connectivityProbes | The connectivity probes associated with the peering. | ConnectivityProbe[] |
| 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' 'EdgeZoneForOperators' 'Internal' 'Ix' 'IxRs' 'PeerProp' 'Transit' 'Voice' |
| peerAsn | The reference of the peer ASN. | SubResource |
PeeringPropertiesExchange
| Name | Description | Value |
|---|---|---|
| connections | The set of connections that constitute an exchange peering. | ExchangeConnection[] |
| peerAsn | The reference of the peer ASN. | SubResource |
PeeringSku
| Name | Description | Value |
|---|---|---|
| name | The name of the peering SKU. | string |
PeeringTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | The identifier of the referenced resource. | string |
ARM template resource definition
The peerings resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Peering/peerings resource, add the following JSON to your template.
{
"type": "Microsoft.Peering/peerings",
"apiVersion": "2025-05-01",
"name": "string",
"kind": "string",
"location": "string",
"properties": {
"connectivityProbes": [
{
"azureRegion": "string",
"endpoint": "string",
"protocol": "string"
}
],
"direct": {
"connections": [
{
"bandwidthInMbps": "int",
"bgpSession": {
"maxPrefixesAdvertisedV4": "int",
"maxPrefixesAdvertisedV6": "int",
"md5AuthenticationKey": "string",
"microsoftSessionIPv4Address": "string",
"microsoftSessionIPv6Address": "string",
"peerSessionIPv4Address": "string",
"peerSessionIPv6Address": "string",
"sessionPrefixV4": "string",
"sessionPrefixV6": "string"
},
"connectionIdentifier": "string",
"peeringDBFacilityId": "int",
"sessionAddressProvider": "string",
"useForPeeringService": "bool"
}
],
"directPeeringType": "string",
"peerAsn": {
"id": "string"
}
},
"exchange": {
"connections": [
{
"bgpSession": {
"maxPrefixesAdvertisedV4": "int",
"maxPrefixesAdvertisedV6": "int",
"md5AuthenticationKey": "string",
"microsoftSessionIPv4Address": "string",
"microsoftSessionIPv6Address": "string",
"peerSessionIPv4Address": "string",
"peerSessionIPv6Address": "string",
"sessionPrefixV4": "string",
"sessionPrefixV6": "string"
},
"connectionIdentifier": "string",
"peeringDBFacilityId": "int"
}
],
"peerAsn": {
"id": "string"
}
},
"peeringLocation": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Peering/peerings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-05-01' |
| kind | The kind of the peering. | 'Direct' 'Exchange' (required) |
| location | The location of the resource. | string (required) |
| name | The resource name | string Constraints: Pattern = [A-Za-z0-9_.-]{1,63} (required) |
| properties | The properties that define a peering. | PeeringProperties |
| sku | The SKU that defines the tier and kind of the peering. | PeeringSku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Peering/peerings' |
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 |
| microsoftSessionIPv4Address | The IPv4 session address on Microsoft's end. | string |
| microsoftSessionIPv6Address | The IPv6 session address on Microsoft's end. | 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 |
ConnectivityProbe
| Name | Description | Value |
|---|---|---|
| azureRegion | The Azure region where traffic will originate from for the connectivity probe. | string |
| endpoint | The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. | string |
| protocol | The protocol of the traffic that will be sent for the connectivity probe. | 'ICMP' 'None' 'TCP' |
DirectConnection
| Name | Description | Value |
|---|---|---|
| bandwidthInMbps | The bandwidth of the connection. | int |
| bgpSession | The BGP session associated with the connection. | 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 |
| 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 |
ExchangeConnection
| Name | Description | Value |
|---|---|---|
| bgpSession | The BGP session associated with the connection. | 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 |
PeeringProperties
| Name | Description | Value |
|---|---|---|
| connectivityProbes | The connectivity probes associated with the peering. | ConnectivityProbe[] |
| 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' 'EdgeZoneForOperators' 'Internal' 'Ix' 'IxRs' 'PeerProp' 'Transit' 'Voice' |
| peerAsn | The reference of the peer ASN. | SubResource |
PeeringPropertiesExchange
| Name | Description | Value |
|---|---|---|
| connections | The set of connections that constitute an exchange peering. | ExchangeConnection[] |
| peerAsn | The reference of the peer ASN. | SubResource |
PeeringSku
| Name | Description | Value |
|---|---|---|
| name | The name of the peering SKU. | string |
PeeringTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | The identifier of the referenced resource. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The peerings resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Peering/peerings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Peering/peerings@2025-05-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
connectivityProbes = [
{
azureRegion = "string"
endpoint = "string"
protocol = "string"
}
]
direct = {
connections = [
{
bandwidthInMbps = int
bgpSession = {
maxPrefixesAdvertisedV4 = int
maxPrefixesAdvertisedV6 = int
md5AuthenticationKey = "string"
microsoftSessionIPv4Address = "string"
microsoftSessionIPv6Address = "string"
peerSessionIPv4Address = "string"
peerSessionIPv6Address = "string"
sessionPrefixV4 = "string"
sessionPrefixV6 = "string"
}
connectionIdentifier = "string"
peeringDBFacilityId = int
sessionAddressProvider = "string"
useForPeeringService = bool
}
]
directPeeringType = "string"
peerAsn = {
id = "string"
}
}
exchange = {
connections = [
{
bgpSession = {
maxPrefixesAdvertisedV4 = int
maxPrefixesAdvertisedV6 = int
md5AuthenticationKey = "string"
microsoftSessionIPv4Address = "string"
microsoftSessionIPv6Address = "string"
peerSessionIPv4Address = "string"
peerSessionIPv6Address = "string"
sessionPrefixV4 = "string"
sessionPrefixV6 = "string"
}
connectionIdentifier = "string"
peeringDBFacilityId = int
}
]
peerAsn = {
id = "string"
}
}
peeringLocation = "string"
}
sku = {
name = "string"
}
}
}
Property Values
Microsoft.Peering/peerings
| Name | Description | Value |
|---|---|---|
| kind | The kind of the peering. | 'Direct' 'Exchange' (required) |
| location | The location of the resource. | string (required) |
| name | The resource name | string Constraints: Pattern = [A-Za-z0-9_.-]{1,63} (required) |
| properties | The properties that define a peering. | PeeringProperties |
| sku | The SKU that defines the tier and kind of the peering. | PeeringSku (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Peering/peerings@2025-05-01" |
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 |
| microsoftSessionIPv4Address | The IPv4 session address on Microsoft's end. | string |
| microsoftSessionIPv6Address | The IPv6 session address on Microsoft's end. | 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 |
ConnectivityProbe
| Name | Description | Value |
|---|---|---|
| azureRegion | The Azure region where traffic will originate from for the connectivity probe. | string |
| endpoint | The endpoint IP address where traffic will be sent to from Azure for the connectivity probe. | string |
| protocol | The protocol of the traffic that will be sent for the connectivity probe. | 'ICMP' 'None' 'TCP' |
DirectConnection
| Name | Description | Value |
|---|---|---|
| bandwidthInMbps | The bandwidth of the connection. | int |
| bgpSession | The BGP session associated with the connection. | 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 |
| 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 |
ExchangeConnection
| Name | Description | Value |
|---|---|---|
| bgpSession | The BGP session associated with the connection. | 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 |
PeeringProperties
| Name | Description | Value |
|---|---|---|
| connectivityProbes | The connectivity probes associated with the peering. | ConnectivityProbe[] |
| 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' 'EdgeZoneForOperators' 'Internal' 'Ix' 'IxRs' 'PeerProp' 'Transit' 'Voice' |
| peerAsn | The reference of the peer ASN. | SubResource |
PeeringPropertiesExchange
| Name | Description | Value |
|---|---|---|
| connections | The set of connections that constitute an exchange peering. | ExchangeConnection[] |
| peerAsn | The reference of the peer ASN. | SubResource |
PeeringSku
| Name | Description | Value |
|---|---|---|
| name | The name of the peering SKU. | string |
PeeringTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | The identifier of the referenced resource. | string |