共用方式為

Admin - Pipelines GetPipelinesAsAdmin

  • 參考
Service:
Power BI REST APIs
API Version:
v1.0

傳回組織的部署管線清單。

權限

使用者必須具有系統管理員許可權，或使用服務主體進行驗證。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

限制

每小時最多 200 個要求。 

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI 參數

名稱 位於 必要 類型 Description
$expand
 query

string

接受以逗號分隔的資料類型清單，這會在回應中內嵌展開。 支援 users 和 stages 。
$filter
 query

string

根據布林條件篩選結果。 此 API 僅支援篩選 孤立的部署管線。 不支援的篩選準則會傳回未篩選的結果。
$skip
 query

integer

int32

略過前 n 個結果。 搭配 top 來擷取前 5000 個以上的結果。
$top
 query

integer

int32

只傳回前 n 個結果。 此參數的範圍必須是 1-5000。

回應

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

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

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

定義

名稱 Description
AdminPipeline

使用者 API 傳回的 Power BI 管線
AdminPipelines

Power BI 部署管線集合的 OData 回應包裝函式
PipelineStage

Power BI 部署管線階段
PipelineUser

部署管線的 Power BI 使用者存取權專案
PipelineUserAccessRight

必要。 使用者對於部署管線的存取權。
PrincipalType

主體類型

AdminPipeline

使用者 API 傳回的 Power BI 管線

名稱 類型 Description
description

string

部署管線描述
displayName

string

部署管線顯示名稱
id

string

部署管線識別碼
stages

PipelineStage[]

部署管線階段的集合。 只有在要求中設定 stages 為 時 $expand 才會傳回 。
users

PipelineUser[]

部署管線使用者的集合。 只有在要求中設定 users 為 時 $expand 才會傳回 。

AdminPipelines

Power BI 部署管線集合的 OData 回應包裝函式

名稱 類型 Description
odata.context

string

OData 內容
value

AdminPipeline[]

部署管線的集合

PipelineStage

Power BI 部署管線階段

名稱 類型 Description
order

integer

階段順序，從零開始。
workspaceId

string

指派的工作區識別碼。 僅適用于有指派的工作區時。
workspaceName

string

指派的工作區名稱。 只有在有指派的工作區且使用者有權存取工作區時，才適用。

PipelineUser

部署管線的 Power BI 使用者存取權專案

名稱 類型 Description
accessRight

PipelineUserAccessRight

必要。 使用者對於部署管線的存取權。
identifier

string

針對主體類型 User ，請提供 UPN。 否則，請提供主體 的物件識別碼 。
principalType

PrincipalType

主體類型

PipelineUserAccessRight

必要。 使用者對於部署管線的存取權。

名稱 類型 Description
Admin

string

將系統管理員許可權授與部署管線

PrincipalType

主體類型

名稱 類型 Description
App

string

服務主體類型
Group

string

群組主體類型
None

string

沒有主體類型。 用於整個組織層級存取。
User

string

使用者主體類型