az kusto database
Manage Azure Kusto databases.
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 database create |
Create a Kusto database. |
az kusto database delete |
Delete a Kusto database. |
az kusto database list |
List a Kusto database. |
az kusto database show |
Get a Kusto database. |
az kusto database update |
Update a Kusto database. |
az kusto database wait |
Wait for a managed Kusto database to reach a desired state. |
az kusto database create
Create a Kusto database.
az kusto database create --cluster-name
--name
--resource-group
[--hot-cache-period]
[--no-wait]
[--soft-delete-period]
[--subscription]
Examples
create a Kusto Database.
az kusto database create --cluster-name myclustername -g myrgname -n mydbname --soft-delete-period P365D --hot-cache-period P31D
Required Parameters
The name of the cluster.
The name of the database.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Amount of time that data should be kept in cache.Duration in ISO8601 format (for example, 100 days would be P100D).
Do not wait for the long-running operation to finish.
Amount of time that data should be kept so it is available to query. Duration in ISO8601 format (for example, 100 days would be P100D).
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 database delete
Delete a Kusto database.
az kusto database delete [--cluster-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Optional Parameters
The name of the cluster.
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.
The name of the database.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
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 database list
List a Kusto database.
az kusto database list --cluster-name
--resource-group
[--query-examples]
[--subscription]
Examples
List a Kusto database. (autogenerated)
az kusto database list --cluster-name MyCluster --resource-group MyResourceGroup
Required Parameters
The name of the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 database show
Get a Kusto database.
az kusto database show [--cluster-name]
[--ids]
[--name]
[--query-examples]
[--resource-group]
[--subscription]
Examples
Get a Kusto database. (autogenerated)
az kusto database show --cluster-name MyCluster --name MyDatabase --resource-group MyResourceGroup
Optional Parameters
The name of the cluster.
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.
The name of the database.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 database update
Update a Kusto database.
az kusto database update --soft-delete-period
[--add]
[--cluster-name]
[--force-string]
[--hot-cache-period]
[--ids]
[--name]
[--no-wait]
[--remove]
[--resource-group]
[--set]
[--subscription]
Examples
create a Kusto Database.
az kusto database update --cluster-name myclustername -g myrgname -n mydbname --soft-delete-period P365D --hot-cache-period P30D
Required Parameters
Amount of time that data should be kept so it is available to query. Duration in ISO8601 format (for example, 100 days would be P100D).
Optional Parameters
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>.
The name of the cluster.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Amount of time that data should be kept in cache.Duration in ISO8601 format (for example, 100 days would be P100D).
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.
The name of the database.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 database wait
Wait for a managed Kusto database to reach a desired state.
If an operation on a database was interrupted or was started with --no-wait
, use this command to wait for it to complete.
az kusto database wait [--cluster-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The name of the cluster.
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.
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.
Polling interval in seconds.
The name of the database.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.