Items - Update Data Pipeline

Service:

DataPipeline

API Version:

v1

Updates the properties of the specified data pipeline.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

DataPipeline.ReadWrite.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	No

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}

URI Parameters

Name	In	Required	Type	Description
dataPipelineId	path	True	string uuid	The data pipeline ID.
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Type	Description
description	string	The data pipeline description. Maximum length is 256 characters.
displayName	string	The data pipeline display name. The display name must follow naming rules according to item type.

Responses

Name	Type	Description
200 OK	DataPipeline	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found InvalidRequest - Invalid update request

Examples

Update a data pipeline example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataPipelines/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "A new name for the DataPipeline",
  "description": "A new description for the data pipeline."
}

Sample response

Status code:

200

{
  "displayName": "A new name for the DataPipeline",
  "description": "A new description for the data pipeline.",
  "type": "DataPipeline",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitions

Name	Description
DataPipeline	A data pipeline object.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemType	The type of the item. Additional item types may be added over time.
UpdateDataPipelineRequest	Update data pipeline request.

DataPipeline

Object

A data pipeline object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
id	string	The item ID.
type	ItemType	The item type.
workspaceId	string	The workspace ID.

ErrorRelatedResource

Object

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

Object

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

Object

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.

ItemType

Enumeration

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

Value	Description
Dashboard	PowerBI dashboard.
DataPipeline	A data pipeline.
Datamart	PowerBI datamart.
Environment	An environment.
Eventhouse	An eventhouse.
Eventstream	An eventstream.
GraphQLApi	An API for GraphQL item.
KQLDashboard	A KQL dashboard.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
Lakehouse	A lakehouse.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
MirroredDatabase	A mirrored database.
MirroredWarehouse	A mirrored warehouse.
MountedDataFactory	A MountedDataFactory.
Notebook	A notebook.
PaginatedReport	PowerBI paginated report.
Reflex	A Reflex.
Report	PowerBI report.
SQLEndpoint	An SQL endpoint.
SemanticModel	PowerBI semantic model.
SparkJobDefinition	A spark job definition.
Warehouse	A warehouse.

UpdateDataPipelineRequest

Object

Update data pipeline request.

Name	Type	Description
description	string	The data pipeline description. Maximum length is 256 characters.
displayName	string	The data pipeline display name. The display name must follow naming rules according to item type.