Pipelines - Update Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

汇报指定的部署管道。

所需范围

Pipeline.ReadWrite.All

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

URI 参数

名称	在	必需	类型	说明
pipelineId	path	True	string uuid	部署管道 ID

请求正文

名称	类型	说明
description	string	部署管道的更新说明
displayName	string	部署管道的更新显示名称

响应

名称	类型	说明
200 OK	Pipeline	确定

示例

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"
}

定义

名称	说明
Pipeline	Power BI 管道
PipelineStage	Power BI 部署管道阶段
UpdatePipelineRequest	更新现有部署管道的请求。 需要更新的显示名称和/或说明。

Pipeline

Power BI 管道

名称	类型	说明
description	string	部署管道说明
displayName	string	部署管道显示名称
id	string	部署管道 ID
stages	PipelineStage[]	部署管道阶段的集合。 仅在请求中设置为stages时$expand返回。

PipelineStage

Power BI 部署管道阶段

名称	类型	说明
order	integer	阶段顺序，从零开始。
workspaceId	string	分配的工作区 ID。 仅当有分配的工作区时适用。
workspaceName	string	分配的工作区名称。 仅当有分配的工作区并且用户有权访问工作区时适用。

UpdatePipelineRequest

更新现有部署管道的请求。 需要更新的显示名称和/或说明。

名称	类型	说明
description	string	部署管道的更新说明
displayName	string	部署管道的更新显示名称