共用方式為

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

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

string

接受以逗號分隔的數據類型清單，這會在響應中內嵌展開。 支援 users 與 stages。
$filter
 query

string

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

integer (int32)

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

integer (int32)

minimum: 1
maximum: 5000

只傳回前 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

範例要求

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": []
    }
  ]
}

定義

名稱 Description
AdminPipeline

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

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

Power BI 部署管線階段
PipelineUser

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

必須的。 用戶對於部署管線的存取權。
PrincipalType

主體類型

AdminPipeline

Object

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

名稱 類型 Description
description

string

部署管線描述
displayName

string

部署管線顯示名稱
id

string (uuid)

部署管線標識碼
stages

PipelineStage[]

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

PipelineUser[]

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

AdminPipelines

Object

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

名稱 類型 Description
@odata.context

string

OData 內容
value

AdminPipeline[]

部署管線的集合

PipelineStage

Object

Power BI 部署管線階段

名稱 類型 Description
order

integer

階段順序，從零開始。
workspaceId

string (uuid)

指派的工作區標識碼。 僅適用於有指派的工作區時。
workspaceName

string

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

PipelineUser

Object

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

名稱 類型 Description
accessRight

PipelineUserAccessRight

必須的。 用戶對於部署管線的存取權。
identifier

string

針對主體類型 User，請提供 UPN。 否則，請提供主體 對象標識碼。
principalType

PrincipalType

主體類型

PipelineUserAccessRight

列舉型別

必須的。 用戶對於部署管線的存取權。

值 Description
Admin

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

PrincipalType

列舉型別

主體類型

值 Description
App

服務主體類型
Group

群組主體類型
None

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

用戶主體類型