FabricTools v0.33.0 Public Preview

Remove-FabricWorkspace

Deletes an existing Fabric workspace by its workspace ID or name.

Syntax

Parameter set: ById (Default)
Remove-FabricWorkspace [-WorkspaceId] <guid> [-WhatIf] [-Confirm] [<CommonParameters>]
Parameter set: ByName
Remove-FabricWorkspace -WorkspaceName <string> [-WhatIf] [-Confirm] [<CommonParameters>]

Description

The Remove-FabricWorkspace function deletes a workspace in the Fabric platform by sending a DELETE request to the API. When a name is provided, exactly one accessible workspace must match. If no workspace or multiple workspaces match, no deletion is performed.

Examples

Example 1

Deletes the workspace with the ID "workspace123".

Remove-FabricWorkspace -WorkspaceId "workspace123"

Example 2

Deletes the workspace with the exact name "MyImportantFabricWorkspace".

Remove-FabricWorkspace -Name "MyImportantFabricWorkspace"

Parameters

NameTypeReq.Pos.PipelineDescription
-WorkspaceIdalias: Id guid ✓Required 0 –

The unique identifier of the workspace to be deleted.

-WorkspaceNamealias: Name string ✓Required Named –

The exact display name of the workspace to be deleted. Supports the alias Name. Use WorkspaceId if the name is ambiguous.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-WhatIfalias: wi switch Named –

Runs the command in a mode that only reports what would happen without performing the actions.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.

Notes

  • Calls Confirm-TokenState to ensure token validity before making the API request.

Author: Tiago Balabuch, Kamil Nowinski