Share via

az synapse spark-job-definition

  • Reference

Manage spark job definitions in a synapse workspace.

Commands

Name Description Type Status
az synapse spark-job-definition create

Create a spark job definition.

 Core GA
az synapse spark-job-definition delete

Delete a spark job definition.

 Core GA
az synapse spark-job-definition list

List spark job definitions.

 Core GA
az synapse spark-job-definition show

Get a spark job definition.

 Core GA
az synapse spark-job-definition update

Update a spark job definition.

 Core GA
az synapse spark-job-definition wait

Place the CLI in a waiting state until a condition of a spark job definition is met.

 Core GA

az synapse spark-job-definition create

Edit

Create a spark job definition.

az synapse spark-job-definition create --file
                                       --name
                                       --workspace-name
                                       [--folder-path]
                                       [--no-wait]

Examples

Create a spark job definition. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse spark-job-definition create --workspace-name testsynapseworkspace \
  --name testsjdname --file @"path/test.json" --folder-path 'folder/subfolder'

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The spark job definition name.

--workspace-name

The workspace name.

Optional Parameters

--folder-path

The folder that this spark job definition is in. If not specified, it will appear at the root level. Eg: folder/subfolder1.

--no-wait

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

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-job-definition delete

Edit

Delete a spark job definition.

az synapse spark-job-definition delete --name
                                       --workspace-name
                                       [--no-wait]

Examples

Delete a spark job definition.

az synapse spark-job-definition delete --workspace-name testsynapseworkspace \
  --name testsjdname

Required Parameters

--name -n

The spark job definition name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

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

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-job-definition list

Edit

List spark job definitions.

az synapse spark-job-definition list --workspace-name

Examples

List spark job definitions.

az synapse spark-job-definition list --workspace-name testsynapseworkspace

Required Parameters

--workspace-name

The workspace name.

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-job-definition show

Edit

Get a spark job definition.

az synapse spark-job-definition show --name
                                     --workspace-name

Examples

Get a spark job definition.

az synapse spark-job-definition show --workspace-name testsynapseworkspace \
  --name testsjdname

Required Parameters

--name -n

The spark job definition name.

--workspace-name

The workspace name.

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-job-definition update

Edit

Update a spark job definition.

az synapse spark-job-definition update --file
                                       --name
                                       --workspace-name
                                       [--folder-path]
                                       [--no-wait]

Examples

Update a spark job definition. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse spark-job-definition update --workspace-name testsynapseworkspace \
  --name testsjdname --file @"path/test.json" --folder-path 'folder/subfolder'

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The spark job definition name.

--workspace-name

The workspace name.

Optional Parameters

--folder-path

The folder that this spark job definition is in. If not specified, it will appear at the root level. Eg: folder/subfolder1.

--no-wait

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

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-job-definition wait

Edit

Place the CLI in a waiting state until a condition of a spark job definition is met.

az synapse spark-job-definition wait --name
                                     --workspace-name
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--interval]
                                     [--timeout]
                                     [--updated]

Required Parameters

--name -n

The spark job definition name.

--workspace-name

The workspace name.

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.