notebook

Manage notebooks

Authentication scope: fabric

list

List notebooks in a workspace

fabio notebook 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 a notebook

fabio notebook show --workspace <value> --id <value>

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

Output fields: id, displayName, description

Read-only · Returns object

create

Create a new notebook

fabio notebook create --workspace <value> --name <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--name	string	Yes	Notebook display name
--content	string	No	Notebook content (Python/PySpark code inline)
--file	string	No	Path to .py or .ipynb file (auto-detected: .py is wrapped into ipynb; .ipynb is sent directly)
--lakehouse	string	No	Default lakehouse ID (binds the notebook so relative paths like Files/ and Tables/ work)
--sensitivity-label	string	No	Sensitivity label ID to apply on creation

Examples

fabio notebook create --workspace $WS --name "ETL-Pipeline" --lakehouse $LH --source etl_notebook.py

Output fields: id, displayName

Mutates state · Returns object

update

Update notebook properties (name and/or description)

fabio notebook update --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--name	string	No	New display name
--description	string	No	New description

Mutates state · Returns object

get-definition

Get the definition (source code) of a notebook

fabio notebook get-definition --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--strip-output	bool	No	Strip cell outputs and execution counts (useful for version control)
--decode	bool	No	Decode base64 payloads inline (adds decodedPayload field)

Examples

fabio notebook get-definition --workspace $WS --id $NB --strip-output

Read-only · Returns object

update-definition

Update the definition (source code) of a notebook

fabio notebook update-definition --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--content	string	No	Python/PySpark code content (replaces entire notebook)
--file	string	No	Path to .ipynb or .py file

Examples

fabio notebook update-definition --workspace $WS --id $NB --source updated_etl.py

Mutates state · Long-running operation · Returns void

delete

Delete a notebook

fabio notebook delete --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--hard-delete	bool	No	Permanently delete (cannot be recovered)

Mutates state · Destructive · Returns void

run

Run a notebook

fabio notebook run --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--parameters	string	No	Notebook parameters as JSON array (e.g., ‘[{“name”:“p1”,“value”:“v1”,“type”:“Text”}]’)
--compute-type	string	No	Compute type: Spark (default), Jupyter, or DataWarehouse
--execution-data	string	No	Full execution data as JSON (advanced; overrides –compute-type). Supports @file.json or @- for stdin
--wait	bool	No	Wait for the notebook run to complete (polls until finished)
--timeout	integer	No	Maximum time to wait in seconds (default: 600) Default: 600.
--cancel-on-timeout	bool	No	Cancel the notebook run if timeout is reached

Examples

fabio notebook run --workspace $WS --id $NB --wait

fabio notebook run --workspace $WS --id $NB --wait --parameters '[{"name":"start_date","value":"2024-01-01","type":"Text"}]'

fabio notebook run --workspace $WS --id $NB --wait --timeout 1800

Mutates state · Long-running operation · Returns object

status

Check the status of a notebook run

fabio notebook status --workspace <value> --id <value> --job-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--job-id	string	Yes	Job instance ID

Examples

fabio notebook status --workspace $WS --id $NB

Read-only · Returns object

get-job-instance

Get details of a specific job instance

fabio notebook get-job-instance --workspace <value> --id <value> --job-instance-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--job-instance-id	string	Yes	Job instance ID

Read-only · Returns object

stop

Stop a running notebook

fabio notebook stop --workspace <value> --id <value> --job-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--job-id	string	Yes	Job instance ID

Examples

fabio notebook stop --workspace $WS --id $NB

Mutates state · Returns void

list-livy-sessions

List Livy sessions for a notebook

fabio notebook list-livy-sessions --workspace <value> --id <value>

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

Read-only · Returns list

get-livy-session

Get details of a Livy session

fabio notebook get-livy-session --workspace <value> --id <value> --livy-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Notebook ID
--livy-id	string	Yes	Livy session ID

Read-only · Returns object