Clusters - Create Or Update

Reference

Service:: Log Analytics

API Version:: 2025-02-01

Create or update a Log Analytics cluster.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	The name of the Log Analytics cluster.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
identity		ManagedServiceIdentity	Resource's identity.
properties.associatedWorkspaces		AssociatedWorkspace[]	The list of Log Analytics workspaces associated with the cluster
properties.billingType		BillingType	The cluster's billing type.
properties.capacityReservationProperties		CapacityReservationProperties	Additional properties for capacity reservation
properties.isAvailabilityZonesEnabled		boolean	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.
properties.isDoubleEncryptionEnabled		boolean	Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'
properties.keyVaultProperties		keyVaultProperties	The associated key properties.
properties.replication		ClusterReplicationProperties	Cluster's replication properties.
sku		ClusterSku	The sku properties.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	Cluster	OK response definition.
202 Accepted		Accepted response definition (Long running operation). Headers Location: string azure-asyncoperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Name

Type

Description

200 OK

Cluster

OK response definition.

202 Accepted

Accepted response definition (Long running operation).

Headers

Location: string
azure-asyncoperation: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ClustersCreate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/clusters/oiautorest6685?api-version=2025-02-01

{
  "sku": {
    "name": "CapacityReservation",
    "capacity": 1000
  },
  "location": "eastus",
  "tags": {
    "tag1": "val1"
  }
}

Sample response

Status code:: 202

Location: https://management.azure.com/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/clusters/oiautorest6685/operationresults/c0f02ffd-0d4e-491e-a10c-fb82a1543a77?api-version=2025-02-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/providers/Microsoft.OperationalInsights/locations/eastus/operationstatuses/c0f02ffd-0d4e-491e-a10c-fb82a1543a77?api-version=2025-02-01

Status code:: 200

{
  "properties": {
    "provisioningState": "Succeeded",
    "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1",
    "billingType": "Cluster",
    "lastModifiedDate": "2020-01-13T17:40:33Z",
    "createdDate": "2020-01-13T17:40:33Z",
    "isDoubleEncryptionEnabled": true,
    "isAvailabilityZonesEnabled": true
  },
  "id": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685",
  "identity": {
    "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  },
  "sku": {
    "name": "CapacityReservation",
    "capacity": 1000
  },
  "name": "TestResourceLock",
  "type": "Microsoft.OperationalInsights/clusters",
  "location": "eastus"
}

Definitions

Name	Description
AssociatedWorkspace	The list of Log Analytics workspaces associated with the cluster.
BillingType	The cluster's billing type.
Capacity	The capacity reservation level in Gigabytes for this cluster.
CapacityReservationProperties	The Capacity Reservation properties.
Cluster	The top level Log Analytics cluster resource container.
ClusterEntityStatus	The provisioning state of the cluster.
ClusterReplicationProperties	Cluster replication properties.
ClusterReplicationState	The provisioning state of the cluster replication.
ClusterSku	The cluster sku definition.
ClusterSkuNameEnum	The SKU (tier) of a cluster.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
keyVaultProperties	The key vault properties.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentity	User assigned identity properties

AssociatedWorkspace

Object

The list of Log Analytics workspaces associated with the cluster.

Name	Type	Description
associateDate	string (date-time)	The time of workspace association.
resourceId	string (arm-id)	Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string (uuid)	Associated workspace immutable id.
workspaceName	string	Associated workspace resource name.

BillingType

Enumeration

The cluster's billing type.

Value	Description
Cluster
Workspaces

Capacity

Enumeration

The capacity reservation level in Gigabytes for this cluster.

Value	Description
100
1000
10000
200
2000
25000
300
400
500
5000
50000

CapacityReservationProperties

Object

The Capacity Reservation properties.

Name	Type	Description
lastSkuUpdate	string (date-time)	The last time Sku was updated.
minCapacity	integer (int64)	Minimum CapacityReservation value in Gigabytes.

Cluster

Object

The top level Log Analytics cluster resource container.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Resource's identity.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.associatedWorkspaces	AssociatedWorkspace[]	The list of Log Analytics workspaces associated with the cluster
properties.billingType	BillingType	The cluster's billing type.
properties.capacityReservationProperties	CapacityReservationProperties	Additional properties for capacity reservation
properties.clusterId	string	The ID associated with the cluster.
properties.createdDate	string (date-time)	The cluster creation time
properties.isAvailabilityZonesEnabled	boolean	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.
properties.isDoubleEncryptionEnabled	boolean	Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'
properties.keyVaultProperties	keyVaultProperties	The associated key properties.
properties.lastModifiedDate	string (date-time)	The last time the cluster was updated.
properties.provisioningState	ClusterEntityStatus	The provisioning state of the cluster.
properties.replication	ClusterReplicationProperties	Cluster's replication properties.
sku	ClusterSku	The sku properties.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

Enumeration

The provisioning state of the cluster.

Value	Description
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

ClusterReplicationProperties

Object

Cluster replication properties.

Name	Type	Description
createdDate	string (date-time)	The cluster's replication creation time
enabled	boolean	Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location.
isAvailabilityZonesEnabled	boolean	Should enable AvailabilityZones for the given replicated cluster
lastModifiedDate	string (date-time)	The last time the cluster's replication was updated.
location	string	The secondary location of the replication. If replication is being enabled, enabled must be provided.
provisioningState	ClusterReplicationState	The provisioning state of the cluster replication.

ClusterReplicationState

Enumeration

The provisioning state of the cluster replication.

Value	Description
Canceled
DisableRequested
Disabling
EnableRequested
Enabling
Failed
RollbackRequested
RollingBack
Succeeded

ClusterSku

Object

The cluster sku definition.

Name	Type	Description
capacity	Capacity (int64)	The capacity reservation level in Gigabytes for this cluster.
name	ClusterSkuNameEnum	The SKU (tier) of a cluster.

ClusterSkuNameEnum

Enumeration

The SKU (tier) of a cluster.

Value	Description
CapacityReservation

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

keyVaultProperties

Object

The key vault properties.

Name	Type	Description
keyName	string	The name of the key associated with the Log Analytics cluster.
keyRsaSize	integer (int32)	Selected key minimum required size.
keyVaultUri	string	The Key Vault uri which holds they key associated with the Log Analytics cluster.
keyVersion	string	The version of the key associated with the Log Analytics cluster.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities 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.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

AI Skills Fest

Share via

Clusters - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

ClustersCreate

Sample request

Sample response

Definitions

AssociatedWorkspace

BillingType

Capacity

CapacityReservationProperties

Cluster

ClusterEntityStatus

ClusterReplicationProperties

ClusterReplicationState

ClusterSku

ClusterSkuNameEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keyVaultProperties

ManagedServiceIdentity

ManagedServiceIdentityType

UserAssignedIdentity

Additional resources