Share via

Microsoft.OperationalInsights clusters 2019-08-01-preview

  • Article

Bicep resource definition

The clusters 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.OperationalInsights/clusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.OperationalInsights/clusters@2019-08-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    keyVaultProperties: {
      keyName: 'string'
      keyVaultUri: 'string'
      keyVersion: 'string'
    }
    nextLink: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ClusterProperties

Name Description Value
keyVaultProperties The associated key properties. KeyVaultProperties
nextLink The link used to get the next page of recommendations. string

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned' (required)

KeyVaultProperties

Name Description Value
keyName The name of the key associated with the Log Analytics cluster. string
keyVaultUri The Key Vault uri which holds they key associated with the Log Analytics cluster. string
keyVersion The version of the key associated with the Log Analytics cluster. string

Microsoft.OperationalInsights/clusters

Name Description Value
identity The identity of the resource. Identity
location Resource location string
name The resource name string

Constraints:
Min length = 4
Max length = 4
Pattern = ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ (required)
properties Log Analytics cluster properties. ClusterProperties
sku The sku properties. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

Sku

Name Description Value
capacity The capacity value int
name The name of the SKU. 'CapacityReservation'

ARM template resource definition

The clusters 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.OperationalInsights/clusters resource, add the following JSON to your template.

{
  "type": "Microsoft.OperationalInsights/clusters",
  "apiVersion": "2019-08-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "keyVaultProperties": {
      "keyName": "string",
      "keyVaultUri": "string",
      "keyVersion": "string"
    },
    "nextLink": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ClusterProperties

Name Description Value
keyVaultProperties The associated key properties. KeyVaultProperties
nextLink The link used to get the next page of recommendations. string

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned' (required)

KeyVaultProperties

Name Description Value
keyName The name of the key associated with the Log Analytics cluster. string
keyVaultUri The Key Vault uri which holds they key associated with the Log Analytics cluster. string
keyVersion The version of the key associated with the Log Analytics cluster. string

Microsoft.OperationalInsights/clusters

Name Description Value
apiVersion The api version '2019-08-01-preview'
identity The identity of the resource. Identity
location Resource location string
name The resource name string

Constraints:
Min length = 4
Max length = 4
Pattern = ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ (required)
properties Log Analytics cluster properties. ClusterProperties
sku The sku properties. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.OperationalInsights/clusters'

ResourceTags

Name Description Value

Sku

Name Description Value
capacity The capacity value int
name The name of the SKU. 'CapacityReservation'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.OperationalInsights/clusters@2019-08-01-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      keyVaultProperties = {
        keyName = "string"
        keyVaultUri = "string"
        keyVersion = "string"
      }
      nextLink = "string"
    }
  })
}

Property values

ClusterProperties

Name Description Value
keyVaultProperties The associated key properties. KeyVaultProperties
nextLink The link used to get the next page of recommendations. string

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned' (required)

KeyVaultProperties

Name Description Value
keyName The name of the key associated with the Log Analytics cluster. string
keyVaultUri The Key Vault uri which holds they key associated with the Log Analytics cluster. string
keyVersion The version of the key associated with the Log Analytics cluster. string

Microsoft.OperationalInsights/clusters

Name Description Value
identity The identity of the resource. Identity
location Resource location string
name The resource name string

Constraints:
Min length = 4
Max length = 4
Pattern = ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ (required)
properties Log Analytics cluster properties. ClusterProperties
sku The sku properties. Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.OperationalInsights/clusters@2019-08-01-preview"

ResourceTags

Name Description Value

Sku

Name Description Value
capacity The capacity value int
name The name of the SKU. 'CapacityReservation'