az synapse kusto pool

Manage kusto pool with synapse.

Commands

az synapse kusto pool add-language-extension

Add a list of language extensions that can run within KQL queries.

az synapse kusto pool create

Create a Kusto pool.

az synapse kusto pool delete

Deletes a Kusto pool.

az synapse kusto pool detach-follower-database

Detaches all followers of a database owned by this Kusto Pool.

az synapse kusto pool list

List all Kusto pools.

az synapse kusto pool list-follower-database

Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

az synapse kusto pool list-language-extension

Returns a list of language extensions that can run within KQL queries.

az synapse kusto pool list-sku

Returns the SKUs available for the provided resource.

az synapse kusto pool remove-language-extension

Remove a list of language extensions that can run within KQL queries.

az synapse kusto pool show

Gets a Kusto pool.

az synapse kusto pool start

Starts a Kusto pool.

az synapse kusto pool stop

Stops a Kusto pool.

az synapse kusto pool update

Update a Kusto Kusto Pool.

az synapse kusto pool wait

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

az synapse kusto pool add-language-extension

Add a list of language extensions that can run within KQL queries.

az synapse kusto pool add-language-extension [--ids]
                                             [--kusto-pool-name]
                                             [--no-wait]
                                             [--resource-group]
                                             [--value]
                                             [--workspace-name]

Examples

KustoPoolAddLanguageExtensions

az synapse kusto pool add-language-extension --name "kustoclusterrptest4" --value language-extension-name="PYTHON" --value language-extension-name="R" --resource-group "kustorptest" --workspace-name "kustorptest"

Optional Parameters

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

The name of the Kusto pool.

--no-wait

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

--resource-group -g

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

--value

The list of language extensions.

--workspace-name

The name of the workspace.

az synapse kusto pool create

Create a Kusto pool.

az synapse kusto pool create --kusto-pool-name
                             --resource-group
                             --sku
                             --workspace-name
                             [--enable-purge {false, true}]
                             [--enable-streaming-ingest {false, true}]
                             [--if-match]
                             [--if-none-match]
                             [--location]
                             [--no-wait]
                             [--optimized-autoscale]
                             [--tags]
                             [--workspace-uid]

Examples

kustoPoolsCreateOrUpdate

az synapse kusto pool create --name "kustoclusterrptest4" --location "westus" --enable-purge true --enable-streaming-ingest true --workspace-uid "11111111-2222-3333-444444444444" --sku name="Storage optimized" capacity=2 size="Medium" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Required Parameters

--kusto-pool-name --name -n

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

--sku

The SKU of the kusto pool.

--workspace-name

The name of the workspace.

Optional Parameters

--enable-purge

A boolean value that indicates if the purge operations are enabled.

accepted values: false, true
--enable-streaming-ingest --esig

A boolean value that indicates if the streaming ingest is enabled.

accepted values: false, true
--if-match

The ETag of the Kusto Pool. Omit this value to always overwrite the current Kusto Pool. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new Kusto Pool to be created, but to prevent updating an existing Kusto Pool. Other values will result in a 412 Pre-condition Failed response.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--optimized-autoscale

Optimized auto scale definition.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--workspace-uid

The workspace unique identifier.

az synapse kusto pool delete

Deletes a Kusto pool.

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

Examples

kustoPoolsDelete

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

Optional Parameters

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

The name of the Kusto pool.

--no-wait

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

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

--yes -y

Do not prompt for confirmation.

az synapse kusto pool detach-follower-database

Detaches all followers of a database owned by this Kusto Pool.

az synapse kusto pool detach-follower-database --adcn
                                               --kusto-pool-resource-id
                                               [--ids]
                                               [--kusto-pool-name]
                                               [--no-wait]
                                               [--resource-group]
                                               [--workspace-name]

Examples

KustoPoolDetachFollowerDatabases

az synapse kusto pool detach-follower-database --attached-database-configuration-name "myAttachedDatabaseConfiguration" --kusto-pool-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustoPools/leader4" --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

Required Parameters

--adcn --attached-database-configuration-name

Resource name of the attached database configuration in the follower cluster.

--kusto-pool-resource-id

Resource id of the cluster that follows a database owned by this cluster.

Optional Parameters

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

The name of the Kusto pool.

--no-wait

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

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

az synapse kusto pool list

List all Kusto pools.

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

Examples

List Kusto pools in a workspace

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

Required Parameters

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

az synapse kusto pool list-follower-database

Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

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

Examples

KustoPoolListFollowerDatabases

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

Required Parameters

--kusto-pool-name --name -n

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.

az synapse kusto pool list-language-extension

Returns a list of language extensions that can run within KQL queries.

az synapse kusto pool list-language-extension --kusto-pool-name
                                              --resource-group
                                              --workspace-name

Examples

KustoPoolListLanguageExtensions

az synapse kusto pool list-language-extension --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

Required Parameters

--kusto-pool-name --name -n

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.

az synapse kusto pool list-sku

Returns the SKUs available for the provided resource.

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

Examples

KustoPoolsListResourceSkus

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

Required Parameters

--kusto-pool-name --name -n

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.

az synapse kusto pool remove-language-extension

Remove a list of language extensions that can run within KQL queries.

az synapse kusto pool remove-language-extension [--ids]
                                                [--kusto-pool-name]
                                                [--no-wait]
                                                [--resource-group]
                                                [--value]
                                                [--workspace-name]

Examples

KustoPoolRemoveLanguageExtensions

az synapse kusto pool remove-language-extension --name "kustoclusterrptest4" --value language-extension-name="PYTHON" --value language-extension-name="R" --resource-group "kustorptest" --workspace-name "kustorptest"

Optional Parameters

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

The name of the Kusto pool.

--no-wait

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

--resource-group -g

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

--value

The list of language extensions.

--workspace-name

The name of the workspace.

az synapse kusto pool show

Gets a Kusto pool.

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

Examples

kustoPoolsGet

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

Optional Parameters

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

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.

az synapse kusto pool start

Starts a Kusto pool.

az synapse kusto pool start [--ids]
                            [--kusto-pool-name]
                            [--no-wait]
                            [--resource-group]
                            [--workspace-name]

Examples

kustoPoolsStop

az synapse kusto pool start --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

Optional Parameters

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

The name of the Kusto pool.

--no-wait

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

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

az synapse kusto pool stop

Stops a Kusto pool.

az synapse kusto pool stop [--ids]
                           [--kusto-pool-name]
                           [--no-wait]
                           [--resource-group]
                           [--workspace-name]

Examples

kustoPoolsStop

az synapse kusto pool stop --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

Optional Parameters

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

The name of the Kusto pool.

--no-wait

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

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

az synapse kusto pool update

Update a Kusto Kusto Pool.

az synapse kusto pool update [--enable-purge {false, true}]
                             [--enable-streaming-ingest {false, true}]
                             [--ids]
                             [--if-match]
                             [--kusto-pool-name]
                             [--no-wait]
                             [--optimized-autoscale]
                             [--resource-group]
                             [--sku]
                             [--tags]
                             [--workspace-name]
                             [--workspace-uid]

Examples

kustoPoolsUpdate

az synapse kusto pool update --name "kustoclusterrptest4" --enable-purge true --enable-streaming-ingest true --workspace-uid "11111111-2222-3333-444444444444" --sku name="Storage optimized" capacity=2 size="Medium" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

--enable-purge

A boolean value that indicates if the purge operations are enabled.

accepted values: false, true
--enable-streaming-ingest --esig

A boolean value that indicates if the streaming ingest is enabled.

accepted values: false, true
--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.

--if-match

The ETag of the Kusto Pool. Omit this value to always overwrite the current Kusto Pool. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--kusto-pool-name --name -n

The name of the Kusto pool.

--no-wait

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

--optimized-autoscale

Optimized auto scale definition.

--resource-group -g

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

--sku

The SKU of the kusto pool.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--workspace-name

The name of the workspace.

--workspace-uid

The workspace unique identifier.

az synapse kusto pool wait

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

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

Examples

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

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

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

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

--workspace-name

The name of the workspace.