Share via


Microsoft.OperationalInsights clusters 2020-10-01

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@2020-10-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    associatedWorkspaces: [
      {}
    ]
    billingType: 'string'
    capacityReservationProperties: {}
    isAvailabilityZonesEnabled: bool
    isDoubleEncryptionEnabled: bool
    keyVaultProperties: {
      keyName: 'string'
      keyRsaSize: int
      keyVaultUri: 'string'
      keyVersion: 'string'
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.OperationalInsights/clusters

Name Description Value
identity The identity of the resource. Identity
location The geo-location where the resource lives string (required)
name The resource name string

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

AssociatedWorkspace

Name Description Value

CapacityReservationProperties

Name Description Value

ClusterProperties

Name Description Value
associatedWorkspaces The list of Log Analytics workspaces associated with the cluster AssociatedWorkspace[]
billingType The cluster's billing type. 'Cluster'
'Workspaces'
capacityReservationProperties Additional properties for capacity reservation CapacityReservationProperties
isAvailabilityZonesEnabled Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. bool
isDoubleEncryptionEnabled Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' bool
keyVaultProperties The associated key properties. KeyVaultProperties

ClusterSku

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

Identity

Name Description Value
type Type of managed service identity. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name Description Value

KeyVaultProperties

Name Description Value
keyName The name of the key associated with the Log Analytics cluster. string
keyRsaSize Selected key minimum required size. int
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

TrackedResourceTags

Name Description Value

UserIdentityProperties

Name Description Value

Usage Examples

Bicep Samples

A basic example of deploying Log Analytics Cluster.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource cluster 'Microsoft.OperationalInsights/clusters@2020-08-01' = {
  name: resourceName
  location: location
  sku: {
    capacity: 1000
    name: 'CapacityReservation'
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Log Analytics Dedicated Cluster AVM Resource Module for Log Analytics Dedicated Cluster

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": "2020-10-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "associatedWorkspaces": [
      {
      }
    ],
    "billingType": "string",
    "capacityReservationProperties": {
    },
    "isAvailabilityZonesEnabled": "bool",
    "isDoubleEncryptionEnabled": "bool",
    "keyVaultProperties": {
      "keyName": "string",
      "keyRsaSize": "int",
      "keyVaultUri": "string",
      "keyVersion": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.OperationalInsights/clusters

Name Description Value
apiVersion The api version '2020-10-01'
identity The identity of the resource. Identity
location The geo-location where the resource lives string (required)
name The resource name string

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

AssociatedWorkspace

Name Description Value

CapacityReservationProperties

Name Description Value

ClusterProperties

Name Description Value
associatedWorkspaces The list of Log Analytics workspaces associated with the cluster AssociatedWorkspace[]
billingType The cluster's billing type. 'Cluster'
'Workspaces'
capacityReservationProperties Additional properties for capacity reservation CapacityReservationProperties
isAvailabilityZonesEnabled Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. bool
isDoubleEncryptionEnabled Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' bool
keyVaultProperties The associated key properties. KeyVaultProperties

ClusterSku

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

Identity

Name Description Value
type Type of managed service identity. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name Description Value

KeyVaultProperties

Name Description Value
keyName The name of the key associated with the Log Analytics cluster. string
keyRsaSize Selected key minimum required size. int
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

TrackedResourceTags

Name Description Value

UserIdentityProperties

Name Description Value

Usage Examples

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@2020-10-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      associatedWorkspaces = [
        {
        }
      ]
      billingType = "string"
      capacityReservationProperties = {
      }
      isAvailabilityZonesEnabled = bool
      isDoubleEncryptionEnabled = bool
      keyVaultProperties = {
        keyName = "string"
        keyRsaSize = int
        keyVaultUri = "string"
        keyVersion = "string"
      }
    }
    sku = {
      capacity = int
      name = "string"
    }
  }
}

Property Values

Microsoft.OperationalInsights/clusters

Name Description Value
identity The identity of the resource. Identity
location The geo-location where the resource lives string (required)
name The resource name string

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

AssociatedWorkspace

Name Description Value

CapacityReservationProperties

Name Description Value

ClusterProperties

Name Description Value
associatedWorkspaces The list of Log Analytics workspaces associated with the cluster AssociatedWorkspace[]
billingType The cluster's billing type. 'Cluster'
'Workspaces'
capacityReservationProperties Additional properties for capacity reservation CapacityReservationProperties
isAvailabilityZonesEnabled Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. bool
isDoubleEncryptionEnabled Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' bool
keyVaultProperties The associated key properties. KeyVaultProperties

ClusterSku

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

Identity

Name Description Value
type Type of managed service identity. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name Description Value

KeyVaultProperties

Name Description Value
keyName The name of the key associated with the Log Analytics cluster. string
keyRsaSize Selected key minimum required size. int
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

TrackedResourceTags

Name Description Value

UserIdentityProperties

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Log Analytics Cluster.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "cluster" {
  type      = "Microsoft.OperationalInsights/clusters@2020-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    sku = {
      capacity = 1000
      name     = "CapacityReservation"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}