Skip to content

environment

Manage environments (Spark compute, libraries, publish)

Authentication scope: fabric

List environments in a workspace

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

Output fields: id, displayName, description

Read-only · Returns list

Show details of an environment

Terminal window
fabio environment show --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID

Read-only · Returns object

Create a new environment

Terminal window
fabio environment create --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Environment display name
--description string No Optional description
--sensitivity-label string No Sensitivity label ID to apply on creation

Examples

Terminal window
fabio environment create --workspace $WS --name "DataScience-Env"

Output fields: id, displayName

Mutates state · Returns object

Update environment properties (name and/or description)

Terminal window
fabio environment update --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--name string No New display name
--description string No New description

Mutates state · Returns object

Delete an environment

Terminal window
fabio environment delete --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--hard-delete bool No Permanently delete (cannot be recovered)

Mutates state · Destructive · Returns void

Publish staged changes to an environment

Terminal window
fabio environment publish --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID

Examples

Terminal window
fabio environment publish --workspace $WS --id $ENV

Mutates state · Long-running operation · Returns object

Cancel a pending publish operation

Terminal window
fabio environment cancel-publish --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID

Mutates state · Returns object

Get the published Spark settings (compute/pool/driver/executor)

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

Read-only · Returns object

Get the staging (draft) Spark settings

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

Read-only · Returns object

Get the definition of an environment

Terminal window
fabio environment get-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--decode bool No Decode base64 payloads inline (adds decodedPayload field)

Read-only · Long-running operation · Returns object

Update the definition of an environment

Terminal window
fabio environment update-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--file string No Path to definition file
--content string No Inline definition content

Mutates state · Long-running operation · Returns void

List published libraries of an environment

Terminal window
fabio environment list-libraries --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID

Read-only · Returns list

Export external libraries configuration (published)

Terminal window
fabio environment export-libraries --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID

Read-only · Returns object

List staging libraries of an environment

Terminal window
fabio environment list-staging-libraries --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID

Read-only · Returns list

Delete a staging library by name

Terminal window
fabio environment delete-staging-library --workspace <value> --id <value> --library-name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--library-name string Yes Library filename to delete

Mutates state · Destructive · Returns void

Export external libraries configuration (staging)

Terminal window
fabio environment export-staging-libraries --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID

Read-only · Returns object

Import external libraries configuration into staging

Terminal window
fabio environment import-staging-libraries --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--file string No Path to the external-libraries file (e.g. an environment.yml listing public/feed libraries). Sent verbatim as octet-stream
--content string No Inline external-libraries file content (e.g. environment.yml text). Sent verbatim as octet-stream

Mutates state · Returns object

Remove an external library from staging

Terminal window
fabio environment remove-staging-library --workspace <value> --id <value> --library-name <value> --library-version <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--library-name string Yes Library name to remove
--library-version string Yes Library version to remove (the API requires the exact version)

Mutates state · Destructive · Returns void

Upload a custom library file into staging

Terminal window
fabio environment upload-staging-library --workspace <value> --id <value> --file <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--file string Yes Path to the library file to upload (.jar, .whl, .tar.gz, etc.)
--library-name string No Library name (defaults to filename)

Mutates state · Returns object

Update staging Spark compute configuration

Terminal window
fabio environment update-staging-spark-compute --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Environment ID
--file string No Path to JSON file with Spark compute config (full body; conflicts with typed compute flags)
--content string No Inline JSON content with Spark compute config (full body; conflicts with typed compute flags)
--runtime-version string No Spark runtime version to set (e.g. “1.3” for Spark 3.5 [current default], “2.0” for Spark 4.1 / Delta 4.2 — GA but opt-in until it becomes the default ~late Sep 2026). Merged into the existing staging compute (other fields preserved)
--spark-property array No Spark configuration property to set as KEY=VALUE (repeatable). Merged into existing sparkProperties. E.g. –spark-property spark.native.enabled=true
--custom-live-pool-support enum No Enable or disable custom live-pool support. Disabling retains hydration settings One of: Enabled, Disabled.
--max-clusters-to-hydrate integer No Maximum clusters to pre-hydrate per activation cycle (minimum 1)
--cluster-idle-timeout string No Hydrated-cluster idle timeout as an ISO 8601 duration (PT20M through PT24H)
--custom-live-pool-lifespan string No Live-pool activation lifespan as an ISO 8601 duration (PT30M through PT24H)
--clear-custom-live-pool-settings bool No Remove custom live-pool hydration settings. Live-pool support is unchanged unless explicitly set

Examples

Terminal window
fabio environment update-staging-spark-compute --workspace $WS --id $ENV --custom-live-pool-support Enabled --max-clusters-to-hydrate 4 --cluster-idle-timeout PT20M --custom-live-pool-lifespan PT1H
Terminal window
fabio environment update-staging-spark-compute --workspace $WS --id $ENV --custom-live-pool-support Disabled --clear-custom-live-pool-settings

Mutates state · Returns object