workspace

Manage workspaces

Authentication scope: fabric

list

List all workspaces

fabio workspace list

Flag	Type	Required	Description
--roles	string	No	Filter by role: Admin, Member, Contributor, Viewer (comma-separated)
--capacity	string	No	Filter by capacity ID (client-side filter)

Examples

fabio workspace list --query displayName

fabio workspace list --limit 3

fabio workspace list -o table

Output fields: id, displayName, type, capacityId

Read-only · Returns list

show

Show details of a workspace

fabio workspace show --id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID

Output fields: id, displayName, description, type, capacityId, capacityRegion

Read-only · Returns object

url

Get the Fabric portal URL for a workspace

fabio workspace url --id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID

Read-only · Returns object

create

Create a new workspace

fabio workspace create --name <value>

Flag	Type	Required	Description
--name	string	Yes	Display name for the workspace
--description	string	No	Optional description
--capacity-id	string	No	Assign the new workspace to this capacity on creation (Fabric capacityId)

Examples

fabio workspace create --name "my-project"

Output fields: id, displayName

Mutates state · Returns object

update

Update workspace properties (name and/or description)

fabio workspace update --id <value>

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

Mutates state · Returns object

delete

Delete a workspace

fabio workspace delete --id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID

Examples

fabio workspace delete --id $WS --dry-run

Mutates state · Destructive · Returns void

list-recoverable-items

List soft-deleted items that are still within their retention period

fabio workspace list-recoverable-items --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--type	string	No	Filter by recoverable item type (for example, Lakehouse)
--recoverable-by-me	enum	No	Only return items that the caller can recover immediately One of: true, false.

Examples

fabio workspace list-recoverable-items --workspace $WS --type Lakehouse --recoverable-by-me true

fabio workspace list-recoverable-items --workspace $WS --all

Read-only · Returns list

recover-item

Recover a soft-deleted item and its recoverable descendants

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--item-id	string	Yes	Recoverable item ID

Examples

fabio workspace recover-item --workspace $WS --item-id $ITEM --dry-run

fabio workspace recover-item --workspace $WS --item-id $ITEM

Mutates state · Long-running operation · Returns list

delete-recoverable-item

Permanently delete a recoverable item

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--item-id	string	Yes	Recoverable item ID

Examples

fabio workspace delete-recoverable-item --workspace $WS --item-id $ITEM --dry-run

fabio workspace delete-recoverable-item --workspace $WS --item-id $ITEM

Mutates state · Destructive · Returns void

clone

Clone workspace items from one workspace to another using bulk APIs

fabio workspace clone --source <value> --dest <value>

Flag	Type	Required	Description
--source	string	Yes	Source workspace ID or name
--dest	string	Yes	Destination workspace ID or name
--item-types	string	No	Only clone specific item types (comma-separated, e.g., “Notebook,DataPipeline”)
--allow-pairing-by-name	bool	No	Match items by display name (instead of logicalId) for initial clones

Mutates state · Returns object

assign-capacity

Assign a workspace to a capacity

fabio workspace assign-capacity --id <value> --capacity <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID
--capacity	string	Yes	Target capacity ID

Examples

fabio workspace assign-capacity --id $WS --capacity $CAP_ID

Mutates state · Returns void

unassign-capacity

Unassign a workspace from its capacity

fabio workspace unassign-capacity --id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID

Mutates state · Returns void

provision-identity

Provision a workspace identity (managed identity)

fabio workspace provision-identity --id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID

Examples

fabio workspace provision-identity --id $WS

Output fields: applicationId, servicePrincipalId

Mutates state · Long-running operation · Returns object

deprovision-identity

Deprovision a workspace identity

fabio workspace deprovision-identity --id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID

Mutates state · Returns void

list-role-assignments

List workspace role assignments

fabio workspace list-role-assignments --id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID

Read-only · Returns list

add-role-assignment

Add a role assignment to a workspace

fabio workspace add-role-assignment --id <value> --principal-id <value> --principal-type <value> --role <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID
--principal-id	string	Yes	Principal ID (user, group, or service principal object ID)
--principal-type	enum	Yes	Principal type: User, Group, ServicePrincipal, or ServicePrincipalProfile
--role	enum	Yes	Role to assign (Admin, Member, Contributor, Viewer)

Examples

fabio workspace add-role-assignment --id $WS --principal $USER_ID --principal-type User --role Contributor

Mutates state · Returns object

update-role-assignment

Update a workspace role assignment

fabio workspace update-role-assignment --id <value> --assignment-id <value> --role <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID
--assignment-id	string	Yes	Role assignment ID (same as the principal ID)
--role	string	Yes	New role (Admin, Member, Contributor, Viewer)

Mutates state · Returns object

delete-role-assignment

Delete a workspace role assignment

fabio workspace delete-role-assignment --id <value> --assignment-id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID
--assignment-id	string	Yes	Role assignment ID (same as the principal ID)

Mutates state · Destructive · Returns void

show-role-assignment

Show a specific workspace role assignment

fabio workspace show-role-assignment --id <value> --assignment-id <value>

Flag	Type	Required	Description
--id	string	Yes	Workspace ID
--assignment-id	string	Yes	Role assignment ID

Read-only · Returns object

list-folders

List workspace folders

fabio workspace list-folders --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID

Read-only · Returns list

create-folder

Create a folder in a workspace

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--name	string	Yes	Folder display name
--description	string	No	Optional description
--parent-folder-id	string	No	Optional parent folder ID (omit for root)

Examples

fabio workspace create-folder --id $WS --name "Production"

Mutates state · Returns object

show-folder

Show details of a workspace folder

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--folder-id	string	Yes	Folder ID

Read-only · Returns object

update-folder

Update a workspace folder

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

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

Mutates state · Returns object

delete-folder

Delete a workspace folder

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--folder-id	string	Yes	Folder ID

Mutates state · Destructive · Returns void

move-folder

Move a folder to another parent (or root)

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

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--folder-id	string	Yes	Folder ID to move
--target-folder-id	string	No	Target parent folder ID (omit to move to root)

Mutates state · Returns void

apply-tags

Apply tags to a workspace

fabio workspace apply-tags --workspace <value>

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

Examples

fabio workspace apply-tags --id $WS --tag-ids '["tag-uuid-1"]'

Mutates state · Returns void

unapply-tags

Remove tags from a workspace

fabio workspace unapply-tags --workspace <value>

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

Mutates state · Returns void

assign-to-domain

Assign workspace to a domain

fabio workspace assign-to-domain --workspace <value> --domain-id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--domain-id	string	Yes	Domain ID

Examples

fabio workspace assign-to-domain --id $WS --domain $DOMAIN_ID

Mutates state · Returns void

unassign-from-domain

Unassign workspace from its domain

fabio workspace unassign-from-domain --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID

Mutates state · Returns void

get-onelake-settings

Get OneLake settings for a workspace

fabio workspace get-onelake-settings --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

modify-default-tier

Modify OneLake default tier (Hot, Cool, or Cold)

fabio workspace modify-default-tier --workspace <value> --tier <value>

Flag	Type	Required	Description
--workspace	string	Yes
--tier	enum	Yes	Tier: “Hot”, “Cool”, or “Cold”

Examples

fabio workspace modify-default-tier --id $WS --tier Cold

Mutates state · Returns void

modify-diagnostics

Modify OneLake diagnostics configuration

fabio workspace modify-diagnostics --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

modify-immutability-policy

Modify OneLake immutability policy

fabio workspace modify-immutability-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

export-lifecycle-policy

Export OneLake lifecycle policy

fabio workspace export-lifecycle-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

import-lifecycle-policy

Import OneLake lifecycle policy

fabio workspace import-lifecycle-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

reset-shortcut-cache

Reset OneLake shortcut cache for a workspace

fabio workspace reset-shortcut-cache --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Mutates state · Returns void

get-network-policy

Get workspace network communication policy

fabio workspace get-network-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

set-network-policy

Set workspace network communication policy

fabio workspace set-network-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

get-firewall-rules

Get workspace IP firewall rules

fabio workspace get-firewall-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

set-firewall-rules

Set workspace IP firewall rules (replaces all existing rules)

fabio workspace set-firewall-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No	Inline JSON firewall rules (e.g. ‘{“rules”:[{“displayName”:“Allow Office”,“value”:“10.0.0.0/24”}]}’)

Mutates state · Returns void

get-git-outbound-policy

Get workspace git outbound policy

fabio workspace get-git-outbound-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

set-git-outbound-policy

Set workspace git outbound policy (requires Outbound Access Protection enabled)

fabio workspace set-git-outbound-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

get-inbound-azure-resource-rules

Get workspace inbound Azure resource instance rules

fabio workspace get-inbound-azure-resource-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

set-inbound-azure-resource-rules

Set workspace inbound Azure resource instance rules

fabio workspace set-inbound-azure-resource-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

get-outbound-cloud-connection-rules

Get workspace outbound cloud connection rules (requires OAP enabled)

fabio workspace get-outbound-cloud-connection-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

set-outbound-cloud-connection-rules

Set workspace outbound cloud connection rules (requires OAP enabled)

fabio workspace set-outbound-cloud-connection-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

get-outbound-gateway-rules

Get workspace outbound gateway rules (requires OAP enabled)

fabio workspace get-outbound-gateway-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

set-outbound-gateway-rules

Set workspace outbound gateway rules (requires OAP enabled)

fabio workspace set-outbound-gateway-rules --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns void

get-inbound-external-data-shares-policy

Get workspace inbound External Data Shares bypass policy

fabio workspace get-inbound-external-data-shares-policy --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Examples

fabio workspace get-inbound-external-data-shares-policy --workspace $WS

Read-only · Returns object

set-inbound-external-data-shares-policy

Set workspace inbound External Data Shares bypass policy (preview API, requires admin role)

fabio workspace set-inbound-external-data-shares-policy --workspace <value> --default-action <value>

Flag	Type	Required	Description
--workspace	string	Yes
--default-action	enum	Yes	Whether External Data Shares traffic may bypass inbound networking restrictions One of: Allow, Deny.
--if-match	string	No	ETag from a previous get-inbound-external-data-shares-policy call, for optimistic concurrency

Examples

fabio workspace set-inbound-external-data-shares-policy --workspace $WS --default-action Allow

fabio workspace set-inbound-external-data-shares-policy --workspace $WS --default-action Deny --if-match '"a1b2c3d4"'

Mutates state · Returns object

get-settings

Get workspace settings (properties including automaticMetadataSync)

fabio workspace get-settings --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

update-settings

Update workspace settings (e.g. enable automatic metadata sync)

fabio workspace update-settings --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes
--file	string	No
--content	string	No

Mutates state · Returns object

set-dataset-storage-format

Set default dataset storage format (Small or Large) via Power BI API

fabio workspace set-dataset-storage-format --workspace <value> --format <value>

Flag	Type	Required	Description
--workspace	string	Yes
--format	enum	Yes	Storage format: “Small” or “Large”

Mutates state · Returns void

get-dataset-storage-format

Get default dataset storage format via Power BI API

fabio workspace get-dataset-storage-format --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes

Read-only · Returns object

get-encryption

Get workspace Customer-Managed Key (CMK) encryption settings (Preview)

fabio workspace get-encryption --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID

Read-only · Returns object

assign-encryption

Assign a Customer-Managed Key (CMK) to a workspace, enabling or rotating encryption (Preview)

fabio workspace assign-encryption --workspace <value> --key-identifier <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--key-identifier	string	Yes	Azure Key Vault key identifier (must be a versionless key URI)

Mutates state · Long-running operation · Returns object

reset-encryption

Reset workspace encryption by removing the CMK configuration (reverts to Microsoft-managed keys) (Preview)

fabio workspace reset-encryption --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID

Mutates state · Destructive · Returns void