Microsoft.OperationalInsights clusters 2020-10-01

The clusters resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.OperationalInsights/clusters resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.OperationalInsights/clusters@2020-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'CapacityReservation'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    associatedWorkspaces: [
      {
      }
    ]
    billingType: 'string'
    capacityReservationProperties: {}
    isAvailabilityZonesEnabled: bool
    isDoubleEncryptionEnabled: bool
    keyVaultProperties: {
      keyName: 'string'
      keyRsaSize: int
      keyVaultUri: 'string'
      keyVersion: 'string'
    }
  }
}

Property values

clusters

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.OperationalInsights/clusters'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-10-01'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The cluster sku definition. ClusterSku
identity Identity for the resource. Identity
properties Cluster properties. ClusterProperties

Identity

Name Description Value
type Type of managed service identity. 'None'
'SystemAssigned'
'UserAssigned'
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}'. object

ClusterProperties

Name Description Value
associatedWorkspaces The list of Log Analytics workspaces associated with the cluster AssociatedWorkspace[]
billingType Configures whether billing will be only on the cluster or each workspace will be billed by its proportional use. This does not change the overall billing, only how it will be distributed. Default value is 'Cluster' 'Cluster'
'Workspaces'
capacityReservationProperties The Capacity Reservation properties. 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 key vault properties. KeyVaultProperties

AssociatedWorkspace

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

CapacityReservationProperties

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

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

ClusterSku

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