FabricTools v0.33.0 Public Preview

Add-FabricWorkspaceToStage

Assigns a workspace to a deployment pipeline stage.

Syntax

Add-FabricWorkspaceToStage [-DeploymentPipelineId] <guid> [-StageId] <guid> [-WorkspaceId] <guid>
 [<CommonParameters>]

Description

The Add-FabricWorkspaceToStage function assigns the specified workspace to the specified deployment pipeline stage. This operation will fail if there's an active deployment operation.

Examples

Example 1

Assigns the specified workspace to the deployment pipeline stage.

Add-FabricWorkspaceToStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -StageId "GUID-GUID-GUID-GUID" -WorkspaceId "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.

-WorkspaceId guid ✓Required 2 –

Required. The ID of the workspace to assign to the stage.

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 and Workspace.ReadWrite.All delegated scopes.
  • Requires admin deployment pipelines role and admin workspace role.
  • This operation will fail if:
  • There's an active deployment operation
  • The specified stage is already assigned to another workspace
  • The specified workspace is already assigned to another stage
  • The caller is not a workspace admin
  • This API is in preview.

Author: Kamil Nowinski