az kusto cluster

Kusto cluster.

Commands

az kusto cluster add-language-extension

Add a list of language extensions that can run within KQL queries.
az kusto cluster create

Create or update a Kusto cluster.
az kusto cluster delete

Deletes a Kusto cluster.
az kusto cluster detach-follower-database

Detaches all followers of a database owned by this cluster.
az kusto cluster diagnose-virtual-network

Diagnoses network connectivity status for external resources on which the service is dependent on.
az kusto cluster list

Lists all Kusto clusters within a subscription.
az kusto cluster list-follower-database

Returns a list of databases that are owned by this cluster and were followed by another cluster.
az kusto cluster list-language-extension

Returns a list of language extensions that can run within KQL queries.
az kusto cluster list-sku

Lists eligible SKUs for Kusto resource provider.
az kusto cluster remove-language-extension

Remove a list of language extensions that can run within KQL queries.
az kusto cluster show

Gets a Kusto cluster.
az kusto cluster start

Starts a Kusto cluster.
az kusto cluster stop

Stops a Kusto cluster.
az kusto cluster update

Update a Kusto cluster.
az kusto cluster wait

Place the CLI in a waiting state until a condition of the kusto cluster is met.

az kusto cluster add-language-extension

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

az kusto cluster add-language-extension --cluster-name
                                        --resource-group
                                        [--no-wait]
                                        [--value]

Examples

KustoClusterAddLanguageExtensions

az kusto cluster add-language-extension --cluster-name "kustoclusterrptest4" --value language-extension-name="PYTHON" --value language-extension-name="R" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--value

The list of language extensions.

az kusto cluster create

Create or update a Kusto cluster.

az kusto cluster create --cluster-name
                        --location
                        --resource-group
                        --sku
                        [--enable-disk-encryption {false, true}]
                        [--enable-double-encryption {false, true}]
                        [--enable-purge {false, true}]
                        [--enable-streaming-ingest {false, true}]
                        [--identity-type {None, SystemAssigned}]
                        [--identity-user-assigned-identities]
                        [--key-vault-properties]
                        [--no-wait]
                        [--optimized-autoscale]
                        [--tags]
                        [--trusted-external-tenants]
                        [--virtual-network-configuration]
                        [--zones]

Examples

KustoClustersCreateOrUpdate

az kusto cluster create --cluster-name "kustoclusterrptest4" --identity-type "SystemAssigned" --location "westus" --enable-double-encryption false --enable-purge true --enable-streaming-ingest true --sku name="Standard_L8s" capacity=2 tier="Standard" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku

The SKU of the cluster.

Optional Parameters

--enable-disk-encryption

A boolean value that indicates if the cluster's disks are encrypted.

accepted values: false, true
--enable-double-encryption

A boolean value that indicates if double encryption is enabled.

accepted values: false, true
--enable-purge

A boolean value that indicates if the purge operations are enabled.

accepted values: false, true
--enable-streaming-ingest

A boolean value that indicates if the streaming ingest is enabled.

accepted values: false, true
--identity-type

The identity type.

accepted values: None, SystemAssigned
--identity-user-assigned-identities

The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Expected value: json-string/@json-file.

--key-vault-properties

KeyVault properties for the cluster encryption.

--no-wait

Do not wait for the long-running operation to finish.

--optimized-autoscale

Optimized auto scale definition.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--trusted-external-tenants

The cluster's external tenants.

--virtual-network-configuration

Virtual network definition.

--zones

The availability zones of the cluster.

az kusto cluster delete

Deletes a Kusto cluster.

az kusto cluster delete --cluster-name
                        --resource-group
                        [--no-wait]

Examples

KustoClustersDelete

az kusto cluster delete --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az kusto cluster detach-follower-database

Detaches all followers of a database owned by this cluster.

az kusto cluster detach-follower-database --attached-database-configuration-name
                                          --cluster-name
                                          --cluster-resource-id
                                          --resource-group
                                          [--no-wait]

Examples

KustoClusterDetachFollowerDatabases

az kusto cluster detach-follower-database --cluster-name "kustoclusterrptest4" --attached-database-configuration-name "myAttachedDatabaseConfiguration" --cluster-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/leader4" --resource-group "kustorptest"

Required Parameters

--attached-database-configuration-name

Resource name of the attached database configuration in the follower cluster.

--cluster-name

The name of the Kusto cluster.

--cluster-resource-id

Resource id of the cluster that follows a database owned by this cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az kusto cluster diagnose-virtual-network

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

az kusto cluster diagnose-virtual-network --cluster-name
                                          --resource-group
                                          [--no-wait]

Examples

KustoClusterDiagnoseVirtualNetwork

az kusto cluster diagnose-virtual-network --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az kusto cluster list

Lists all Kusto clusters within a subscription.

az kusto cluster list [--resource-group]

Examples

KustoClustersListByResourceGroup

az kusto cluster list --resource-group "kustorptest"

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az kusto cluster list-follower-database

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

az kusto cluster list-follower-database --cluster-name
                                        --resource-group

Examples

KustoClusterListFollowerDatabases

az kusto cluster list-follower-database --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az kusto cluster list-language-extension

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

az kusto cluster list-language-extension --cluster-name
                                         --resource-group

Examples

KustoClusterListLanguageExtensions

az kusto cluster list-language-extension --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az kusto cluster list-sku

Lists eligible SKUs for Kusto resource provider.

az kusto cluster list-sku [--cluster-name]
                          [--resource-group]

Examples

KustoClustersListResourceSkus

az kusto cluster list-sku --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az kusto cluster remove-language-extension

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

az kusto cluster remove-language-extension --cluster-name
                                           --resource-group
                                           [--no-wait]
                                           [--value]

Examples

KustoClusterRemoveLanguageExtensions

az kusto cluster remove-language-extension --cluster-name "kustoclusterrptest4" --value language-extension-name="PYTHON" --value language-extension-name="R" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--value

The list of language extensions.

az kusto cluster show

Gets a Kusto cluster.

az kusto cluster show --cluster-name
                      --resource-group

Examples

KustoClustersGet

az kusto cluster show --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az kusto cluster start

Starts a Kusto cluster.

az kusto cluster start --cluster-name
                       --resource-group
                       [--no-wait]

Examples

KustoClustersStart

az kusto cluster start --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az kusto cluster stop

Stops a Kusto cluster.

az kusto cluster stop --cluster-name
                      --resource-group
                      [--no-wait]

Examples

KustoClustersStop

az kusto cluster stop --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az kusto cluster update

Update a Kusto cluster.

az kusto cluster update --cluster-name
                        --resource-group
                        [--enable-disk-encryption {false, true}]
                        [--enable-double-encryption {false, true}]
                        [--enable-purge {false, true}]
                        [--enable-streaming-ingest {false, true}]
                        [--identity-type {None, SystemAssigned}]
                        [--identity-user-assigned-identities]
                        [--key-vault-properties]
                        [--location]
                        [--no-wait]
                        [--optimized-autoscale]
                        [--sku]
                        [--tags]
                        [--trusted-external-tenants]
                        [--virtual-network-configuration]

Examples

KustoClustersUpdate

az kusto cluster update --cluster-name "kustoclusterrptest4" --identity-type "SystemAssigned" --location "westus" --enable-purge true --enable-streaming-ingest true --key-vault-properties key-name="keyName" key-vault-uri="https://dummy.keyvault.com" key-version="keyVersion" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--enable-disk-encryption

A boolean value that indicates if the cluster's disks are encrypted.

accepted values: false, true
--enable-double-encryption

A boolean value that indicates if double encryption is enabled.

accepted values: false, true
--enable-purge

A boolean value that indicates if the purge operations are enabled.

accepted values: false, true
--enable-streaming-ingest

A boolean value that indicates if the streaming ingest is enabled.

accepted values: false, true
--identity-type

The identity type.

accepted values: None, SystemAssigned
--identity-user-assigned-identities

The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Expected value: json-string/@json-file.

--key-vault-properties

KeyVault properties for the cluster encryption.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

--optimized-autoscale

Optimized auto scale definition.

--sku

The SKU of the cluster.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--trusted-external-tenants

The cluster's external tenants.

--virtual-network-configuration

Virtual network definition.

az kusto cluster wait

Place the CLI in a waiting state until a condition of the kusto cluster is met.

az kusto cluster wait --cluster-name
                      --resource-group
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--interval]
                      [--timeout]
                      [--updated]

Examples

Pause executing next line of CLI script until the kusto cluster is successfully created.

az kusto cluster wait --cluster-name "kustoclusterrptest4" --resource-group "kustorptest" --created

Pause executing next line of CLI script until the kusto cluster is successfully updated.

az kusto cluster wait --cluster-name "kustoclusterrptest4" --resource-group "kustorptest" --updated

Pause executing next line of CLI script until the kusto cluster is successfully deleted.

az kusto cluster wait --cluster-name "kustoclusterrptest4" --resource-group "kustorptest" --deleted

Required Parameters

--cluster-name

The name of the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.