Microsoft.OperationalInsights clusters 2022-10-01
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@2022-10-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'CapacityReservation'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
associatedWorkspaces: [
{
}
]
billingType: 'string'
capacityReservationProperties: {}
isAvailabilityZonesEnabled: bool
isDoubleEncryptionEnabled: bool
keyVaultProperties: {
keyName: 'string'
keyRsaSize: int
keyVaultUri: 'string'
keyVersion: 'string'
}
}
}
Property values
clusters
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 4-63 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. |
| 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 sku properties. | ClusterSku |
| identity | Resource's identity. | ManagedServiceIdentity |
| properties | Log Analytics cluster properties. | ClusterProperties |
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 |
UserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
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 reservation level in Gigabytes for this cluster. | int |
| name | The SKU (tier) of a cluster. | 'CapacityReservation' |
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": "2022-10-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "CapacityReservation"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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 | 'Microsoft.OperationalInsights/clusters' |
| apiVersion | The resource api version | '2022-10-01' |
| name | The resource name | string (required) Character limit: 4-63 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. |
| 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 sku properties. | ClusterSku |
| identity | Resource's identity. | ManagedServiceIdentity |
| properties | Log Analytics cluster properties. | ClusterProperties |
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 |
UserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
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 reservation level in Gigabytes for this cluster. | int |
| name | The SKU (tier) of a cluster. | '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@2022-10-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
associatedWorkspaces = [
{
}
]
billingType = "string"
capacityReservationProperties = {}
isAvailabilityZonesEnabled = bool
isDoubleEncryptionEnabled = bool
keyVaultProperties = {
keyName = "string"
keyRsaSize = int
keyVaultUri = "string"
keyVersion = "string"
}
}
sku = {
capacity = int
name = "CapacityReservation"
}
})
}
Property values
clusters
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.OperationalInsights/clusters@2022-10-01" |
| name | The resource name | string (required) Character limit: 4-63 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. |
| location | The geo-location where the resource lives | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | The sku properties. | ClusterSku |
| identity | Resource's identity. | ManagedServiceIdentity |
| properties | Log Analytics cluster properties. | ClusterProperties |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (required) |
| identity_ids | 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. | Array of user identity IDs. |
UserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
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 reservation level in Gigabytes for this cluster. | int |
| name | The SKU (tier) of a cluster. | "CapacityReservation" |