Start-FabricDeploymentPipelineStage

Deploys items from one stage to another in a deployment pipeline.

Syntax

Start-FabricDeploymentPipelineStage [-DeploymentPipelineId] <guid> [-SourceStageId] <guid>
 [-TargetStageId] <guid> [[-Items] <array>] [[-Note] <string>] [-NoWait] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

The Start-FabricDeploymentPipelineStage function deploys items from the specified source stage to the target stage. This API supports long running operations (LRO) and will return an operation ID that can be used to track the deployment status.

Examples

Example 1

Deploys all supported items from the source stage to the target stage.

$params = @{
    DeploymentPipelineId = "GUID-GUID-GUID-GUID"
    SourceStageId = "GUID-GUID-GUID-GUID"
    TargetStageId = "GUID-GUID-GUID-GUID"
    Note = "Deploying business ready items"
}
Start-FabricDeploymentPipelineStage @params

Example 2

Deploys specific items from the source stage to the target stage.

$items = @(
    @{
        sourceItemId = "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b"
        itemType = "Datamart"
    },
    @{
        sourceItemId = "1a201f2a-d1d8-45c0-8c61-1676338517de"
        itemType = "SemanticModel"
    }
)
Start-FabricDeploymentPipelineStage -DeploymentPipelineId "GUID-GUID-GUID-GUID" -SourceStageId "GUID-GUID-GUID-GUID" -TargetStageId "GUID-GUID-GUID-GUID" -Items $items -Note "Deploying specific items"

Parameters

Name	Type	Req.	Pos.	Pipeline	Description
-DeploymentPipelineId	guid	✓Required	0	–	Required. The ID of the deployment pipeline.
-SourceStageId	guid	✓Required	1	–	Required. The ID of the source stage to deploy from.
-TargetStageId	guid	✓Required	2	–	Required. The ID of the target stage to deploy to.
-Confirmalias: cf	switch		Named	–	Prompts you for confirmation before running the cmdlet.
-Items	array		3	–	Optional. A list of items to be deployed. If not specified, all supported stage items are deployed. Each item should be a hashtable with: sourceItemId: The ID of the item to deploy itemType: The type of the item (e.g., "Report", "Dashboard", "Datamart", "SemanticModel")
-Note	string		4	–	Optional. A note describing the deployment. Limited to 1024 characters.
-NoWait	switch		Named	–	Optional. If specified, the function will not wait for the deployment to complete and will return immediately. Default: `False`
-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.Deploy delegated scope.
Requires admin deployment pipelines role.
Requires contributor or higher role on both source and target workspaces.
Maximum 300 deployed items per request.
This API is in preview.

Author: Kamil Nowinski

Edit this page on GitHub Report a docs issue