FabricTools v0.33.0 Public Preview

Remove-FabricWorkspaceFromStage

Removes a workspace from a deployment pipeline stage.

Syntax

Remove-FabricWorkspaceFromStage [-DeploymentPipelineId] <guid> [-StageId] <guid> [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

The Remove-FabricWorkspaceFromStage function removes the workspace from the specified stage in the specified deployment pipeline. This operation will fail if there's an active deployment operation.

Examples

Example 1

Removes the workspace from the specified deployment pipeline stage.

Remove-FabricWorkspaceFromStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID"

Parameters

NameTypeReq.Pos.PipelineDescription
-DeploymentPipelineId guid ✓Required 0 –

Required. The ID of the deployment pipeline.

-StageId guid ✓Required 1 –

Required. The ID of the deployment pipeline stage.

-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.
  • Requires Pipeline.ReadWrite.All delegated scope.
  • Requires admin deployment pipelines role.
  • This operation will fail if there's an active deployment operation.
  • This API is in preview.

Author: Kamil Nowinski