environment

Manage environments (Spark compute, libraries, publish)

Authentication scope: fabric

list

List environments in a workspace

fabio environment list --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID

Output fields: id, displayName, description

Read-only · Returns list

show

Show details of an environment

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

Create a new environment

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

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

Output fields: id, displayName

Mutates state · Returns object

update

Update environment properties (name and/or description)

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

Delete an environment

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

Publish staged changes to an environment

fabio environment publish --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Environment ID

Examples

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

Mutates state · Long-running operation · Returns object

cancel-publish

Cancel a pending publish operation

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-spark-settings

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

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-staging-spark-settings

Get the staging (draft) Spark settings

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

Get the definition of an environment

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

Update the definition of an environment

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

List published libraries of an environment

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

Export external libraries configuration (published)

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

List staging libraries of an environment

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-staging-library

Delete a staging library by name

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-staging-libraries

Export external libraries configuration (staging)

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-staging-libraries

Import external libraries configuration into staging

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-staging-library

Remove an external library from staging

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-staging-library

Upload a custom library file into staging

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

Update staging Spark compute configuration

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 –runtime-version/–spark-property)
--content	string	No	Inline JSON content with spark compute config (full body; conflicts with –runtime-version/–spark-property)
--runtime-version	string	No	Spark runtime version to set (e.g. “1.3” for Spark 3.5, “2.0” for the Spark 4.1 / Delta 4.2 preview). Merged into the existing staging compute (other fields preserved)
--spark-property	string	No	Spark configuration property to set as KEY=VALUE (repeatable). Merged into existing sparkProperties. E.g. –spark-property spark.native.enabled=true

Mutates state · Returns void