通过

Admin - Pipelines GetPipelinesAsAdmin

服务:
Power BI REST APIs
API 版本:
v1.0

返回组织的部署管道列表。

权限

用户必须具有管理员权限或使用服务主体进行身份验证。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

局限性

每小时最多 200 个请求。 

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines
具有可选参数: 
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI 参数

名称 在 必需 类型 说明
$expand
 query

string

接受以逗号分隔的数据类型列表，该列表将在响应中内联扩展。 支持 users 和 stages。
$filter
 query

string

根据布尔条件筛选结果。 此 API 仅支持筛选 孤立部署管道。 不支持的筛选器将返回未筛选的结果。
$skip
 query

integer (int32)

跳过前 n 个结果。 与顶部一起使用可提取超过前 5000 个的结果。
$top
 query

integer (int32)

minimum: 1
maximum: 5000

仅返回前 n 个结果。 此参数必须介于 1-5000 的范围内。

响应

名称 类型 说明
200 OK

AdminPipelines

还行

示例

Get deployment pipelines example
Get deployment pipelines with their 'stages' expanded example
Get deployment pipelines with their 'users' expanded example
Get orphaned deployment pipelines example

Get deployment pipelines example

示例请求

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines

示例响应

状态代码:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports"
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports"
    }
  ]
}

Get deployment pipelines with their 'stages' expanded example

示例请求

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=stages&$top=100

示例响应

状态代码:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "stages": [
        {
          "order": "0",
          "workspaceId": "5dba60b0-d9a7-42a3-b12c-6d9d51e7739a",
          "workspaceName": "SQlAzure-Refresh"
        },
        {
          "order": "1",
          "workspaceId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "workspaceName": "SQlAzure-Refresh[Test]"
        },
        {
          "order": "2"
        }
      ]
    }
  ]
}

Get deployment pipelines with their 'users' expanded example

示例请求

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$top=100

示例响应

状态代码:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "users": [
        {
          "identifier": "john@contoso.com",
          "accessRight": "Admin",
          "principalType": "User"
        },
        {
          "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
          "accessRight": "Admin",
          "principalType": "Group"
        },
        {
          "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
          "accessRight": "Admin",
          "principalType": "App"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

Get orphaned deployment pipelines example

示例请求

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$filter=(not users/any())&$top=100

示例响应

状态代码:
200 
{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

定义

名称 说明
AdminPipeline

用户 API 返回的 Power BI 管道
AdminPipelines

Power BI 部署管道集合的 OData 响应包装器
PipelineStage

Power BI 部署管道阶段
PipelineUser

部署管道的 Power BI 用户访问权限条目
PipelineUserAccessRight

必填。 用户对部署管道具有的访问权限。
PrincipalType

主体类型

AdminPipeline

Object

用户 API 返回的 Power BI 管道

名称 类型 说明
description

string

部署管道说明
displayName

string

部署管道显示名称
id

string (uuid)

部署管道 ID
stages

PipelineStage[]

部署管道阶段的集合。 仅在请求中将 $expand 设置为 stages 时才返回。
users

PipelineUser[]

部署管道用户的集合。 仅在请求中将 $expand 设置为 users 时才返回。

AdminPipelines

Object

Power BI 部署管道集合的 OData 响应包装器

名称 类型 说明
@odata.context

string

OData 上下文
value

AdminPipeline[]

部署管道的集合

PipelineStage

Object

Power BI 部署管道阶段

名称 类型 说明
order

integer

阶段顺序，从零开始。
workspaceId

string (uuid)

分配的工作区 ID。 仅当有分配的工作区时适用。
workspaceName

string

分配的工作区名称。 仅当有分配的工作区并且用户有权访问工作区时，才适用。

PipelineUser

Object

部署管道的 Power BI 用户访问权限条目

名称 类型 说明
accessRight

PipelineUserAccessRight

必填。 用户对部署管道具有的访问权限。
identifier

string

对于主体类型 User，请提供 UPN。 否则，请提供主体 对象 ID。
principalType

PrincipalType

主体类型

PipelineUserAccessRight

枚举

必填。 用户对部署管道具有的访问权限。

值 说明
Admin

向部署管道授予管理员权限

PrincipalType

枚举

主体类型

值 说明
None

无主体类型。 用于整个组织级别的访问。
User

用户主体类型
Group

组主体类型
App

服务主体类型