clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	azure.log_analytics.clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associatedWorkspaces	array	The list of Log Analytics workspaces associated with the cluster.
billingType	string	The cluster's billing type. Known values are: "Cluster" and "Workspaces". (Cluster, Workspaces)
capacityReservationProperties	object	Additional properties for capacity reservation.
clusterId	string	The ID associated with the cluster.
createdDate	string (date-time)	The cluster creation time.
identity	object	The managed service identities assigned to this resource.
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.
isDoubleEncryptionEnabled	boolean	Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'.
keyVaultProperties	object	The associated key properties.
lastModifiedDate	string (date-time)	The last time the cluster was updated.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the cluster. Known values are: "Creating", "Succeeded", "Failed", "Canceled", "Deleting", "ProvisioningAccount", and "Updating". (Creating, Succeeded, Failed, Canceled, Deleting, ProvisioningAccount, Updating)
replication	object	Cluster's replication properties.
sku	object	The sku properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associatedWorkspaces	array	The list of Log Analytics workspaces associated with the cluster.
billingType	string	The cluster's billing type. Known values are: "Cluster" and "Workspaces". (Cluster, Workspaces)
capacityReservationProperties	object	Additional properties for capacity reservation.
clusterId	string	The ID associated with the cluster.
createdDate	string (date-time)	The cluster creation time.
identity	object	The managed service identities assigned to this resource.
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.
isDoubleEncryptionEnabled	boolean	Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'.
keyVaultProperties	object	The associated key properties.
lastModifiedDate	string (date-time)	The last time the cluster was updated.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the cluster. Known values are: "Creating", "Succeeded", "Failed", "Canceled", "Deleting", "ProvisioningAccount", and "Updating". (Creating, Succeeded, Failed, Canceled, Deleting, ProvisioningAccount, Updating)
replication	object	Cluster's replication properties.
sku	object	The sku properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associatedWorkspaces	array	The list of Log Analytics workspaces associated with the cluster.
billingType	string	The cluster's billing type. Known values are: "Cluster" and "Workspaces". (Cluster, Workspaces)
capacityReservationProperties	object	Additional properties for capacity reservation.
clusterId	string	The ID associated with the cluster.
createdDate	string (date-time)	The cluster creation time.
identity	object	The managed service identities assigned to this resource.
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.
isDoubleEncryptionEnabled	boolean	Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'.
keyVaultProperties	object	The associated key properties.
lastModifiedDate	string (date-time)	The last time the cluster was updated.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the cluster. Known values are: "Creating", "Succeeded", "Failed", "Canceled", "Deleting", "ProvisioningAccount", and "Updating". (Creating, Succeeded, Failed, Canceled, Deleting, ProvisioningAccount, Updating)
replication	object	Cluster's replication properties.
sku	object	The sku properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Gets a Log Analytics cluster instance.
list_by_resource_group	select	resource_group_name, subscription_id		Gets Log Analytics clusters in a resource group.
list	select	subscription_id		Gets the Log Analytics clusters in a subscription.
create_or_update	insert	resource_group_name, cluster_name, subscription_id, location		Create or update a Log Analytics cluster.
update	update	resource_group_name, cluster_name, subscription_id		Updates a Log Analytics cluster.
create_or_update	replace	resource_group_name, cluster_name, subscription_id, location		Create or update a Log Analytics cluster.
delete	delete	resource_group_name, cluster_name, subscription_id		Deletes a cluster instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	Name of the Log Analytics Cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a Log Analytics cluster instance.

SELECT
id,
name,
associatedWorkspaces,
billingType,
capacityReservationProperties,
clusterId,
createdDate,
identity,
isAvailabilityZonesEnabled,
isDoubleEncryptionEnabled,
keyVaultProperties,
lastModifiedDate,
location,
provisioningState,
replication,
sku,
systemData,
tags,
type
FROM azure.log_analytics.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets Log Analytics clusters in a resource group.

SELECT
id,
name,
associatedWorkspaces,
billingType,
capacityReservationProperties,
clusterId,
createdDate,
identity,
isAvailabilityZonesEnabled,
isDoubleEncryptionEnabled,
keyVaultProperties,
lastModifiedDate,
location,
provisioningState,
replication,
sku,
systemData,
tags,
type
FROM azure.log_analytics.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the Log Analytics clusters in a subscription.

SELECT
id,
name,
associatedWorkspaces,
billingType,
capacityReservationProperties,
clusterId,
createdDate,
identity,
isAvailabilityZonesEnabled,
isDoubleEncryptionEnabled,
keyVaultProperties,
lastModifiedDate,
location,
provisioningState,
replication,
sku,
systemData,
tags,
type
FROM azure.log_analytics.clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Log Analytics cluster.

INSERT INTO azure.log_analytics.clusters (
tags,
location,
properties,
identity,
sku,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the clusters resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Log Analytics cluster properties.
    value:
      clusterId: "{{ clusterId }}"
      provisioningState: "{{ provisioningState }}"
      isDoubleEncryptionEnabled: {{ isDoubleEncryptionEnabled }}
      isAvailabilityZonesEnabled: {{ isAvailabilityZonesEnabled }}
      billingType: "{{ billingType }}"
      keyVaultProperties:
        keyVaultUri: "{{ keyVaultUri }}"
        keyName: "{{ keyName }}"
        keyVersion: "{{ keyVersion }}"
        keyRsaSize: {{ keyRsaSize }}
      lastModifiedDate: "{{ lastModifiedDate }}"
      createdDate: "{{ createdDate }}"
      associatedWorkspaces:
        - workspaceId: "{{ workspaceId }}"
          workspaceName: "{{ workspaceName }}"
          resourceId: "{{ resourceId }}"
          associateDate: "{{ associateDate }}"
      capacityReservationProperties:
        lastSkuUpdate: "{{ lastSkuUpdate }}"
        minCapacity: {{ minCapacity }}
      replication:
        location: "{{ location }}"
        enabled: {{ enabled }}
        isAvailabilityZonesEnabled: {{ isAvailabilityZonesEnabled }}
        provisioningState: "{{ provisioningState }}"
        createdDate: "{{ createdDate }}"
        lastModifiedDate: "{{ lastModifiedDate }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      The sku properties.
    value:
      capacity: {{ capacity }}
      name: "{{ name }}"

UPDATE examples

update

Updates a Log Analytics cluster.

UPDATE azure.log_analytics.clusters
SET 
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a Log Analytics cluster.

REPLACE azure.log_analytics.clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a cluster instance.

DELETE FROM azure.log_analytics.clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;