az kusto cluster

Manage Azure Kusto clusters.

This module will not be supported starting January 1, 2021. Please execute "az extension add -n kusto" to install the supported Kusto extension.

Commands

az kusto cluster add-language-extension

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

az kusto cluster create

Create a Kusto cluster.

az kusto cluster delete

Delete 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

List a Kusto cluster.

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

Returns the SKUs available for the provided resource. And 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

Get a Kusto cluster.

az kusto cluster start

Start a Kusto cluster.

az kusto cluster stop

Stop a Kusto cluster.

az kusto cluster update

Update a Kusto cluster.

az kusto cluster wait

Wait for a managed Kusto cluster to reach a desired state.

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 --name "kustoclusterrptest4" --value language-extension-name="PYTHON" --value language-extension-name="R" --resource-group "kustorptest"

Required Parameters

--cluster-name --name -n

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 a Kusto cluster.

az kusto cluster create --name
                        --resource-group
                        --sku {Dev(No SLA)_Standard_D11_v2, Dev(No SLA)_Standard_E2a_v4, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_DS13_v2+1TB_PS, Standard_DS13_v2+2TB_PS, Standard_DS14_v2+3TB_PS, Standard_DS14_v2+4TB_PS, Standard_E16a_v4, Standard_E16as_v4+3TB_PS, Standard_E16as_v4+4TB_PS, Standard_E2a_v4, Standard_E4a_v4, Standard_E8a_v4, Standard_E8as_v4+1TB_PS, Standard_E8as_v4+2TB_PS, Standard_L16s, Standard_L4s, Standard_L8s}
                        [--capacity]
                        [--location]
                        [--no-wait]
                        [--subscription]

Examples

Create a Kusto Cluster.

az kusto cluster create -l "Central US" -n myclustername -g myrgname --sku D13_v2 --capacity 10

Required Parameters

--name -n

The name of the cluster.

--resource-group -g

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

--sku

The name of the sku.

accepted values: Dev(No SLA)_Standard_D11_v2, Dev(No SLA)_Standard_E2a_v4, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_DS13_v2+1TB_PS, Standard_DS13_v2+2TB_PS, Standard_DS14_v2+3TB_PS, Standard_DS14_v2+4TB_PS, Standard_E16a_v4, Standard_E16as_v4+3TB_PS, Standard_E16as_v4+4TB_PS, Standard_E2a_v4, Standard_E4a_v4, Standard_E8a_v4, Standard_E8as_v4+1TB_PS, Standard_E8as_v4+2TB_PS, Standard_L16s, Standard_L4s, Standard_L8s

Optional Parameters

--capacity

The instance number of the VM.

--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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az kusto cluster delete

Delete a Kusto cluster.

az kusto cluster delete [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--yes]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the cluster.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

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 --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 --name -n

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 --name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name --name -n

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

List a Kusto cluster.

az kusto cluster list --resource-group
                      [--query-examples]
                      [--subscription]

Examples

List a Kusto cluster. (autogenerated)

az kusto cluster list --resource-group MyResourceGroup

Required Parameters

--resource-group -g

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 --name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name --name -n

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 --name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name --name -n

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

Returns the SKUs available for the provided resource. And Lists eligible SKUs for Kusto resource provider.

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

Examples

KustoClustersListResourceSkus

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

KustoClustersListSkus

az kusto cluster list-sku

Optional Parameters

--cluster-name --name -n

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 --name "kustoclusterrptest4" --value language-extension-name="PYTHON" --value language-extension-name="R" --resource-group "kustorptest"

Required Parameters

--cluster-name --name -n

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

Get a Kusto cluster.

az kusto cluster show [--ids]
                      [--name]
                      [--query-examples]
                      [--resource-group]
                      [--subscription]

Examples

Get a Kusto cluster. (autogenerated)

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the cluster.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az kusto cluster start

Start a Kusto cluster.

When the cluster is restarted, it takes about ten minutes for it to become available (like when it was originally provisioned). It takes additional time for data to load into the hot cache.

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the cluster.

--no-wait

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

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az kusto cluster stop

Stop a Kusto cluster.

When the cluster is stopped, data is not available for queries, and you can't ingest new data. Start cluster to enable queries.

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the cluster.

--no-wait

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

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az kusto cluster update

Update a Kusto cluster.

az kusto cluster update [--add]
                        [--capacity]
                        [--force-string]
                        [--ids]
                        [--name]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--sku {Dev(No SLA)_Standard_D11_v2, Dev(No SLA)_Standard_E2a_v4, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_DS13_v2+1TB_PS, Standard_DS13_v2+2TB_PS, Standard_DS14_v2+3TB_PS, Standard_DS14_v2+4TB_PS, Standard_E16a_v4, Standard_E16as_v4+3TB_PS, Standard_E16as_v4+4TB_PS, Standard_E2a_v4, Standard_E4a_v4, Standard_E8a_v4, Standard_E8as_v4+1TB_PS, Standard_E8as_v4+2TB_PS, Standard_L16s, Standard_L4s, Standard_L8s}]
                        [--subscription]

Examples

update a Kusto Cluster.

az kusto cluster update -n myclustername -g myrgname --sku D14_v2 --capacity 4

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--capacity

The instance number of the VM.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the cluster.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku

The name of the sku.

accepted values: Dev(No SLA)_Standard_D11_v2, Dev(No SLA)_Standard_E2a_v4, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_DS13_v2+1TB_PS, Standard_DS13_v2+2TB_PS, Standard_DS14_v2+3TB_PS, Standard_DS14_v2+4TB_PS, Standard_E16a_v4, Standard_E16as_v4+3TB_PS, Standard_E16as_v4+4TB_PS, Standard_E2a_v4, Standard_E4a_v4, Standard_E8a_v4, Standard_E8as_v4+1TB_PS, Standard_E8as_v4+2TB_PS, Standard_L16s, Standard_L4s, Standard_L8s
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az kusto cluster wait

Wait for a managed Kusto cluster to reach a desired state.

If an operation on a cluster was interrupted or was started with --no-wait, use this command to wait for it to complete.

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

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.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--name -n

The name of the cluster.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.