Admin - Reports GetReportSubscriptionsAsAdmin

參考

Service:: Power BI REST APIs

API Version:: v1.0

傳回報表訂閱清單以及訂閱者詳細資料。這是預覽 API 呼叫。

權限

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

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

限制

每小時最多 200 個要求。

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

URI 參數

名稱	位於	必要	類型	Description
reportId	path	True	string uuid	報表識別碼

回應

名稱	類型	Description
200 OK	Subscriptions	確定

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424274",
      "title": "TestReportSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "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
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 報表或儀表板上的訂用帳戶資訊。

Subscriptions

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

名稱	類型	Description
odata.context	string
value	Subscription[]	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	使用者的型別。

共用方式為