Deployment Pipelines - Deploy Stage Content

Service:

Core

API Version:

v1

Deploys items from the specified stage of the specified deployment pipeline.

To learn about items that are supported in deployment pipelines, see: Supported items.

Important

This API supports long running operations (LRO).

Permissions

The user must be at least a member on both source and target deployment workspaces. For more information, see: Permissions.

Required Delegated Scopes

Pipeline.Deploy

Limitations

Maximum 300 deployed items per request.

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/deploy

URI Parameters

Name	In	Required	Type	Description
deploymentPipelineId	path	True	string uuid	The deployment pipeline ID.

Request Body

Name	Required	Type	Description
sourceStageId	True	string	The ID of the source stage.
targetStageId	True	string	The ID of the target stage.
createdWorkspaceDetails		DeploymentPipelineNewWorkspaceConfiguration	The configuration details for creating a new workspace. Required when deploying to a stage that has no assigned workspaces, otherwise it is ignored. The deployment will fail if the new workspace configuration details aren't provided when required.
items		ItemDeploymentRequest[]	A list of items to be deployed. If not used, all supported stage items are deployed.
note		string	A note describing the deployment. The text size is limited to 1024 characters.

Responses

Name	Type	Description
200 OK	DeploymentPipelineOperation	Request completed successfully.
202 Accepted		Request accepted, deployment is in progress. Headers Location: string x-ms-operation-id: string deployment-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

Example of deploying all Fabric items (such as reports or dashboards) from a deployment pipeline stage

Example of deploying specific Fabric items (such as reports or dashboards) from a deployment pipeline stage

Example of deploying all Fabric items (such as reports or dashboards) from a deployment pipeline stage

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy

{
  "sourceStageId": "db1577e0-0132-4d6d-92b9-952c359988f2",
  "targetStageId": "f1c39546-6282-4590-8af3-847a6226ad16",
  "note": "Deploying business ready items"
}

Sample response

Status code:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
deployment-id: 1065e6a3-a020-4c0c-ada7-92b5fe99eec5
Retry-After: 30

Example of deploying specific Fabric items (such as reports or dashboards) from a deployment pipeline stage

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy

{
  "sourceStageId": "db1577e0-0132-4d6d-92b9-952c359988f2",
  "targetStageId": "f1c39546-6282-4590-8af3-847a6226ad16",
  "items": [
    {
      "sourceItemId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "itemType": "Datamart"
    },
    {
      "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
      "itemType": "SemanticModel"
    },
    {
      "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "itemType": "Report"
    },
    {
      "sourceItemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
      "itemType": "Dashboard"
    },
    {
      "sourceItemId": "7f08923c-8f57-49d6-a010-8335bb9cbd1b",
      "itemType": "Dashboard"
    }
  ],
  "note": "Deploying business ready items"
}

Sample response

Status code:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
deployment-id: 1065e6a3-a020-4c0c-ada7-92b5fe99eec5
Retry-After: 30

Definitions

Name	Description
DeploymentExecutionPlan	A deployment execution plan.
DeploymentExecutionStep	A deployment execution step.
DeploymentPipelineNewWorkspaceConfiguration	The configuration details for creating a new workspace. Required when deploying to a stage that has no assigned workspaces.
DeploymentPipelineOperation	A Fabric deployment pipeline operation.
DeploymentPipelineOperationNote	A note describing the deployment.
DeploymentPipelineOperationStatus	The deployment pipeline operation status. Additional statuses may be added over time.
DeploymentPipelineOperationType	The operation type. Additional types may be added over time.
DeploymentSourceAndTarget	Source and target items.
DeployRequest	A request to deploy items from a deployment pipeline stage to another consecutive stage. Deploying to a previous stage can be done only when the target stage is empty. If no items were specified, will deploy all supported items from the deployment pipeline stage, otherwise will deploy only the specified items.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GroupDetails	Group specific details. Applicable when the principal type is Group.
GroupType	The type of the group. Additional group types may be added over time.
ItemDeploymentRequest	A request to deploy a Fabric item (such as a report or a dashboard).
ItemPreDeploymentDiffState	Specifies if an item is new, different or identical to items in the target stage before deployment. Additional states may be added over time.
ItemType	The type of the item. Additional item types may be added over time.
PreDeploymentDiffInformation	The number of new, different and identical deployed items before deployment.
Principal
PrincipalType	The type of the principal. Additional principal types may be added over time.
ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is ServicePrincipal.
ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
UserDetails	User principal specific details. Applicable when the principal type is User.

DeploymentExecutionPlan

A deployment execution plan.

Name	Type	Description
steps	DeploymentExecutionStep[]	The collection of execution plan steps.

DeploymentExecutionStep

A deployment execution step.

Name	Type	Description
description	string	The deployment step description.
error	ErrorResponse	The error details. Only applicable if the deployment pipeline operation failed.
index	integer	The step index.
preDeploymentDiffState	ItemPreDeploymentDiffState	Is an item new, different or identical to items in the target stage before deployment.
sourceAndTarget	DeploymentSourceAndTarget	The source and target items of the step.
status	DeploymentPipelineOperationStatus	The status of the deployment pipeline operation. Additional statuses may be added over time.

DeploymentPipelineNewWorkspaceConfiguration

The configuration details for creating a new workspace. Required when deploying to a stage that has no assigned workspaces.

Name	Type	Description
capacityId	string	The ID of the capacity that the new workspace will be assigned to. If unspecified and the API caller has permissions for the source stage workspace capacity, then that capacity will be used. Otherwise, Fabric will select a capacity that the API caller has permissions for.
name	string	The name of the new workspace.

DeploymentPipelineOperation

A Fabric deployment pipeline operation.

Name	Type	Description
executionEndTime	string	The date and time that the operation ended.
executionPlan	DeploymentExecutionPlan	The deployment execution plan.
executionStartTime	string	The date and time that the operation started.
id	string	The operation ID.
lastUpdatedTime	string	The date and time that the operation was last updated.
note	DeploymentPipelineOperationNote	A note representing a description of the operation.
performedBy	Principal	The principal that performed the deployment pipeline operation.
preDeploymentDiffInformation	PreDeploymentDiffInformation	The number of deployed items in the source stage, that are new, identical or different to items in the target stage, before deployment.
sourceStageId	string	The ID of a source deployment pipeline stage.
status	DeploymentPipelineOperationStatus	The deployment pipeline operation status. Additional statuses may be added over time.
targetStageId	string	The ID of a target deployment pipeline stage.
type	DeploymentPipelineOperationType	The operation type. Additional types may be added over time.

DeploymentPipelineOperationNote

A note describing the deployment.

Name	Type	Description
content	string	Text describing the deployment.

DeploymentPipelineOperationStatus

The deployment pipeline operation status. Additional statuses may be added over time.

Name	Type	Description
Failed	string	Operation failed
NotStarted	string	Operation not started
Running	string	Operation running
Succeeded	string	Operation succeeded

DeploymentPipelineOperationType

The operation type. Additional types may be added over time.

Name	Type	Description
Deploy	string	Deploy content between stages.

DeploymentSourceAndTarget

Source and target items.

Name	Type	Description
itemType	ItemType	The type of the Fabric item that will be overwritten in the target stage. Only applies when overwriting a Fabric item.
sourceItemDisplayName	string	The display name of the Fabric item that's deployed from the source stage.
sourceItemId	string	The ID of the Fabric item that's deployed from the source stage.
targetItemDisplayName	string	The name of the Fabric item that will be overwritten in the target stage. Only applies when overwriting a Fabric item.
targetItemId	string	The ID of the Fabric item that will be overwritten in the target stage. Only applies when overwriting a Fabric item.

DeployRequest

A request to deploy items from a deployment pipeline stage to another consecutive stage. Deploying to a previous stage can be done only when the target stage is empty. If no items were specified, will deploy all supported items from the deployment pipeline stage, otherwise will deploy only the specified items.

Name	Type	Description
createdWorkspaceDetails	DeploymentPipelineNewWorkspaceConfiguration	The configuration details for creating a new workspace. Required when deploying to a stage that has no assigned workspaces, otherwise it is ignored. The deployment will fail if the new workspace configuration details aren't provided when required.
items	ItemDeploymentRequest[]	A list of items to be deployed. If not used, all supported stage items are deployed.
note	string	A note describing the deployment. The text size is limited to 1024 characters.
sourceStageId	string	The ID of the source stage.
targetStageId	string	The ID of the target stage.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

GroupDetails

Group specific details. Applicable when the principal type is Group.

Name	Type	Description
groupType	GroupType	The type of the group. Additional group types may be added over time.

GroupType

The type of the group. Additional group types may be added over time.

Name	Type	Description
DistributionList	string	Principal is a distribution list.
SecurityGroup	string	Principal is a security group.
Unknown	string	Principal group type is unknown.

ItemDeploymentRequest

A request to deploy a Fabric item (such as a report or a dashboard).

Name	Type	Description
itemType	ItemType	The Fabric item type.
sourceItemId	string	The ID of the Fabric item to be deployed.

ItemPreDeploymentDiffState

Specifies if an item is new, different or identical to items in the target stage before deployment. Additional states may be added over time.

Name	Type	Description
Different	string	Before deployment, the item in the source stage wasn't identical to the one in the target stage.
New	string	A new deployed item that doesn't exist in the target stage.
NoDifference	string	Before deployment, the item in the source stage was identical to the one in the target stage.

ItemType

The type of the item. Additional item types may be added over time.

Name	Type	Description
Dashboard	string	PowerBI dashboard.
DataPipeline	string	A data pipeline.
Datamart	string	PowerBI datamart.
Environment	string	An environment.
Eventhouse	string	An eventhouse.
Eventstream	string	An eventstream.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	A lakehouse.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredWarehouse	string	A mirrored warehouse.
Notebook	string	A notebook.
PaginatedReport	string	PowerBI paginated report.
Report	string	PowerBI report.
SQLEndpoint	string	An SQL endpoint.
SemanticModel	string	PowerBI semantic model.
SparkJobDefinition	string	A spark job definition.
Warehouse	string	A warehouse.

PreDeploymentDiffInformation

The number of new, different and identical deployed items before deployment.

Name	Type	Description
differentItemsCount	integer	The number of deployed items with differences between source and target stages, before deployment.
newItemsCount	integer	The number of new items deployed to the target stage.
noDifferenceItemsCount	integer	The number of identical deployed items in the source and target stages, before deployment.

Principal

Name	Type	Description
displayName	string	The principal's display name.
groupDetails	GroupDetails	Group specific details. Applicable when the principal type is Group.
id	string	The principal's ID.
servicePrincipalDetails	ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is ServicePrincipal.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
type	PrincipalType	The type of the principal. Additional principal types may be added over time.
userDetails	UserDetails	User principal specific details. Applicable when the principal type is User.

PrincipalType

The type of the principal. Additional principal types may be added over time.

Name	Type	Description
Group	string	Principal is a security group.
ServicePrincipal	string	Principal is a Microsoft Entra service principal.
ServicePrincipalProfile	string	Principal is a service principal profile.
User	string	Principal is a Microsoft Entra user principal.

ServicePrincipalDetails

Service principal specific details. Applicable when the principal type is ServicePrincipal.

Name	Type	Description
aadAppId	string	The service principal's Microsoft Entra AppId.

ServicePrincipalProfileDetails

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal	The service principal profile's parent principal.

UserDetails

User principal specific details. Applicable when the principal type is User.

Name	Type	Description
userPrincipalName	string	The user principal name.