az kusto cluster

Note

This reference is part of the kusto extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az kusto cluster command. Learn more about extensions.

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage cluster with kusto.

Commands

Name	Description	Type	Status
az kusto cluster add-language-extension	Add a list of language extensions that can run within KQL queries.	Extension	Experimental
az kusto cluster create	Create a Kusto cluster.	Extension	Experimental
az kusto cluster delete	Deletes a Kusto cluster.	Extension	Experimental
az kusto cluster detach-follower-database	Detaches all followers of a database owned by this cluster.	Extension	Experimental
az kusto cluster diagnose-virtual-network	Diagnoses network connectivity status for external resources on which the service is dependent on.	Extension	Experimental
az kusto cluster list	Lists all Kusto clusters within a resource group. And Lists all Kusto clusters within a subscription.	Extension	Experimental
az kusto cluster list-follower-database	Returns a list of databases that are owned by this cluster and were followed by another cluster.	Extension	Experimental
az kusto cluster list-language-extension	Returns a list of language extensions that can run within KQL queries.	Extension	Experimental
az kusto cluster list-outbound-network-dependency-endpoint	Gets the network endpoints of all outbound dependencies of a Kusto cluster.	Extension	Experimental
az kusto cluster list-sku	Returns the SKUs available for the provided resource. And Lists eligible SKUs for Kusto resource provider.	Extension	Experimental
az kusto cluster remove-language-extension	Remove a list of language extensions that can run within KQL queries.	Extension	Experimental
az kusto cluster show	Gets a Kusto cluster.	Extension	Experimental
az kusto cluster start	Starts a Kusto cluster.	Extension	Experimental
az kusto cluster stop	Stops a Kusto cluster.	Extension	Experimental
az kusto cluster update	Update a Kusto cluster.	Extension	Experimental
az kusto cluster wait	Place the CLI in a waiting state until a condition of the kusto cluster is met.	Extension	Experimental

az kusto cluster add-language-extension

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Examples

KustoClusterAddLanguageExtensions

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--value

The list of language extensions.

Usage: --value language-extension-name=XX

language-extension-name: The language extension name.

Multiple actions can be specified by using more than one --value argument.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster create

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Kusto cluster.

az kusto cluster create --cluster-name --name
                        --resource-group
                        --sku
                        [--accepted-audiences]
                        [--allowed-fqdn-list]
                        [--allowed-ip-range-list]
                        [--enable-auto-stop {false, true}]
                        [--enable-disk-encryption {false, true}]
                        [--enable-double-encryption {false, true}]
                        [--enable-purge {false, true}]
                        [--enable-streaming-ingest {false, true}]
                        [--engine-type {V2, V3}]
                        [--if-match]
                        [--if-none-match]
                        [--key-vault-properties]
                        [--location]
                        [--no-wait]
                        [--optimized-autoscale]
                        [--outbound-net-access --restrict-outbound-network-access {Disabled, Enabled}]
                        [--public-ip-type {DualStack, IPv4}]
                        [--public-network-access {Disabled, Enabled}]
                        [--tags]
                        [--trusted-external-tenants]
                        [--type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                        [--user-assigned --user-assigned-identities]
                        [--vcluster-graduation --virtual-cluster-graduation-properties]
                        [--virtual-network-configuration]
                        [--zones]

Examples

KustoClustersCreateOrUpdate

az kusto cluster create --name "kustoclusterrptest4" --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 --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>.

--sku

The SKU of the cluster.

Usage: --sku name=XX capacity=XX tier=XX

name: Required. SKU name. capacity: The number of instances of the cluster. tier: Required. SKU tier.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--accepted-audiences

The cluster's accepted audiences.

--allowed-fqdn-list

List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.

--allowed-ip-range-list

The list of ips in the format of CIDR allowed to connect to the cluster.

--enable-auto-stop

A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).

Property	Value
Accepted values:	false, true

--enable-disk-encryption

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

Property	Value
Accepted values:	false, true

--enable-double-encryption

A boolean value that indicates if double encryption is enabled.

Property	Value
Accepted values:	false, true

--enable-purge

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

Property	Value
Accepted values:	false, true

--enable-streaming-ingest

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

Property	Value
Accepted values:	false, true

--engine-type

The engine type.

Property	Value
Accepted values:	V2, V3

--if-match

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

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.

--key-vault-properties

KeyVault properties for the cluster encryption.

Usage: --key-vault-properties key-name=XX key-version=XX key-vault-uri=XX user-identity=XX

key-name: Required. The name of the key vault key. key-version: The version of the key vault key. key-vault-uri: Required. The Uri of the key vault. user-identity: The user assigned identity (ARM resource id) that has access to the key.

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

Property	Value
Default value:	False

--optimized-autoscale

Optimized auto scale definition.

Usage: --optimized-autoscale version=XX is-enabled=XX minimum=XX maximum=XX

version: Required. The version of the template defined, for instance 1. is-enabled: Required. A boolean value that indicate if the optimized autoscale feature is enabled or not. minimum: Required. Minimum allowed instances count. maximum: Required. Maximum allowed instances count.

--outbound-net-access --restrict-outbound-network-access

Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Property	Value
Accepted values:	Disabled, Enabled

--public-ip-type

Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6).

Property	Value
Accepted values:	DualStack, IPv4

--public-network-access

Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed.

Property	Value
Accepted values:	Disabled, Enabled

--tags

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

--trusted-external-tenants

The cluster's external tenants.

Usage: --trusted-external-tenants value=XX

value: GUID representing an external tenant.

Multiple actions can be specified by using more than one --trusted-external-tenants argument.

--type

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities.

Property	Value
Parameter group:	Identity Arguments
Accepted values:	None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned

--user-assigned --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/@json-file.

Property	Value
Parameter group:	Identity Arguments

--vcluster-graduation --virtual-cluster-graduation-properties

Virtual Cluster graduation properties.

--virtual-network-configuration

Virtual network definition.

Usage: --virtual-network-configuration subnet-id=XX engine-public-ip-id=XX data-management-public-ip-id=XX

subnet-id: Required. The subnet resource id. engine-public-ip-id: Required. Engine service's public IP address resource id. data-management-public-ip-id: Required. Data management's service public IP address resource id.

--zones

The availability zones of the cluster.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster delete

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a Kusto cluster.

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

Examples

KustoClustersDelete

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster detach-follower-database

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Detaches all followers of a database owned by this cluster.

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

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-resource-id

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster diagnose-virtual-network

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Examples

KustoClusterDiagnoseVirtualNetwork

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster list

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists all Kusto clusters within a resource group. And Lists all Kusto clusters within a subscription.

az kusto cluster list [--resource-group]

Examples

KustoClustersListByResourceGroup

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

KustoClustersList

az kusto cluster list

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster list-follower-database

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster list-language-extension

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az kusto cluster list-language-extension --cluster-name --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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster list-outbound-network-dependency-endpoint

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets the network endpoints of all outbound dependencies of a Kusto cluster.

az kusto cluster list-outbound-network-dependency-endpoint --cluster-name --name
                                                           --resource-group

Examples

Get Kusto cluster outbound network dependencies

az kusto cluster list-outbound-network-dependency-endpoint --name "kustoCluster" --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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster list-sku

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Examples

KustoClustersListResourceSkus

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

KustoClustersListSkus

az kusto cluster list-sku

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster remove-language-extension

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Examples

KustoClusterRemoveLanguageExtensions

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--value

The list of language extensions.

Usage: --value language-extension-name=XX

language-extension-name: The language extension name.

Multiple actions can be specified by using more than one --value argument.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster show

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets a Kusto cluster.

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

Examples

KustoClustersGet

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster start

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Starts a Kusto cluster.

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

Examples

KustoClustersStart

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster stop

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Stops a Kusto cluster.

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

Examples

KustoClustersStop

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster update

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Kusto cluster.

az kusto cluster update [--accepted-audiences]
                        [--allowed-fqdn-list]
                        [--allowed-ip-range-list]
                        [--cluster-name --name]
                        [--enable-auto-stop {false, true}]
                        [--enable-disk-encryption {false, true}]
                        [--enable-double-encryption {false, true}]
                        [--enable-purge {false, true}]
                        [--enable-streaming-ingest {false, true}]
                        [--engine-type {V2, V3}]
                        [--ids]
                        [--if-match]
                        [--key-vault-properties]
                        [--location]
                        [--no-wait]
                        [--optimized-autoscale]
                        [--outbound-net-access --restrict-outbound-network-access {Disabled, Enabled}]
                        [--public-ip-type {DualStack, IPv4}]
                        [--public-network-access {Disabled, Enabled}]
                        [--resource-group]
                        [--sku]
                        [--subscription]
                        [--tags]
                        [--trusted-external-tenants]
                        [--type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                        [--user-assigned --user-assigned-identities]
                        [--vcluster-graduation --virtual-cluster-graduation-properties]
                        [--virtual-network-configuration]

Examples

KustoClustersUpdate

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--accepted-audiences

The cluster's accepted audiences.

--allowed-fqdn-list

List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.

--allowed-ip-range-list

The list of ips in the format of CIDR allowed to connect to the cluster.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

--enable-auto-stop

A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).

Property	Value
Accepted values:	false, true

--enable-disk-encryption

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

Property	Value
Accepted values:	false, true

--enable-double-encryption

A boolean value that indicates if double encryption is enabled.

Property	Value
Accepted values:	false, true

--enable-purge

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

Property	Value
Accepted values:	false, true

--enable-streaming-ingest

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

Property	Value
Accepted values:	false, true

--engine-type

The engine type.

Property	Value
Accepted values:	V2, V3

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

Property	Value
Parameter group:	Resource Id Arguments

--if-match

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.

--key-vault-properties

KeyVault properties for the cluster encryption.

Usage: --key-vault-properties key-name=XX key-version=XX key-vault-uri=XX user-identity=XX

key-name: Required. The name of the key vault key. key-version: The version of the key vault key. key-vault-uri: Required. The Uri of the key vault. user-identity: The user assigned identity (ARM resource id) that has access to the key.

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

Property	Value
Default value:	False

--optimized-autoscale

Optimized auto scale definition.

Usage: --optimized-autoscale version=XX is-enabled=XX minimum=XX maximum=XX

version: Required. The version of the template defined, for instance 1. is-enabled: Required. A boolean value that indicate if the optimized autoscale feature is enabled or not. minimum: Required. Minimum allowed instances count. maximum: Required. Maximum allowed instances count.

--outbound-net-access --restrict-outbound-network-access

Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Property	Value
Accepted values:	Disabled, Enabled

--public-ip-type

Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6).

Property	Value
Accepted values:	DualStack, IPv4

--public-network-access

Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed.

Property	Value
Accepted values:	Disabled, Enabled

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--sku

The SKU of the cluster.

Usage: --sku name=XX capacity=XX tier=XX

name: Required. SKU name. capacity: The number of instances of the cluster. tier: Required. SKU tier.

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

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

--trusted-external-tenants

The cluster's external tenants.

Usage: --trusted-external-tenants value=XX

value: GUID representing an external tenant.

Multiple actions can be specified by using more than one --trusted-external-tenants argument.

--type

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities.

Property	Value
Parameter group:	Identity Arguments
Accepted values:	None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned

--user-assigned --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/@json-file.

Property	Value
Parameter group:	Identity Arguments

--vcluster-graduation --virtual-cluster-graduation-properties

Virtual Cluster graduation properties.

--virtual-network-configuration

Virtual network definition.

Usage: --virtual-network-configuration subnet-id=XX engine-public-ip-id=XX data-management-public-ip-id=XX

subnet-id: Required. The subnet resource id. engine-public-ip-id: Required. Engine service's public IP address resource id. data-management-public-ip-id: Required. Data management's service public IP address resource id.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az kusto cluster wait

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Examples

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

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

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

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

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the Kusto cluster.

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False