az synapse spark pool

Manage Spark pools.

Commands

az synapse spark pool create

Create a Spark pool.

az synapse spark pool delete

Delete a Spark pool.

az synapse spark pool list

List all Spark pools.

az synapse spark pool show

Get a Spark pool.

az synapse spark pool update

Update the Spark pool.

az synapse spark pool wait

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

az synapse spark pool create

Create a Spark pool.

az synapse spark pool create --name
                             --node-count
                             --node-size {Large, Medium, Small}
                             --resource-group
                             --spark-version
                             --workspace-name
                             [--delay]
                             [--enable-auto-pause {false, true}]
                             [--enable-auto-scale {false, true}]
                             [--library-requirements]
                             [--max-node-count]
                             [--min-node-count]
                             [--no-wait]
                             [--node-size-family]
                             [--spark-events-folder]
                             [--spark-log-folder]
                             [--subscription]
                             [--tags]

Examples

Create a Spark pool.

az synapse spark pool create --name testpool --workspace-name testsynapseworkspace --resource-group rg \
--spark-version 2.4 --node-count 3 --node-size Medium

Required Parameters

--name -n

The name of the Spark pool.

--node-count

The number of node.

--node-size

The node size.

accepted values: Large, Medium, Small
--resource-group -g

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

--spark-version

The supported Spark version is 2.4 now.

--workspace-name

The workspace name.

Optional Parameters

--delay

The delay time whose unit is minute.

--enable-auto-pause

The flag of enabling auto pause.

accepted values: false, true
--enable-auto-scale

The flag of enabling auto scale.

accepted values: false, true
--library-requirements

The library requirements file.

--max-node-count

The max node count.

--min-node-count

The min node count.

--no-wait

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

--node-size-family

The node size family.

default value: MemoryOptimized
--spark-events-folder

The Spark events folder.

default value: /events
--spark-log-folder

The default Spark log folder.

default value: /logs
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

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

az synapse spark pool delete

Delete a Spark pool.

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

Examples

Delete a Spark pool.

az synapse spark pool delete --name testpool --workspace-name testsynapseworkspace --resource-group rg

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.

--name -n

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The workspace name.

--yes -y

Do not prompt for confirmation.

az synapse spark pool list

List all Spark pools.

az synapse spark pool list --resource-group
                           --workspace-name
                           [--query-examples]
                           [--subscription]

Examples

List all Spark pools.

az synapse spark pool list --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

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

--workspace-name

The workspace name.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az synapse spark pool show

Get a Spark pool.

az synapse spark pool show [--ids]
                           [--name]
                           [--query-examples]
                           [--resource-group]
                           [--subscription]
                           [--workspace-name]

Examples

Get a Spark pool.

az synapse spark pool show --name testpool --workspace-name testsynapseworkspace --resource-group rg

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.

--name -n

The name of the Spark pool.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az synapse spark pool update

Update the Spark pool.

az synapse spark pool update [--delay]
                             [--enable-auto-pause {false, true}]
                             [--enable-auto-scale {false, true}]
                             [--force {false, true}]
                             [--ids]
                             [--library-requirements]
                             [--max-node-count]
                             [--min-node-count]
                             [--name]
                             [--no-wait]
                             [--node-count]
                             [--node-size {Large, Medium, Small}]
                             [--resource-group]
                             [--subscription]
                             [--tags]
                             [--workspace-name]

Examples

Update the Spark pool's tags.

az synapse spark pool update --name testpool --workspace-name testsynapseworkspace --resource-group rg \
--tags key1=value1

Update the Spark pool's auto scale configuration.

az synapse spark pool update --name testpool --workspace-name testsynapseworkspace --resource-group rg \
--enable-auto-scale --min-node-count 3 --max-node-count 100

Optional Parameters

--delay

The delay time whose unit is minute.

--enable-auto-pause

The flag of enabling auto pause.

accepted values: false, true
--enable-auto-scale

The flag of enabling auto scale.

accepted values: false, true
--force

The flag of force operation.

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.

--library-requirements

The library requirements file.

--max-node-count

The max node count.

--min-node-count

The min node count.

--name -n

The name of the Spark pool.

--no-wait

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

--node-count

The number of node.

--node-size

The node size.

accepted values: Large, Medium, Small
--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.

--tags

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

--workspace-name

The workspace name.

az synapse spark pool wait

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

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

Required Parameters

--big-data-pool-name

Big Data pool name.

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

--workspace-name

The workspace name.