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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
The list of language extensions.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The SKU of the cluster.
Optional Parameters
A boolean value that indicates if the cluster's disks are encrypted.
A boolean value that indicates if double encryption is enabled.
A boolean value that indicates if the purge operations are enabled.
A boolean value that indicates if the streaming ingest is enabled.
The identity type.
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.
KeyVault properties for the cluster encryption.
Do not wait for the long-running operation to finish.
Optimized auto scale definition.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The cluster's external tenants.
Virtual network definition.
The availability zones of the cluster.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
Resource name of the attached database configuration in the follower cluster.
The name of the Kusto cluster.
Resource id of the cluster that follows a database owned by this cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
The list of language extensions.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
A boolean value that indicates if the cluster's disks are encrypted.
A boolean value that indicates if double encryption is enabled.
A boolean value that indicates if the purge operations are enabled.
A boolean value that indicates if the streaming ingest is enabled.
The identity type.
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.
KeyVault properties for the cluster encryption.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Optimized auto scale definition.
The SKU of the cluster.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The cluster's external tenants.
Virtual network definition.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.