az synapse kusto pool
Manage kusto pool with synapse.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az synapse kusto pool add-language-extension |
Add a list of language extensions that can run within KQL queries. |
Core | GA |
| az synapse kusto pool create |
Create a Kusto pool. |
Core | GA |
| az synapse kusto pool delete |
Deletes a Kusto pool. |
Core | GA |
| az synapse kusto pool detach-follower-database |
Detaches all followers of a database owned by this Kusto Pool. |
Core | GA |
| az synapse kusto pool list |
List all Kusto pools. |
Core | GA |
| 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. |
Core | GA |
| az synapse kusto pool list-language-extension |
Returns a list of language extensions that can run within KQL queries. |
Core | GA |
| az synapse kusto pool list-sku |
Returns the SKUs available for the provided resource. |
Core | GA |
| az synapse kusto pool remove-language-extension |
Remove a list of language extensions that can run within KQL queries. |
Core | GA |
| az synapse kusto pool show |
Gets a Kusto pool. |
Core | GA |
| az synapse kusto pool start |
Starts a Kusto pool. |
Core | GA |
| az synapse kusto pool stop |
Stops a Kusto pool. |
Core | GA |
| az synapse kusto pool update |
Update a Kusto Kusto Pool. |
Core | GA |
| az synapse kusto pool wait |
Place the CLI in a waiting state until a condition of the synapse kusto pool is met. |
Core | GA |
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]
[--subscription]
[--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
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 Kusto pool.
Do not wait for the long-running operation to finish.
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.
The list of language extensions.
Usage: --value language-extension-name=XX
language-extension-name: The language extension name.
Multiple actions can be specified by using more than one --value argument.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the Kusto pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The SKU of the kusto pool.
Usage: --sku name=XX capacity=XX size=XX
name: Required. SKU name. capacity: The number of instances of the cluster. size: Required. SKU size.
The name of the workspace.
Optional Parameters
A boolean value that indicates if the purge operations are enabled.
A boolean value that indicates if the streaming ingest is enabled.
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.
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. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Do not wait for the long-running operation to finish.
Optimized auto scale definition.
Usage: --optimized-autoscale version=XX is-enabled=XX minimum=XX maximum=XX
version: Required. The version of the template defined, for instance 1. is-enabled: Required. A boolean value that indicate if the optimized autoscale feature is enabled or not. minimum: Required. Minimum allowed instances count. maximum: Required. Maximum allowed instances count.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The workspace unique identifier.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az synapse kusto pool delete
Deletes a Kusto pool.
az synapse kusto pool delete [--ids]
[--kusto-pool-name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]
[--yes]Examples
kustoPoolsDelete
az synapse kusto pool delete --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"Optional Parameters
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 Kusto pool.
Do not wait for the long-running operation to finish.
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.
The name of the workspace.
Do not prompt for confirmation.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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]
[--subscription]
[--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
Resource name of the attached database configuration in the follower cluster.
Resource id of the cluster that follows a database owned by this cluster.
Optional Parameters
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 Kusto pool.
Do not wait for the long-running operation to finish.
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.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az synapse kusto pool list
List all Kusto pools.
az synapse kusto pool list --resource-group
--workspace-nameExamples
List Kusto pools in a workspace
az synapse kusto pool list --resource-group "kustorptest" --workspace-name "kustorptest"Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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-nameExamples
KustoPoolListFollowerDatabases
az synapse kusto pool list-follower-database --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"Required Parameters
The name of the Kusto pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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-nameExamples
KustoPoolListLanguageExtensions
az synapse kusto pool list-language-extension --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"Required Parameters
The name of the Kusto pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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-nameExamples
KustoPoolsListResourceSkus
az synapse kusto pool list-sku --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"Required Parameters
The name of the Kusto pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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]
[--subscription]
[--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
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 Kusto pool.
Do not wait for the long-running operation to finish.
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.
The list of language extensions.
Usage: --value language-extension-name=XX
language-extension-name: The language extension name.
Multiple actions can be specified by using more than one --value argument.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az synapse kusto pool show
Gets a Kusto pool.
az synapse kusto pool show [--ids]
[--kusto-pool-name]
[--resource-group]
[--subscription]
[--workspace-name]Examples
kustoPoolsGet
az synapse kusto pool show --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"Optional Parameters
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 Kusto pool.
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.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az synapse kusto pool start
Starts a Kusto pool.
az synapse kusto pool start [--ids]
[--kusto-pool-name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]Examples
kustoPoolsStop
az synapse kusto pool start --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"Optional Parameters
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 Kusto pool.
Do not wait for the long-running operation to finish.
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.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az synapse kusto pool stop
Stops a Kusto pool.
az synapse kusto pool stop [--ids]
[--kusto-pool-name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]Examples
kustoPoolsStop
az synapse kusto pool stop --name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"Optional Parameters
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 Kusto pool.
Do not wait for the long-running operation to finish.
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.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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]
[--subscription]
[--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
A boolean value that indicates if the purge operations are enabled.
A boolean value that indicates if the streaming ingest is enabled.
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 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.
The name of the Kusto pool.
Do not wait for the long-running operation to finish.
Optimized auto scale definition.
Usage: --optimized-autoscale version=XX is-enabled=XX minimum=XX maximum=XX
version: Required. The version of the template defined, for instance 1. is-enabled: Required. A boolean value that indicate if the optimized autoscale feature is enabled or not. minimum: Required. Minimum allowed instances count. maximum: Required. Maximum allowed instances count.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The SKU of the kusto pool.
Usage: --sku name=XX capacity=XX size=XX
name: Required. SKU name. capacity: The number of instances of the cluster. size: Required. SKU size.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The name of the workspace.
The workspace unique identifier.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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]
[--subscription]
[--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" --deletedPause 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" --createdOptional 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.
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 Kusto pool.
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'.
The name of the workspace.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Kommer snart: I hele 2024 udfaser vi GitHub-problemer som feedbackmekanisme for indhold og erstatter det med et nyt feedbacksystem. Du kan få flere oplysninger under: https://aka.ms/ContentUserFeedback.
Indsend og få vist feedback om