共用方式為

Admin - Dashboards GetDashboardSubscriptionsAsAdmin

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

傳回儀錶板訂閱清單以及訂閱者詳細數據。 這是預覽 API 呼叫。

權限

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

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

局限性

每小時最多 200 個要求。 

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions

URI 參數

名稱 位於 必要 類型 Description
dashboardId
 path True

string (uuid)

儀錶板標識碼

回應

名稱 類型 Description
200 OK

Subscriptions

還行

範例

Example

範例要求

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions

範例回覆

狀態碼:
200 
{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424275",
      "title": "TestDashboardSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "artifactType": "Dashboard",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": false,
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ]
}

定義

名稱 Description
PrincipalType

主體類型
ServicePrincipalProfile

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

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

Power BI 訂用帳戶的 OData 回應包裝函式
SubscriptionUser

Power BI 電子郵件訂閱使用者

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 報表或儀錶板上的訂用帳戶資訊。

Subscriptions

Object

Power BI 訂用帳戶的 OData 回應包裝函式

名稱 類型 Description
@odata.context

string

value

Subscription[]

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

使用者的類型。