Skip to content

spark

Manage Spark compute (settings, custom pools)

Authentication scope: fabric

Get workspace-level Spark settings (custom pools, starter pools, etc.)

Terminal window
fabio spark get-settings --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Examples

Terminal window
fabio spark get-settings --workspace $WS

Read-only · Returns object

Update workspace-level Spark settings

Terminal window
fabio spark update-settings --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--settings string No Settings as JSON (merges with existing settings; conflicts with –runtime-version). Example: ‘{“automaticLog”:{“enabled”:true},“highConcurrency”:{“notebookInteractiveRunEnabled”:true}}’
--runtime-version string No Set the workspace default Spark runtime version (e.g. “1.3” for Spark 3.5, “2.0” for the Spark 4.1 / Delta 4.2 preview). Merged into existing settings

Mutates state · Returns object

List custom Spark pools in a workspace

Terminal window
fabio spark list-pools --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Read-only · Returns list

Show details of a custom Spark pool

Terminal window
fabio spark get-pool --workspace <value> --pool-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--pool-id string Yes Pool ID

Read-only · Returns object

Create a custom Spark pool

Terminal window
fabio spark create-pool --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Pool name
--node-family string No Node family (e.g., MemoryOptimized)
--node-size enum No Node size (e.g., Small, Medium, Large, XLarge, XXLarge) One of: Small, Medium, Large, XLarge, XXLarge.
--auto-scale-enabled bool No Enable auto-scale
--min-node-count string No Minimum node count (when auto-scale is enabled)
--max-node-count string No Maximum node count
--dynamic-executor-enabled bool No Enable dynamic executor allocation
--min-executors string No Minimum executors for dynamic allocation
--max-executors string No Maximum executors for dynamic allocation

Examples

Terminal window
fabio spark create-pool --workspace $WS --content '{"name":"HighMem","nodeFamily":"MemoryOptimized","nodeSize":"Large","autoScale":{"enabled":true,"minNodeCount":1,"maxNodeCount":10}}'

Mutates state · Returns object

Update a custom Spark pool

Terminal window
fabio spark update-pool --workspace <value> --pool-id <value> --config <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--pool-id string Yes Pool ID
--config string Yes Pool configuration as JSON (partial update)

Mutates state · Returns object

Delete a custom Spark pool

Terminal window
fabio spark delete-pool --workspace <value> --pool-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--pool-id string Yes Pool ID

Mutates state · Destructive · Returns void

Get capacity-level Spark settings

Terminal window
fabio spark get-capacity-settings --capacity-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID

Read-only · Returns object

Update capacity-level Spark settings

Terminal window
fabio spark update-capacity-settings --capacity-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID
--file string No JSON file path with settings
--content string No JSON content with settings (inline)

Mutates state · Returns void

List custom Spark pools in a capacity

Terminal window
fabio spark list-capacity-pools --capacity-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID

Read-only · Returns list

Create a custom Spark pool in a capacity

Terminal window
fabio spark create-capacity-pool --capacity-id <value> --name <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID
--name string Yes Pool name
--file string No JSON file path with pool configuration
--content string No JSON content with pool configuration (inline)

Mutates state · Returns object

Get details of a capacity Spark pool

Terminal window
fabio spark get-capacity-pool --capacity-id <value> --pool-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID
--pool-id string Yes Pool ID

Read-only · Returns object

Update a capacity Spark pool

Terminal window
fabio spark update-capacity-pool --capacity-id <value> --pool-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID
--pool-id string Yes Pool ID
--file string No JSON file path with pool configuration
--content string No JSON content with pool configuration (inline)

Mutates state · Returns void

Delete a capacity Spark pool

Terminal window
fabio spark delete-capacity-pool --capacity-id <value> --pool-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID
--pool-id string Yes Pool ID

Mutates state · Destructive · Returns void

List Livy sessions in a workspace

Terminal window
fabio spark list-livy-sessions --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Read-only · Returns list

Get details of a Livy session

Terminal window
fabio spark get-livy-session --workspace <value> --livy-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--livy-id string Yes Livy session ID

Read-only · Returns object

Get Spark advisor real-time advice for a Spark application (monitoring API)

Terminal window
fabio spark get-advice --workspace <value> --item-type <value> --item-id <value> --livy-id <value> --app-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--item-type enum Yes The item type that ran the Spark application One of: notebook, spark-job-definition, lakehouse.
--item-id string Yes The item ID (notebook / Spark job definition / lakehouse)
--livy-id string Yes Livy session ID
--app-id string Yes Spark application ID (e.g. application_1741176604085_0001)
--attempt-id string No Application attempt ID (defaults to the last attempt)

Read-only · Returns object

Get the resource usage timeline for a Spark application (monitoring API)

Terminal window
fabio spark get-resource-usage --workspace <value> --item-type <value> --item-id <value> --livy-id <value> --app-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--item-type enum Yes The item type that ran the Spark application One of: notebook, spark-job-definition, lakehouse.
--item-id string Yes The item ID (notebook / Spark job definition / lakehouse)
--livy-id string Yes Livy session ID
--app-id string Yes Spark application ID
--attempt-id string No Application attempt ID (defaults to the last attempt)

Read-only · Returns object

Get Spark driver / executor / livy logs for a Spark application (monitoring API)

Terminal window
fabio spark get-logs --workspace <value> --item-type <value> --item-id <value> --livy-id <value> --type <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--item-type enum Yes The item type that ran the Spark application One of: notebook, spark-job-definition, lakehouse.
--item-id string Yes The item ID (notebook / Spark job definition / lakehouse)
--livy-id string Yes Livy session ID
--type enum Yes Log type One of: driver, executor, livy.
--app-id string No Spark application ID (not required for –type livy)
--attempt-id string No Application attempt ID (defaults to the last attempt)
--file-name string No Specific log file name (e.g. stderr, stdout) — required for driver/executor content
--meta bool No Return log file metadata (JSON) instead of the raw log content

Read-only · Returns object