clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.data_explorer.clusters

Fields

vw_clusters

Name	Datatype	Description
accepted_audiences	text	field from the properties object
allowed_fqdn_list	text	field from the properties object
allowed_ip_range_list	text	field from the properties object
clusterName	text	field from the properties object
data_ingestion_uri	text	field from the properties object
enable_auto_stop	text	field from the properties object
enable_disk_encryption	text	field from the properties object
enable_double_encryption	text	field from the properties object
enable_purge	text	field from the properties object
enable_streaming_ingest	text	field from the properties object
engine_type	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
identity	text	Identity for the resource.
key_vault_properties	text	field from the properties object
language_extensions	text	field from the properties object
location	text	The geo-location where the resource lives
migration_cluster	text	field from the properties object
optimized_autoscale	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_ip_type	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
restrict_outbound_network_access	text	field from the properties object
sku	text	Azure SKU definition.
state	text	field from the properties object
state_reason	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
trusted_external_tenants	text	field from the properties object
uri	text	field from the properties object
virtual_cluster_graduation_properties	text	field from the properties object
virtual_network_configuration	text	field from the properties object
zones	text	An array represents the availability zones of the cluster.

clusters

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	Class representing the Kusto cluster properties.
sku	object	Azure SKU definition.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
zones	array	An array represents the availability zones of the cluster.

Methods

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

SELECT examples

Lists all Kusto clusters within a subscription.

vw_clusters

SELECT
accepted_audiences,
allowed_fqdn_list,
allowed_ip_range_list,
clusterName,
data_ingestion_uri,
enable_auto_stop,
enable_disk_encryption,
enable_double_encryption,
enable_purge,
enable_streaming_ingest,
engine_type,
etag,
identity,
key_vault_properties,
language_extensions,
location,
migration_cluster,
optimized_autoscale,
private_endpoint_connections,
provisioning_state,
public_ip_type,
public_network_access,
resourceGroupName,
restrict_outbound_network_access,
sku,
state,
state_reason,
subscriptionId,
system_data,
tags,
trusted_external_tenants,
uri,
virtual_cluster_graduation_properties,
virtual_network_configuration,
zones
FROM azure.data_explorer.vw_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

clusters

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

INSERT example

Use the following StackQL query and manifest file to create a new clusters resource.

All Properties

/*+ create */
INSERT INTO azure.data_explorer.clusters (
clusterName,
resourceGroupName,
subscriptionId,
data__sku,
sku,
zones,
identity,
properties,
tags,
location
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__sku }}',
'{{ sku }}',
'{{ zones }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: capacity
          value: integer
        - name: tier
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: zones
      value: []
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
    - name: properties
      value:
        - name: state
          value: string
        - name: provisioningState
          value: []
        - name: uri
          value: string
        - name: dataIngestionUri
          value: string
        - name: stateReason
          value: string
        - name: trustedExternalTenants
          value:
            - - name: value
                value: string
        - name: optimizedAutoscale
          value:
            - name: version
              value: integer
            - name: isEnabled
              value: boolean
            - name: minimum
              value: integer
            - name: maximum
              value: integer
        - name: enableDiskEncryption
          value: boolean
        - name: enableStreamingIngest
          value: boolean
        - name: virtualNetworkConfiguration
          value:
            - name: subnetId
              value: string
            - name: enginePublicIpId
              value: string
            - name: dataManagementPublicIpId
              value: string
            - name: state
              value: string
        - name: keyVaultProperties
          value:
            - name: keyIdentifier
              value: string
            - name: identity
              value: string
        - name: enablePurge
          value: boolean
        - name: languageExtensions
          value:
            - name: value
              value:
                - - name: languageExtensionName
                    value: []
                  - name: languageExtensionImageName
                    value: []
                  - name: languageExtensionCustomImageName
                    value: []
        - name: enableDoubleEncryption
          value: boolean
        - name: publicNetworkAccess
          value: string
        - name: allowedIpRangeList
          value:
            - string
        - name: engineType
          value: string
        - name: acceptedAudiences
          value:
            - - name: value
                value: string
        - name: enableAutoStop
          value: boolean
        - name: restrictOutboundNetworkAccess
          value: string
        - name: allowedFqdnList
          value:
            - string
        - name: publicIPType
          value: string
        - name: virtualClusterGraduationProperties
          value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: groupId
                    value: string
                  - name: provisioningState
                    value: string
        - name: migrationCluster
          value:
            - name: id
              value: string
            - name: uri
              value: string
            - name: dataIngestionUri
              value: string
            - name: role
              value: string
    - name: etag
      value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE azure.data_explorer.clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
zones = '{{ zones }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified clusters resource.

/*+ delete */
DELETE FROM azure.data_explorer.clusters
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';