item

Manage items (datasets, reports, notebooks, etc.)

Authentication scope: fabric

list

List items in a workspace

fabio item list --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--type	string	No	Filter by item type (e.g., Notebook, Lakehouse, Warehouse)
--folder	string	No	Filter by folder ID (server-side)
--recursive	enum	No	List items in nested subfolders (default: true when folder is specified) One of: true, false.
--include	string	No	Include additional properties in the response (e.g., description,folderId)

Examples

fabio item list --workspace $WS --all

fabio item list --workspace $WS --continuation-token "eyJ..."

Output fields: id, displayName, type, description

Read-only · Returns list

show

Show details of an item

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

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

Output fields: id, displayName, type, description, workspaceId

Read-only · Returns object

get-definition

Get the definition (source code/content) of an item

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--format	string	No	Definition format (optional, item-type dependent)
--decode	bool	No	Decode base64 payloads inline (adds decodedPayload field)

Read-only · Long-running operation · Returns object

validate-definition

Validate an item definition offline (no API call) before create/update-definition

fabio item validate-definition

Flag	Type	Required	Description
--type	string	No	Item type (e.g., Notebook, SparkJobDefinition). Enables per-type canonical-part checks
--file	string	No	Path to a JSON file containing the definition envelope ({“definition”:{“parts”:[…]}} or {“parts”:[…]})
--definition	string	No	Inline JSON definition envelope
--dir	string	No	Path to a folder of definition parts (assembled into an envelope, like a deploy item folder)
--strict	bool	No	Treat warnings (e.g. non-canonical part paths) as failures (exit non-zero)

Read-only · Returns object

list-connections

List connections used by an item

fabio item list-connections --workspace <value> --id <value>

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

Read-only · Returns list

exists

Check if an item exists (returns {“exists”: true/false})

fabio item exists --workspace <value> --id <value>

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

Read-only · Returns object

url

Get the Fabric portal URL for an item

fabio item url --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--type	string	No	Item type (e.g., Lakehouse, Notebook, Warehouse). Improves URL accuracy

Read-only · Returns object

inspect

Aggregated item view: metadata + definition + connections

fabio item inspect --workspace <value> --id <value>

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

Read-only · Returns object

list-downstream-relations

Get downstream relations for an item (beta API)

fabio item list-downstream-relations --workspace <value> --id <value>

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

Examples

fabio item list-downstream-relations --workspace $WS --id $ITEM_ID

Read-only · Returns object

list-upstream-relations

Get upstream relations for an item (beta API)

fabio item list-upstream-relations --workspace <value> --id <value>

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

Examples

fabio item list-upstream-relations --workspace $WS --id $ITEM_ID

Read-only · Returns object

show-endorsement

Show an item’s endorsement (certification) status [read-only — setting is portal-only]

fabio item show-endorsement --workspace <value> --id <value>

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

Read-only · Returns object

list-endorsements

List items with their endorsement status, optionally filtered [read-only]

fabio item list-endorsements --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--endorsement	string	No	Only show items with this endorsement: Certified, Promoted, Master, or None
--type	string	No	Only query this item type (else all endorsement-readable types)

Read-only · Returns list

create

Create a new item

fabio item create --workspace <value> --name <value> --type <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--name	string	Yes	Item display name
--type	string	Yes	Item type (e.g., Lakehouse, Warehouse)
--description	string	No	Optional description
--sensitivity-label	string	No	Sensitivity label ID to apply on creation

Output fields: id, displayName, type

Mutates state · Returns object

update

Update item properties (name and/or description)

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

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

Mutates state · Returns object

update-definition

Update (override) item definition from file(s)

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--file	string	No	Path to definition file (will be base64-encoded as a single part)
--definition	string	No	Inline JSON definition (full definition payload with parts array)
--update-metadata	bool	No	When true, also update item metadata from .platform file

Mutates state · Long-running operation · Returns void

delete

Delete an item

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

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

Mutates state · Destructive · Returns void

copy

Copy an item to another workspace

fabio item copy --source-workspace <value> --id <value> --dest-workspace <value>

Flag	Type	Required	Description
--source-workspace	string	Yes	Source workspace ID
--id	string	Yes	Item ID to copy
--dest-workspace	string	Yes	Destination workspace ID
--name	string	No	New name for the copy (optional, defaults to source name)

Mutates state · Returns object

move

Move an item to another workspace (copy + delete source)

fabio item move --source-workspace <value> --id <value> --dest-workspace <value>

Flag	Type	Required	Description
--source-workspace	string	Yes	Source workspace ID
--id	string	Yes	Item ID to move
--dest-workspace	string	Yes	Destination workspace ID
--name	string	No	New name (optional, defaults to source name)

Mutates state · Destructive · Returns object

move-to-folder

Move an item to a folder within the same workspace

fabio item move-to-folder --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--folder-id	string	No	Target folder ID (omit or pass empty string to move to workspace root)

Mutates state · Returns void

apply-tags

Apply tags to an item

fabio item apply-tags --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--tag-ids	string	No	Comma-separated tag IDs

Mutates state · Returns object

unapply-tags

Remove tags from an item

fabio item unapply-tags --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--tag-ids	string	No	Comma-separated tag IDs

Mutates state · Returns object

bulk-export-definitions

Bulk export item definitions (LRO)

fabio item bulk-export-definitions --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--file	string	No	Path to JSON file with request body
--content	string	No	Inline JSON request body

Read-only · Long-running operation · Returns object

bulk-import-definitions

Bulk import item definitions (LRO)

fabio item bulk-import-definitions --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--file	string	No	Path to JSON file with request body
--content	string	No	Inline JSON request body

Mutates state · Long-running operation · Returns object

bulk-move

Bulk move items to another workspace (LRO)

fabio item bulk-move --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--file	string	No	Path to JSON file with request body
--content	string	No	Inline JSON request body

Mutates state · Long-running operation · Returns object

bulk-create

Bulk create items in parallel (client-side concurrency)

fabio item bulk-create --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--file	string	No	Path to JSON file with item array
--content	string	No	Inline JSON array of items: [{“displayName”:“…”, “type”:“…”}, …]

Mutates state · Returns object

bulk-delete

Bulk delete items in parallel (client-side concurrency)

fabio item bulk-delete --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--ids	string	No	Comma-separated item IDs to delete

Mutates state · Destructive · Returns object

list-external-data-shares

List external data shares for an item

fabio item list-external-data-shares --workspace <value> --id <value>

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

Read-only · Returns list

create-external-data-share

Create an external data share for an item

fabio item create-external-data-share --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--paths	string	No	Comma-separated paths to share (must start with Files/ or Tables/)
--recipient-type	string	No	Recipient type: User (default) or ServicePrincipal
--recipient-email	string	No	Recipient user principal name / email (required for --recipient-type User)
--recipient-id	string	No	Recipient service-principal ID / Entra object ID (required for --recipient-type ServicePrincipal)
--recipient-tenant-id	string	No	Recipient tenant ID (required for ServicePrincipal, optional for User)

Mutates state · Returns object

show-external-data-share

Show details of an external data share

fabio item show-external-data-share --workspace <value> --id <value> --share-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--share-id	string	Yes	External data share ID

Read-only · Returns object

revoke-external-data-share

Revoke an external data share

fabio item revoke-external-data-share --workspace <value> --id <value> --share-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--share-id	string	Yes	External data share ID

Mutates state · Destructive · Returns object

delete-external-data-share

Delete an external data share

fabio item delete-external-data-share --workspace <value> --id <value> --share-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--share-id	string	Yes	External data share ID

Mutates state · Destructive · Returns void

assign-identity

Assign a managed identity to an item

fabio item assign-identity --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Item ID
--assignment-type	string	No	Identity assignment type (the subject making the request)

Mutates state · Returns object

get-invitation

Get an external data share invitation (platform-level)

fabio item get-invitation --invitation-id <value> --provider-tenant-id <value>

Flag	Type	Required	Description
--invitation-id	string	Yes	Invitation ID
--provider-tenant-id	string	Yes	Provider tenant ID that issued the invitation (required)

Read-only · Returns object

accept-invitation

Accept an external data share invitation

fabio item accept-invitation --invitation-id <value> --workspace <value> --name <value>

Flag	Type	Required	Description
--invitation-id	string	Yes	Invitation ID
--workspace	string	Yes	Target workspace ID
--name	string	Yes	Display name for the created item

Mutates state · Returns object