Admin - Dashboards GetDashboardsAsAdmin

服務:: Power BI REST APIs

API 版本:: v1.0

傳回組織的儀錶板清單。

權限

用戶必須是網狀架構系統管理員，或使用服務主體進行驗證。
支援委派的許可權。

在服務原始驗證下執行時，應用程式不得在 Azure 入口網站中設定 Power BI 的任何系統管理員同意必要先決條件。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

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

局限性

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

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

含選擇性參數:

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	根據 Odata 篩選查詢參數條件，傳回結果的子集。
$skip	query	integer (int32)	略過前 n 個結果
$top	query	integer (int32)	只傳回前 n 個結果

回應

名稱	類型	Description
200 OK	AdminDashboards	還行

範例

Example

範例要求

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

範例回覆

狀態碼:: 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

Object

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

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

AdminDashboards

Object

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

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

AdminTile

Object

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

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

DashboardUser

Object

儀錶板的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	儀錶板中的內容沒有許可權
Read	授與儀錶板中內容的讀取許可權
ReadWrite	授與儀錶板中內容的讀取和寫入存取權
ReadReshare	授與儀錶板中內容的讀取和重新共用存取權
ReadCopy	授與儀錶板中內容的讀取和複製存取權
Owner	授與報表中內容的讀取、寫入和重新共用存取權

PrincipalType

列舉型別

主體類型

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

ServicePrincipalProfile

Object

Power BI 服務主體配置檔。僅與 Power BI Embedded 多租使用者解決方案相關。

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

Subscription

Object

Power BI 專案的電子郵件訂閱（例如報表或儀錶板）

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

SubscriptionUser

Object

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	使用者的類型。

共用方式為

Admin - Dashboards GetDashboardsAsAdmin

權限

必要範圍

局限性

URI 參數

回應

範例

Example

範例要求

範例回覆

定義

AdminDashboard

AdminDashboards

AdminTile

DashboardUser

DashboardUserAccessRight

PrincipalType

ServicePrincipalProfile

Subscription

SubscriptionUser