Skip to main content

clusters

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

Overview​

Nameclusters
TypeResource
Idazure.kusto.clusters

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name that was checked.
messagestringMessage indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
nameAvailablebooleanSpecifies a Boolean value that indicates if the name is available.
reasonstringMessage providing the reason why the given name is invalid. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
check_name_availabilityselectlocation, subscription_idChecks that the cluster name is valid and is not already in use.
getselectresource_group_name, cluster_name, subscription_idGets a Kusto cluster.
list_by_resource_groupselectresource_group_name, subscription_idLists all Kusto clusters within a resource group.
listselectsubscription_idLists all Kusto clusters within a subscription.
create_or_updateinsertresource_group_name, cluster_name, subscription_id, location, skuCreate or update a Kusto cluster.
updateupdateresource_group_name, cluster_name, subscription_idUpdate a Kusto cluster.
create_or_updatereplaceresource_group_name, cluster_name, subscription_id, location, skuCreate or update a Kusto cluster.
deletedeleteresource_group_name, cluster_name, subscription_idDeletes a Kusto cluster.
list_follower_databases_getexecresource_group_name, cluster_name, subscription_idReturns a list of databases that are owned by this cluster and were followed by another cluster.
list_follower_databasesexecresource_group_name, cluster_name, subscription_idReturns a list of databases that are owned by this cluster and were followed by another cluster.
list_skus_by_resourceexecresource_group_name, cluster_name, subscription_idReturns the SKUs available for the provided resource.
list_outbound_network_dependencies_endpointsexecresource_group_name, cluster_name, subscription_idGets the network endpoints of all outbound dependencies of a Kusto cluster.
list_callout_policiesexecresource_group_name, cluster_name, subscription_idReturns the allowed callout policies for the specified service.
list_language_extensionsexecresource_group_name, cluster_name, subscription_idReturns a list of language extensions that can run within KQL queries.
list_skusexecsubscription_idLists eligible SKUs for Kusto resource provider.
stopexecresource_group_name, cluster_name, subscription_idStops a Kusto cluster.
startexecresource_group_name, cluster_name, subscription_idStarts a Kusto cluster.
migrateexecresource_group_name, cluster_name, subscription_id, clusterResourceIdMigrate data from a Kusto cluster to another cluster.
detach_follower_databasesexecresource_group_name, cluster_name, subscription_id, clusterResourceId, attachedDatabaseConfigurationNameDetaches all followers of a database owned by this cluster.
diagnose_virtual_networkexecresource_group_name, cluster_name, subscription_idDiagnoses network connectivity status for external resources on which the service is dependent on.
add_callout_policiesexecresource_group_name, cluster_name, subscription_id, valueAdds a list of callout policies for engine services.
remove_callout_policyexecresource_group_name, cluster_name, subscription_idRemoves callout policy for engine services.
add_language_extensionsexecresource_group_name, cluster_name, subscription_idAdd a list of language extensions that can run within KQL queries.
remove_language_extensionsexecresource_group_name, cluster_name, subscription_idRemove 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.

NameDatatypeDescription
cluster_namestringThe name of the Kusto cluster. Required.
locationstringThe location name. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

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

SELECT
name,
message,
nameAvailable,
reason
FROM azure.kusto.clusters
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create or update a Kusto cluster.

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

UPDATE examples​

Update a Kusto cluster.

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

REPLACE examples​

Create or update a Kusto cluster.

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

DELETE examples​

Deletes a Kusto cluster.

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

Lifecycle Methods​

Returns a list of databases that are owned by this cluster and were followed by another cluster.

EXEC azure.kusto.clusters.list_follower_databases_get 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;