Pipelines - Get Pipeline

服务:

Power BI REST APIs

API 版本:

v1.0

返回指定的部署管道。

所需范围

Pipeline.ReadWrite.All 或 Pipeline.Read.All

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
pipelineId	path	True	string uuid	部署管道 ID
$expand	query		string	接受以逗号分隔的数据类型列表，该列表将在响应中内联展开。 支持 stages。

响应

名称	类型	说明
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

示例请求

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

示例响应

状态代码:

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

示例请求

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

示例响应

状态代码:

200

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

定义

名称	说明
Pipeline	Power BI 管道
PipelineStage	Power BI 部署管道阶段

Pipeline

Object

Power BI 管道

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

PipelineStage

Object

Power BI 部署管道阶段

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