clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.data_explorer.clusters

Fields

The following fields are returned by SELECT queries:

get

The Kusto cluster.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of the cluster, if configured.
location	string	The geo-location where the resource lives
properties	object	The cluster properties.
sku	object	The SKU of the cluster.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
zones	array	The availability zones of the cluster.

list_by_resource_group

OK.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of the cluster, if configured.
location	string	The geo-location where the resource lives
properties	object	The cluster properties.
sku	object	The SKU of the cluster.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
zones	array	The availability zones of the cluster.

list

OK.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of the cluster, if configured.
location	string	The geo-location where the resource lives
properties	object	The cluster properties.
sku	object	The SKU of the cluster.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
zones	array	The availability zones of the cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, clusterName, subscriptionId		Gets a Kusto cluster.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all Kusto clusters within a resource group.
list	select	subscriptionId		Lists all Kusto clusters within a subscription.
create_or_update	insert	resourceGroupName, clusterName, subscriptionId, data__sku	If-Match, If-None-Match	Create or update a Kusto cluster.
update	update	resourceGroupName, clusterName, subscriptionId	If-Match	Update a Kusto cluster.
delete	delete	resourceGroupName, clusterName, subscriptionId		Deletes a Kusto cluster.
stop	exec	resourceGroupName, clusterName, subscriptionId		Stops a Kusto cluster.
start	exec	resourceGroupName, clusterName, subscriptionId		Starts a Kusto cluster.
migrate	exec	resourceGroupName, clusterName, subscriptionId, clusterResourceId		Migrate data from a Kusto cluster to another cluster.
detach_follower_databases	exec	resourceGroupName, clusterName, subscriptionId, clusterResourceId, attachedDatabaseConfigurationName		Detaches all followers of a database owned by this cluster.
diagnose_virtual_network	exec	resourceGroupName, clusterName, subscriptionId		Diagnoses network connectivity status for external resources on which the service is dependent on.
check_name_availability	exec	subscriptionId, location, name, type		Checks that the cluster name is valid and is not already in use.
add_language_extensions	exec	subscriptionId, resourceGroupName, clusterName		Add a list of language extensions that can run within KQL queries.
remove_language_extensions	exec	subscriptionId, resourceGroupName, clusterName		Remove a list of language extensions that can run within KQL queries.

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
clusterName	string	The name of the Kusto cluster.
location	string	The name of Azure region.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
If-Match	string	The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match	string	Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. Other values will result in a 412 Pre-condition Failed response.

SELECT examples

get

Gets a Kusto cluster.

SELECT
etag,
identity,
location,
properties,
sku,
systemData,
tags,
zones
FROM azure.data_explorer.clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all Kusto clusters within a resource group.

SELECT
etag,
identity,
location,
properties,
sku,
systemData,
tags,
zones
FROM azure.data_explorer.clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all Kusto clusters within a subscription.

SELECT
etag,
identity,
location,
properties,
sku,
systemData,
tags,
zones
FROM azure.data_explorer.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a Kusto cluster.

INSERT INTO azure.data_explorer.clusters (
data__sku,
data__zones,
data__identity,
data__properties,
data__tags,
data__location,
resourceGroupName,
clusterName,
subscriptionId,
If-Match,
If-None-Match
)
SELECT 
'{{ sku }}' /* required */,
'{{ zones }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ subscriptionId }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
identity,
location,
properties,
sku,
systemData,
tags,
zones
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the clusters resource.
    - name: sku
      value: object
      description: |
        The SKU of the cluster.
    - name: zones
      value: array
      description: |
        The availability zones of the cluster.
    - name: identity
      value: object
      description: |
        The identity of the cluster, if configured.
    - name: properties
      value: object
      description: |
        The cluster properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: If-Match
      value: string
      description: The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. Other values will result in a 412 Pre-condition Failed response.

UPDATE examples

update

Update a Kusto cluster.

UPDATE azure.data_explorer.clusters
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__sku = '{{ sku }}',
data__zones = '{{ zones }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
etag,
identity,
location,
properties,
sku,
systemData,
tags,
zones;

DELETE examples

delete

Deletes a Kusto cluster.

DELETE FROM azure.data_explorer.clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

stop

Stops a Kusto cluster.

EXEC azure.data_explorer.clusters.stop 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

start

Starts a Kusto cluster.

EXEC azure.data_explorer.clusters.start 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

migrate

Migrate data from a Kusto cluster to another cluster.

EXEC azure.data_explorer.clusters.migrate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"clusterResourceId": "{{ clusterResourceId }}"
}'
;

detach_follower_databases

Detaches all followers of a database owned by this cluster.

EXEC azure.data_explorer.clusters.detach_follower_databases 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"clusterResourceId": "{{ clusterResourceId }}", 
"attachedDatabaseConfigurationName": "{{ attachedDatabaseConfigurationName }}"
}'
;

diagnose_virtual_network

Diagnoses network connectivity status for external resources on which the service is dependent on.

EXEC azure.data_explorer.clusters.diagnose_virtual_network 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

check_name_availability

Checks that the cluster name is valid and is not already in use.

EXEC azure.data_explorer.clusters.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

add_language_extensions

Add a list of language extensions that can run within KQL queries.

EXEC azure.data_explorer.clusters.add_language_extensions 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;

remove_language_extensions

Remove a list of language extensions that can run within KQL queries.

EXEC azure.data_explorer.clusters.remove_language_extensions 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;