Share via

az kusto database

  • Experimental
  • Reference

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 database command. Learn more about extensions.

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

Manage database with kusto.

Commands

Name Description Type Status
az kusto database add-principal

Add Database principals permissions.

 Extension Experimental
az kusto database create

Create a database.

 Extension Experimental
az kusto database delete

Deletes the database with the given name.

 Extension Experimental
az kusto database list

Returns the list of databases of the given Kusto cluster.

 Extension Experimental
az kusto database list-principal

Returns a list of database principals of the given Kusto cluster and database.

 Extension Experimental
az kusto database remove-principal

Remove Database principals permissions.

 Extension Experimental
az kusto database show

Returns a database.

 Extension Experimental
az kusto database update

Updates a database.

 Extension Experimental
az kusto database wait

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

 Extension Experimental

az kusto database add-principal

Experimental

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

Add Database principals permissions.

Azure CLI 
az kusto database add-principal [--cluster-name]
                                [--database-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]
                                [--value]

Examples

KustoDatabaseAddPrincipals

Azure CLI 
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"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in the Kusto cluster.

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

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

--value

The list of Kusto database principals.

Usage: --value role=XX name=XX type=XX fqn=XX email=XX app-id=XX

role: Required. Database principal role. name: Required. Database principal name. type: Required. Database principal type. fqn: Database principal fully qualified name. email: Database principal email if exists. app-id: Application id - relevant only for application principal type.

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database create

Experimental

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

Create a database.

Azure CLI 
az kusto database create --cluster-name
                         --database-name
                         --resource-group
                         [--no-wait]
                         [--read-only-following-database]
                         [--read-write-database]

Examples

Kusto ReadWrite database create or update

Azure CLI 
az kusto database create --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --read-write-database location="westus" soft-delete-period="P1D" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in 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.

Default value: False
--read-only-following-database

Class representing a read only following database.

Usage: --read-only-following-database hot-cache-period=XX location=XX kind=XX

hot-cache-period: The time the data should be kept in cache for fast queries in TimeSpan. location: Resource location. kind: Required. Kind of the database.

--read-write-database

Class representing a read write database.

Usage: --read-write-database soft-delete-period=XX hot-cache-period=XX location=XX kind=XX

soft-delete-period: The time the data should be kept before it stops being accessible to queries in TimeSpan. hot-cache-period: The time the data should be kept in cache for fast queries in TimeSpan. location: Resource location. kind: Required. Kind of the database.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database delete

Experimental

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

Deletes the database with the given name.

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

Examples

KustoDatabasesDelete

Azure CLI 
az kusto database delete --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in the Kusto cluster.

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

--no-wait

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

Default value: False
--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.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database list

Experimental

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

Returns the list of databases of the given Kusto cluster.

Azure CLI 
az kusto database list --cluster-name
                       --resource-group

Examples

KustoDatabasesListByCluster

Azure CLI 
az kusto database list --cluster-name "kustoclusterrptest4" --resource-group "kustorptest"

Required Parameters

--cluster-name

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database list-principal

Experimental

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

Returns a list of database principals of the given Kusto cluster and database.

Azure CLI 
az kusto database list-principal --cluster-name
                                 --database-name
                                 --resource-group

Examples

KustoDatabaseListPrincipals

Azure CLI 
az kusto database list-principal --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database remove-principal

Experimental

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

Remove Database principals permissions.

Azure CLI 
az kusto database remove-principal [--cluster-name]
                                   [--database-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--value]

Examples

KustoDatabaseRemovePrincipals

Azure CLI 
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"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in the Kusto cluster.

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

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

--value

The list of Kusto database principals.

Usage: --value role=XX name=XX type=XX fqn=XX email=XX app-id=XX

role: Required. Database principal role. name: Required. Database principal name. type: Required. Database principal type. fqn: Database principal fully qualified name. email: Database principal email if exists. app-id: Application id - relevant only for application principal type.

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database show

Experimental

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

Returns a database.

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

Examples

KustoDatabasesGet

Azure CLI 
az kusto database show --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in the Kusto cluster.

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database update

Experimental

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

Updates a database.

Azure CLI 
az kusto database update [--cluster-name]
                         [--database-name]
                         [--ids]
                         [--no-wait]
                         [--read-only-following-database]
                         [--read-write-database]
                         [--resource-group]
                         [--subscription]

Examples

Kusto ReadWrite database create or update

Azure CLI 
az kusto database update --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --read-write-database location="westus" soft-delete-period="P1D" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in the Kusto cluster.

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

--no-wait

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

Default value: False
--read-only-following-database

Class representing a read only following database.

Usage: --read-only-following-database hot-cache-period=XX location=XX kind=XX

hot-cache-period: The time the data should be kept in cache for fast queries in TimeSpan. location: Resource location. kind: Required. Kind of the database.

--read-write-database

Class representing a read write database.

Usage: --read-write-database soft-delete-period=XX hot-cache-period=XX location=XX kind=XX

soft-delete-period: The time the data should be kept before it stops being accessible to queries in TimeSpan. hot-cache-period: The time the data should be kept in cache for fast queries in TimeSpan. location: Resource location. kind: Required. Kind of the database.

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az kusto database 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 database is met.

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

Examples

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

Azure CLI 
az kusto database wait --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest" --created

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

Azure CLI 
az kusto database wait --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest" --updated

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

Azure CLI 
az kusto database wait --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest" --deleted

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--created

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

Default value: False
--custom

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

--database-name

The name of the database in the Kusto cluster.

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--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'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.