Microsoft.Peering peeringServices 2022-06-01

  • Article

Bicep resource definition

The peeringServices resource type can be deployed to:

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@2022-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  properties: {
    logAnalyticsWorkspaceProperties: {}
    peeringServiceLocation: 'string'
    peeringServiceProvider: 'string'
    providerBackupPeeringLocation: 'string'
    providerPrimaryPeeringLocation: 'string'
  }
}

Property values

peeringServices

Name Description Value
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 type of the peering service. PeeringServiceSku
properties The properties that define a peering service. PeeringServiceProperties

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

LogAnalyticsWorkspaceProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PeeringServiceSku

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

ARM template resource definition

The peeringServices resource type can be deployed to:

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": "2022-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "properties": {
    "logAnalyticsWorkspaceProperties": {},
    "peeringServiceLocation": "string",
    "peeringServiceProvider": "string",
    "providerBackupPeeringLocation": "string",
    "providerPrimaryPeeringLocation": "string"
  }
}

Property values

peeringServices

Name Description Value
type The resource type 'Microsoft.Peering/peeringServices'
apiVersion The resource api version '2022-06-01'
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 type of the peering service. PeeringServiceSku
properties The properties that define a peering service. PeeringServiceProperties

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

LogAnalyticsWorkspaceProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PeeringServiceSku

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

Terraform (AzAPI provider) resource definition

The peeringServices resource type can be deployed to:

  • 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@2022-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      logAnalyticsWorkspaceProperties = {}
      peeringServiceLocation = "string"
      peeringServiceProvider = "string"
      providerBackupPeeringLocation = "string"
      providerPrimaryPeeringLocation = "string"
    }
    sku = {
      name = "string"
    }
  })
}

Property values

peeringServices

Name Description Value
type The resource type "Microsoft.Peering/peeringServices@2022-06-01"
name The resource name string (required)
location The location of the resource. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags The resource tags. Dictionary of tag names and values.
sku The SKU that defines the type of the peering service. PeeringServiceSku
properties The properties that define a peering service. PeeringServiceProperties

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

LogAnalyticsWorkspaceProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PeeringServiceSku

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