Share via

Microsoft.Peering peeringServices 2025-05-01

Bicep resource definition

The peeringServices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Peering/peeringServices@2025-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    logAnalyticsWorkspaceProperties: {}
    peeringServiceLocation: 'string'
    peeringServiceProvider: 'string'
    providerBackupPeeringLocation: 'string'
    providerPrimaryPeeringLocation: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Peering/peeringServices

Name Description Value
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 service. PeeringServiceProperties
sku The SKU that defines the type of the peering service. PeeringServiceSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

LogAnalyticsWorkspaceProperties

Name Description Value

PeeringServiceProperties

Name Description Value
logAnalyticsWorkspaceProperties The Log Analytics Workspace Properties LogAnalyticsWorkspaceProperties
peeringServiceLocation The location (state/province) of the customer. string
peeringServiceProvider The name of the service provider. string
providerBackupPeeringLocation The backup peering (Microsoft/service provider) location to be used for customer traffic. string
providerPrimaryPeeringLocation The primary peering (Microsoft/service provider) location to be used for customer traffic. string

PeeringServiceSku

Name Description Value
name The name of the peering service SKU. string

PeeringServiceTags

Name Description Value

ARM template resource definition

The peeringServices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Peering/peeringServices",
  "apiVersion": "2025-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "logAnalyticsWorkspaceProperties": {
    },
    "peeringServiceLocation": "string",
    "peeringServiceProvider": "string",
    "providerBackupPeeringLocation": "string",
    "providerPrimaryPeeringLocation": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Peering/peeringServices

Name Description Value
apiVersion The api version '2025-05-01'
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 service. PeeringServiceProperties
sku The SKU that defines the type of the peering service. PeeringServiceSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Peering/peeringServices'

LogAnalyticsWorkspaceProperties

Name Description Value

PeeringServiceProperties

Name Description Value
logAnalyticsWorkspaceProperties The Log Analytics Workspace Properties LogAnalyticsWorkspaceProperties
peeringServiceLocation The location (state/province) of the customer. string
peeringServiceProvider The name of the service provider. string
providerBackupPeeringLocation The backup peering (Microsoft/service provider) location to be used for customer traffic. string
providerPrimaryPeeringLocation The primary peering (Microsoft/service provider) location to be used for customer traffic. string

PeeringServiceSku

Name Description Value
name The name of the peering service SKU. string

PeeringServiceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The peeringServices 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/peeringServices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Peering/peeringServices@2025-05-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      logAnalyticsWorkspaceProperties = {
      }
      peeringServiceLocation = "string"
      peeringServiceProvider = "string"
      providerBackupPeeringLocation = "string"
      providerPrimaryPeeringLocation = "string"
    }
    sku = {
      name = "string"
    }
  }
}

Property Values

Microsoft.Peering/peeringServices

Name Description Value
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 service. PeeringServiceProperties
sku The SKU that defines the type of the peering service. PeeringServiceSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Peering/peeringServices@2025-05-01"

LogAnalyticsWorkspaceProperties

Name Description Value

PeeringServiceProperties

Name Description Value
logAnalyticsWorkspaceProperties The Log Analytics Workspace Properties LogAnalyticsWorkspaceProperties
peeringServiceLocation The location (state/province) of the customer. string
peeringServiceProvider The name of the service provider. string
providerBackupPeeringLocation The backup peering (Microsoft/service provider) location to be used for customer traffic. string
providerPrimaryPeeringLocation The primary peering (Microsoft/service provider) location to be used for customer traffic. string

PeeringServiceSku

Name Description Value
name The name of the peering service SKU. string

PeeringServiceTags

Name Description Value