Skip to main content

Remove-ZrWorkspace

Deletes a saved Zaris workspace from local state, optionally releasing its managers so they can be claimed into another workspace. Use it to clean up connection profiles you no longer need.

warning

This is a destructive operation and cannot be undone — the saved workspace is deleted from local state. If it was the active workspace, the session is disconnected. With -Release it also frees the workspace binding on each of its managers server-side. The cmdlet prompts for confirmation (medium impact); use -Confirm:$false to suppress the prompt.

Syntax​

Remove-ZrWorkspace
    -Name <string>
    [-Release]
    [-Token <string>]
    [-WhatIf] [-Confirm]

Description​

Remove-ZrWorkspace deletes the named workspace from local state. If it was the active workspace, the session is disconnected — a subsequent cmdlet falls back to any remaining active workspace or prompts you to connect. By default the workspace's managers stay bound to it (re-adding the workspace reconnects to them); pass -Release to also release each manager's binding server-side, freeing them to be claimed into another workspace. For a secured workspace, supply -Token together with -Release. This cmdlet operates on local workspace state and supports -WhatIf/-Confirm.

Parameters​

ParameterTypeRequiredDescription
-NamestringYesName of the workspace to delete. Position 0.
-ReleaseswitchNoAlso release the workspace binding on each of its managers, freeing them to be claimed into another workspace. Without this, the managers stay bound.
-TokenstringNoAdmin token used with -Release for a secured workspace.

Supports -WhatIf and -Confirm.

Examples​

Delete the saved workspace named prod, leaving its managers bound.

Remove-ZrWorkspace -Name prod

Delete the workspace and release its managers so they can be claimed elsewhere.

Remove-ZrWorkspace -Name prod -Release