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 參數

名稱	位於	必要	類型	Description
pipelineId	path	True	string uuid	部署管線識別碼

要求本文

名稱	類型	Description
description	string	部署管線的更新描述
displayName	string	部署管線的更新顯示名稱

回應

名稱	類型	Description
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"
}

定義

名稱	Description
Pipeline	Power BI 管線
PipelineStage	Power BI 部署管線階段
UpdatePipelineRequest	更新現有部署管線的要求。 需要更新的顯示名稱和/或描述。

Pipeline

Power BI 管線

名稱	類型	Description
description	string	部署管線描述
displayName	string	部署管線顯示名稱
id	string	部署管線識別碼
stages	PipelineStage[]	部署管線階段的集合。 只有在要求中設定為 stages 時 $expand 才會傳回 。

PipelineStage

Power BI 部署管線階段

名稱	類型	Description
order	integer	階段順序，從零開始。
workspaceId	string	指派的工作區識別碼。 僅適用于有指派的工作區時。
workspaceName	string	指派的工作區名稱。 只有在有指派的工作區，且使用者具有工作區的存取權時，才適用。

UpdatePipelineRequest

更新現有部署管線的要求。 需要更新的顯示名稱和/或描述。

名稱	類型	Description
description	string	部署管線的更新描述
displayName	string	部署管線的更新顯示名稱