Share via

Pipelines - Update Pipeline

Service:
Power BI REST APIs
API Version:
v1.0

Updates the specified deployment pipeline.

Required Scope

Pipeline.ReadWrite.All 

PATCH https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}

URI Parameters

Name In Required Type Description
pipelineId
 path True

string (uuid)

The deployment pipeline ID

Request Body

Name Type Description
description

string

maxLength: 1024

The updated description for the deployment pipeline
displayName

string

maxLength: 256

The updated display name for the deployment pipeline

Responses

Name Type Description
200 OK

Pipeline

OK

Examples

Update a deployment pipeline example

Sample request

PATCH https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824
Request Body
{
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

Sample response

Status code:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

Definitions

Name Description
Pipeline

A Power BI pipeline
PipelineStage

A Power BI deployment pipeline stage
UpdatePipelineRequest

A request to update an existing deployment pipeline. An updated display name and/or a description is required.

Pipeline

Object

A Power BI pipeline

Name Type Description
description

string

The deployment pipeline description
displayName

string

The deployment pipeline display name
id

string (uuid)

The deployment pipeline ID
stages

PipelineStage[]

The collection of deployment pipeline stages. Only returned when $expand is set to stages in the request.

PipelineStage

Object

A Power BI deployment pipeline stage

Name Type Description
order

integer

The stage order, starting from zero.
workspaceId

string (uuid)

The assigned workspace ID. Only applicable when there's an assigned workspace.
workspaceName

string

The assigned workspace name. Only applicable when there's an assigned workspace and the user has access to the workspace.

UpdatePipelineRequest

Object

A request to update an existing deployment pipeline. An updated display name and/or a description is required.

Name Type Description
description

string

maxLength: 1024

The updated description for the deployment pipeline
displayName

string

maxLength: 256

The updated display name for the deployment pipeline