spark-job-definition
Manage Spark job definitions (batch Spark jobs)
Authentication scope: fabric
List Spark job definitions in a workspace
fabio spark-job-definition list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a Spark job definition
fabio spark-job-definition show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
Read-only · Returns object
create
Section titled “create”Create a new Spark job definition
fabio spark-job-definition create --workspace <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--name |
string |
Yes | Spark job definition display name |
--description |
string |
No | Optional description |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Examples
fabio spark-job-definition create --workspace $WS --name "DailyAgg" --file spark_job.jsonMutates state · Returns object
update
Section titled “update”Update Spark job definition properties (name and/or description)
fabio spark-job-definition update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a Spark job definition
fabio spark-job-definition delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
--hard-delete |
bool |
No | Permanently delete (cannot be recovered) |
Mutates state · Destructive · Returns void
get-definition
Section titled “get-definition”Get the definition of a Spark job definition
fabio spark-job-definition get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
--decode |
bool |
No | Decode base64 payloads inline (adds decodedPayload field) |
Read-only · Long-running operation · Returns object
update-definition
Section titled “update-definition”Update the definition of a Spark job definition
fabio spark-job-definition update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
--file |
string |
No | Definition file path (reads file content) |
--content |
string |
No | Definition content (inline) |
Mutates state · Long-running operation · Returns void
Run a Spark job definition
fabio spark-job-definition run --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
--wait |
bool |
No | Wait for the job to complete (polls until finished) |
--timeout |
string |
No | Maximum time to wait in seconds |
--cancel-on-timeout |
bool |
No | Cancel the job if timeout is reached |
Examples
fabio spark-job-definition run --workspace $WS --id $SJD --waitMutates state · Returns object
list-livy-sessions
Section titled “list-livy-sessions”List Livy (Spark) sessions for a Spark job definition
fabio spark-job-definition list-livy-sessions --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
Read-only · Returns list
get-livy-session
Section titled “get-livy-session”Get details of a Livy (Spark) session for a Spark job definition
fabio spark-job-definition get-livy-session --workspace <value> --id <value> --livy-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Spark Job Definition ID |
--livy-id |
string |
Yes | Livy session ID |
Read-only · Returns object