Pipelines - Get Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

傳回指定的部署管線。

必要範圍

Pipeline.ReadWrite.All 或 Pipeline.Read.All

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

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}?$expand={$expand}

URI 參數

名稱	位於	必要	類型	Description
pipelineId	path	True	string uuid	部署管線識別碼
$expand	query		string	接受以逗號分隔的資料類型清單，這會在回應中內嵌展開。 支援 stages。

回應

名稱	類型	Description
200 OK	Pipeline	確定

範例

Get a deployment pipeline with its 'stages' expanded example

Get a deployment pipeline without its 'stages' expanded example

Get a deployment pipeline with its 'stages' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824?$expand=stages

Sample Response

Status code:

200

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline",
  "description": "My deployment pipeline",
  "stages": [
    {
      "order": 0,
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workspace-Development"
    },
    {
      "order": 1,
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e"
    },
    {
      "order": 2
    }
  ]
}

Get a deployment pipeline without its 'stages' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824

Sample Response

Status code:

200

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Marketing Deployment Pipeline",
  "description": "Power BI deployment pipeline to manage marketing reports"
}

定義

名稱	Description
Pipeline	Power BI 管線
PipelineStage	Power BI 部署管線階段

Pipeline

Power BI 管線

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

PipelineStage

Power BI 部署管線階段

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