Admin - Dashboards GetDashboardsAsAdmin

參考

Service:: Power BI REST APIs

API Version:: v1.0

傳回組織的儀錶板清單。

權限

用戶必須具有系統管理員許可權 (，例如 Office 365 全域管理員或 Power BI 服務管理員) 或使用服務主體進行驗證。
支援委派的許可權。

在服務預備驗證下執行時，應用程式不得在 Azure 入口網站中設定Power BI的任何系統管理員同意必要許可權。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

只有在透過標準委派的系統管理員存取令牌進行驗證時才相關。使用透過服務主體進行驗證時，不得存在。

限制

每小時最多 50 個要求，或每個租使用者每分鐘 5 個要求。

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

With optional parameters:

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

URI 參數

名稱	位於	類型	Description
$expand	query	string	接受以逗號分隔的數據類型清單，這會在響應中內嵌展開。支援 `tiles`。
$filter	query	string	根據布爾條件篩選結果
$skip	query	integer int32	略過前 n 個結果
$top	query	integer int32	只傳回前 n 個結果

回應

名稱	類型	Description
200 OK	AdminDashboards	確定

範例

Example

Sample Request

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false,
      "workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
    }
  ]
}

定義

名稱	Description
AdminDashboard	管理員 API 傳回的 Power BI 儀錶板。 API 會傳回下列儀錶板屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。
AdminDashboards	Power BI 儀錶板集合的 OData 回應包裝函式
AdminTile	管理員 API 傳回的 Power BI 圖格。
DashboardUser	儀錶板的Power BI使用者存取權專案
DashboardUserAccessRight	用戶對於儀錶板的存取權 (許可權等級)
PrincipalType	主體類型
ServicePrincipalProfile	Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。
Subscription	Power BI 專案的電子郵件訂閱 (，例如報表或儀錶板)
SubscriptionUser	Power BI 電子郵件訂閱使用者

AdminDashboard

管理員 API 傳回的 Power BI 儀錶板。 API 會傳回下列儀錶板屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。

名稱	類型	Description
appId	string	只有在儀錶板屬於應用程式時，才會傳回應用程式識別符
displayName	string	儀錶板的顯示名稱
embedUrl	string	儀錶板的內嵌 URL
id	string	儀錶板標識碼
isReadOnly	boolean	儀錶板是否為唯讀
subscriptions	Subscription[]	(空白值) Power BI 專案的訂用帳戶詳細數據， (例如報表或儀錶板) 。這個屬性將會從即將推出的承載回應中移除。您可以使用取得報表訂閱作為 #D93678096B7054B838C5C7B9B2440FF5E API 呼叫來擷取 Power BI 報表的訂閱資訊。
tiles	AdminTile[]	屬於儀錶板的磚
users	DashboardUser[]	(空白值) 儀錶板使用者存取詳細數據。這個屬性將會從即將推出的承載回應中移除。您可以使用取得儀錶板用戶作為管理員 API 呼叫，或使用參數來擷取 Power BI 儀錶板上的用戶資訊。PostWorkspaceInfo API 呼叫`getArtifactUsers`。
webUrl	string	儀錶板的Web URL
workspaceId	string	儀錶板的工作區標識碼 (GUID) 。此屬性只會在 GetDashboardsAsAdmin 中傳回。

AdminDashboards

Power BI 儀錶板集合的 OData 回應包裝函式

名稱	類型	Description
odata.context	string	OData 內容
value	AdminDashboard[]	儀錶板集合

AdminTile

管理員 API 傳回的 Power BI 圖格。

名稱	類型	Description
colSpan	integer	磚範圍欄的數目
datasetId	string	數據集標識碼。僅適用於從報表或使用數據集建立的磚，例如 Q&A 磚。
embedData	string	磚的內嵌數據
embedUrl	string	圖格的內嵌 URL
id	string	磚標識碼
reportId	string	報表標識碼。僅適用於從報表建立的磚。
rowSpan	integer	磚範圍數據列的數目
title	string	磚的顯示名稱

DashboardUser

儀錶板的Power BI使用者存取權專案

名稱	類型	Description
dashboardUserAccessRight	DashboardUserAccessRight	用戶對於儀錶板的存取權 (許可權等級)
displayName	string	主體的顯示名稱
emailAddress	string	使用者的電子郵件地址
graphId	string	Microsoft Graph 中主體的標識碼。僅適用於系統管理員 API。
identifier	string	主體的標識碼
principalType	PrincipalType	主體類型
profile	ServicePrincipalProfile	Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。
userType	string	使用者的類型。

DashboardUserAccessRight

用戶對於儀錶板的存取權 (許可權等級)

名稱	類型	Description
None	string	儀錶板中的內容沒有許可權
Owner	string	授與報表中內容的讀取、寫入和重新共用存取權
Read	string	授與儀錶板中內容的讀取許可權
ReadCopy	string	授與儀錶板中內容的讀取和複製存取權
ReadReshare	string	授與儀錶板中內容的讀取和重新共用存取權
ReadWrite	string	授與儀錶板中內容的讀取和寫入存取權

PrincipalType

主體類型

名稱	類型	Description
App	string	服務主體類型
Group	string	群組主體類型
None	string	沒有主體類型。用於整個組織層級存取。
User	string	用戶主體類型

ServicePrincipalProfile

Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。

名稱	類型	Description
displayName	string	服務主體配置檔名稱
id	string	服務主體配置檔識別碼

Subscription

Power BI 專案的電子郵件訂閱 (，例如報表或儀錶板)

名稱	類型	Description
artifactDisplayName	string	訂閱 Power BI 專案的名稱 (，例如報表或儀錶板)
artifactId	string	訂閱 Power BI 專案的標識碼 (，例如報表或儀錶板)
artifactType	string	Power BI 專案的類型 (例如 `Report`、 `Dashboard`或 `Dataset`)
attachmentFormat	string	電子郵件訂閱中附加報表的格式
endDate	string	電子郵件訂閱的結束日期和時間
frequency	string	電子郵件訂閱的頻率
id	string	訂用帳戶標識碼
isEnabled	boolean	是否啟用電子郵件訂閱
linkToContent	boolean	電子郵件訂閱中是否有訂用帳戶連結
previewImage	boolean	報表的螢幕快照是否存在於電子郵件訂閱中
startDate	string	電子郵件訂閱的開始日期和時間
subArtifactDisplayName	string	如果訂閱的Power BI專案是報表，則為頁面名稱。
title	string	應用程式名稱
users	SubscriptionUser[]	每個電子郵件訂閱者的詳細數據。使用取得使用者訂用帳戶作為 api 呼叫管理員時，傳回的值是空陣列， (null) 。這個屬性將會從即將推出的承載回應中移除。您可以使用取得報表訂閱作為管理員或取得儀錶板訂閱作為管理員 API 呼叫，來擷取 Power BI 報表或儀錶板上的訂閱資訊。

SubscriptionUser

Power BI 電子郵件訂閱使用者

名稱	類型	Description
displayName	string	主體的顯示名稱
emailAddress	string	使用者的電子郵件地址
graphId	string	Microsoft Graph 中主體的標識碼。僅適用於系統管理員 API。
identifier	string	主體的標識碼
principalType	PrincipalType	主體類型
profile	ServicePrincipalProfile	Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。
userType	string	使用者的類型。

共用方式為