Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The clusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2025-02-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'
}
replication: {
enabled: bool
isAvailabilityZonesEnabled: bool
___location: 'string'
}
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
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 |
| replication | Cluster's replication properties. | ClusterReplicationProperties |
ClusterReplicationProperties
| Name | Description | Value |
|---|---|---|
| enabled | Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified ___location. | bool |
| isAvailabilityZonesEnabled | Should enable AvailabilityZones for the given replicated cluster | bool |
| ___location | The secondary ___location of the replication. If replication is being enabled, enabled must be provided. | string |
ClusterSku
| Name | Description | Value |
|---|---|---|
| capacity | The capacity reservation level in Gigabytes for this cluster. | int |
| name | The SKU (tier) of a cluster. | 'CapacityReservation' |
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 |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.OperationalInsights/clusters
| Name | Description | Value |
|---|---|---|
| identity | Resource's identity. | ManagedServiceIdentity |
| ___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 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The clusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2025-02-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"
},
"replication": {
"enabled": "bool",
"isAvailabilityZonesEnabled": "bool",
"___location": "string"
}
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
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 |
| replication | Cluster's replication properties. | ClusterReplicationProperties |
ClusterReplicationProperties
| Name | Description | Value |
|---|---|---|
| enabled | Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified ___location. | bool |
| isAvailabilityZonesEnabled | Should enable AvailabilityZones for the given replicated cluster | bool |
| ___location | The secondary ___location of the replication. If replication is being enabled, enabled must be provided. | string |
ClusterSku
| Name | Description | Value |
|---|---|---|
| capacity | The capacity reservation level in Gigabytes for this cluster. | int |
| name | The SKU (tier) of a cluster. | 'CapacityReservation' |
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 |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.OperationalInsights/clusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-02-01' |
| identity | Resource's identity. | ManagedServiceIdentity |
| ___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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| 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@2025-02-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"
}
replication = {
enabled = bool
isAvailabilityZonesEnabled = bool
___location = "string"
}
}
sku = {
capacity = int
name = "string"
}
}
}
Property Values
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 |
| replication | Cluster's replication properties. | ClusterReplicationProperties |
ClusterReplicationProperties
| Name | Description | Value |
|---|---|---|
| enabled | Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified ___location. | bool |
| isAvailabilityZonesEnabled | Should enable AvailabilityZones for the given replicated cluster | bool |
| ___location | The secondary ___location of the replication. If replication is being enabled, enabled must be provided. | string |
ClusterSku
| Name | Description | Value |
|---|---|---|
| capacity | The capacity reservation level in Gigabytes for this cluster. | int |
| name | The SKU (tier) of a cluster. | 'CapacityReservation' |
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 |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.OperationalInsights/clusters
| Name | Description | Value |
|---|---|---|
| identity | Resource's identity. | ManagedServiceIdentity |
| ___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@2025-02-01" |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|