az synapse spark session

  • Reference

Manage Synapse Spark sessions.

Commands

Name Description Type Status
az synapse spark session cancel

Cancel a Spark session.

 Core GA
az synapse spark session create

Create a Spark session.

 Core GA
az synapse spark session list

List all Spark sessions.

 Core GA
az synapse spark session reset-timeout

Reset a Spark session timeout time.

 Core GA
az synapse spark session show

Get a Spark session.

 Core GA

az synapse spark session cancel

Edit

Cancel a Spark session.

az synapse spark session cancel --livy-id
                                --spark-pool-name
                                --workspace-name
                                [--yes]

Examples

Cancel a Spark session.

az synapse spark session cancel  --livy-id 1 --workspace-name testsynapseworkspace --spark-pool-name testsparkpool

Required Parameters

--livy-id

The id of the Spark session job.

--spark-pool-name

The name of the Spark pool.

--workspace-name

The name of the workspace.

Optional Parameters

--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 spark session create

Edit

Create a Spark session.

az synapse spark session create --executor-size {Large, Medium, Small}
                                --executors
                                --name
                                --spark-pool-name
                                --workspace-name
                                [--configuration]
                                [--reference-files]
                                [--tags]

Examples

Create a Spark session.

az synapse spark session create --name testsession  --workspace-name testsynapseworkspace \
--spark-pool-name testsparkpool --executor-size Small --executors 4

Required Parameters

--executor-size

The executor size.

accepted values: Large, Medium, Small
--executors

The number of executors.

--name -n

The Spark session name.

--spark-pool-name

The name of the Spark pool.

--workspace-name

The name of the workspace.

Optional Parameters

--configuration

The configuration of Spark session.

--reference-files

Additional files used for reference in the main definition file.

--tags

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

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 spark session list

Edit

List all Spark sessions.

az synapse spark session list --spark-pool-name
                              --workspace-name
                              [--from-index]
                              [--size]

Examples

List all Spark sessions.

az synapse spark session list --workspace-name testsynapseworkspace --spark-pool-name testsparkpool

Required Parameters

--spark-pool-name

The name of the Spark pool.

--workspace-name

The name of the workspace.

Optional Parameters

--from-index

Optional parameter specifying which index the list should begin from.

--size

The size of the returned list.By default it is 20 and that is the maximum.

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 spark session reset-timeout

Edit

Reset a Spark session timeout time.

az synapse spark session reset-timeout --livy-id
                                       --spark-pool-name
                                       --workspace-name

Examples

Reset a Spark session's timeout time.

az synapse spark session reset-timeout --livy-id 1 --workspace-name testsynapseworkspace --spark-pool-name testsparkpool

Required Parameters

--livy-id

The id of the Spark session job.

--spark-pool-name

The name of the Spark pool.

--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 spark session show

Edit

Get a Spark session.

az synapse spark session show --livy-id
                              --spark-pool-name
                              --workspace-name

Examples

Get a Spark session.

az synapse spark session show --livy-id 1 --workspace-name testsynapseworkspace --spark-pool-name testsparkpool

Required Parameters

--livy-id

The id of the Spark session job.

--spark-pool-name

The name of the Spark pool.

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