Share via

az synapse kusto database

  • Experimental
  • Reference

This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage kusto pool database with synapse.

Commands

Name Description Type Status
az synapse kusto database create

Create a database.

 Core Experimental
az synapse kusto database delete

Deletes the database with the given name.

 Core Experimental
az synapse kusto database list

Returns the list of databases of the given Kusto pool.

 Core Experimental
az synapse kusto database show

Returns a database.

 Core Experimental
az synapse kusto database update

Updates a database.

 Core Experimental
az synapse kusto database wait

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

 Core Experimental

az synapse kusto database create

Edit
Experimental

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

Create a database.

az synapse kusto database create --database-name
                                 --kusto-pool-name
                                 --resource-group
                                 --workspace-name
                                 [--no-wait]
                                 [--read-write-database]

Examples

KustoPoolDatabasesCreateOrUpdate

az synapse kusto database create --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --read-write-database location="westus" soft-delete-period="P1D" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Required Parameters

--database-name

The name of the database in the Kusto pool.

--kusto-pool-name

The name of the Kusto pool.

--resource-group -g

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

--workspace-name

The name of the workspace.

Optional Parameters

--no-wait

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

Default value: False
--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 synapse kusto database delete

Edit
Experimental

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

Deletes the database with the given name.

az synapse kusto database delete [--database-name]
                                 [--ids]
                                 [--kusto-pool-name]
                                 [--no-wait]
                                 [--resource-group]
                                 [--subscription]
                                 [--workspace-name]
                                 [--yes]

Examples

KustoPoolDatabasesDelete

az synapse kusto database delete --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

--database-name

The name of the database in the Kusto pool.

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

--kusto-pool-name

The name of the Kusto pool.

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

--workspace-name

The name of the workspace.

--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 synapse kusto database list

Edit
Experimental

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

Returns the list of databases of the given Kusto pool.

az synapse kusto database list --kusto-pool-name
                               --resource-group
                               --workspace-name

Examples

KustoDatabasesListByKustoPool

az synapse kusto database list --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Required Parameters

--kusto-pool-name

The name of the Kusto pool.

--resource-group -g

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

--workspace-name

The name of the workspace.

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 synapse kusto database show

Edit
Experimental

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

Returns a database.

az synapse kusto database show [--database-name]
                               [--ids]
                               [--kusto-pool-name]
                               [--resource-group]
                               [--subscription]
                               [--workspace-name]

Examples

KustoPoolDatabasesGet

az synapse kusto database show --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

--database-name

The name of the database in the Kusto pool.

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

--kusto-pool-name

The name of the Kusto pool.

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

--workspace-name

The name of the workspace.

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 synapse kusto database update

Edit
Experimental

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

Updates a database.

az synapse kusto database update [--database-name]
                                 [--ids]
                                 [--kusto-pool-name]
                                 [--no-wait]
                                 [--read-write-database]
                                 [--resource-group]
                                 [--subscription]
                                 [--workspace-name]

Examples

KustoPoolDatabasesUpdate

az synapse kusto database update --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --read-write-database soft-delete-period="P1D" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

--database-name

The name of the database in the Kusto pool.

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

--kusto-pool-name

The name of the Kusto pool.

--no-wait

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

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

--workspace-name

The name of the workspace.

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 synapse kusto database wait

Edit
Experimental

Command group 'synapse kusto database' 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 synapse kusto database is met.

az synapse kusto database wait [--created]
                               [--custom]
                               [--database-name]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--kusto-pool-name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]
                               [--workspace-name]

Examples

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

az synapse kusto database wait --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --created

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

az synapse kusto database wait --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --updated

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

az synapse kusto database wait --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --deleted

Optional Parameters

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

--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
--kusto-pool-name

The name of the Kusto pool.

--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
--workspace-name

The name of the workspace.

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.