az kusto database
Kusto database.
Commands
| az kusto database add-principal |
Add Database principals permissions. |
| az kusto database create |
Creates or updates a database. |
| az kusto database delete |
Deletes the database with the given name. |
| az kusto database list |
Returns the list of databases of the given Kusto cluster. |
| az kusto database list-principal |
Returns a list of database principals of the given Kusto cluster and database. |
| az kusto database remove-principal |
Remove Database principals permissions. |
| az kusto database show |
Returns a database. |
| az kusto database update |
Updates a database. |
| az kusto database wait |
Place the CLI in a waiting state until a condition of the kusto database is met. |
az kusto database add-principal
Add Database principals permissions.
az kusto database add-principal --cluster-name
--database-name
--resource-group
[--value]Examples
KustoDatabaseAddPrincipals
az kusto database add-principal --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --value name="Some User" type="User" app-id="" email="user@microsoft.com" fqn="aaduser=some_guid" role="Admin" --value name="Kusto" type="Group" app-id="" email="kusto@microsoft.com" fqn="aadgroup=some_guid" role="Viewer" --value name="SomeApp" type="App" app-id="some_guid_app_id" email="" fqn="aadapp=some_guid_app_id" role="Admin" --resource-group "kustorptest"Required Parameters
The name of the Kusto cluster.
The name of the database in the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The list of Kusto database principals.
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 create
Creates or updates a database.
az kusto database create --cluster-name
--database-name
--resource-group
[--no-wait]
[--read-only-following-database]
[--read-write-database]Examples
KustoDatabasesCreateOrUpdate
az kusto database create --cluster-name "KustoClusterRPTest4" --database-name "KustoDatabase8" --read-write-database location="westus" soft-delete-period="P1D" --resource-group "kustorptest"Required Parameters
The name of the Kusto cluster.
The name of the database in 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.
Class representing a read only following database.
Class representing a read write database.
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
Deletes the database with the given name.
az kusto database delete --cluster-name
--database-name
--resource-group
[--no-wait]Examples
KustoDatabasesDelete
az kusto database delete --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest"Required Parameters
The name of the Kusto cluster.
The name of the database in 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 database list
Returns the list of databases of the given Kusto cluster.
az kusto database list --cluster-name
--resource-groupExamples
KustoDatabasesListByCluster
az kusto database list --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 database list-principal
Returns a list of database principals of the given Kusto cluster and database.
az kusto database list-principal --cluster-name
--database-name
--resource-groupExamples
KustoDatabaseListPrincipals
az kusto database list-principal --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest"Required Parameters
The name of the Kusto cluster.
The name of the database in 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 database remove-principal
Remove Database principals permissions.
az kusto database remove-principal --cluster-name
--database-name
--resource-group
[--value]Examples
KustoDatabaseRemovePrincipals
az kusto database remove-principal --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --value name="Some User" type="User" app-id="" email="user@microsoft.com" fqn="aaduser=some_guid" role="Admin" --value name="Kusto" type="Group" app-id="" email="kusto@microsoft.com" fqn="aadgroup=some_guid" role="Viewer" --value name="SomeApp" type="App" app-id="some_guid_app_id" email="" fqn="aadapp=some_guid_app_id" role="Admin" --resource-group "kustorptest"Required Parameters
The name of the Kusto cluster.
The name of the database in the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The list of Kusto database principals.
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
Returns a database.
az kusto database show --cluster-name
--database-name
--resource-groupExamples
KustoDatabasesGet
az kusto database show --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest"Required Parameters
The name of the Kusto cluster.
The name of the database in 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 database update
Updates a database.
az kusto database update --cluster-name
--database-name
--resource-group
[--no-wait]
[--read-only-following-database]
[--read-write-database]Examples
KustoDatabasesUpdate
az kusto database update --cluster-name "KustoClusterRPTest4" --database-name "KustoDatabase8" --read-write-database soft-delete-period="P1D" --resource-group "kustorptest"Required Parameters
The name of the Kusto cluster.
The name of the database in 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.
Class representing a read only following database.
Class representing a read write database.
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
Place the CLI in a waiting state until a condition of the kusto database is met.
az kusto database wait --cluster-name
--database-name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Examples
Pause executing next line of CLI script until the kusto database is successfully created.
az kusto database wait --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest" --createdPause executing next line of CLI script until the kusto database is successfully updated.
az kusto database wait --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest" --updatedPause executing next line of CLI script until the kusto database is successfully deleted.
az kusto database wait --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest" --deletedRequired Parameters
The name of the Kusto cluster.
The name of the database in 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.