共用方式為


Admin - Users GetUserSubscriptionsAsAdmin

傳回指定使用者的訂用帳戶清單。 這是預覽 API 呼叫。

權限

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

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

限制

每小時最多 200 個要求。

GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions
GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions?continuationToken={continuationToken}

URI 參數

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

string

使用者之 UPN (圖形識別碼或使用者主體名稱)

continuationToken
query

string

取得結果集下一個區塊所需的權杖

回應

名稱 類型 Description
200 OK

SubscriptionsByUserResponse

確定

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/subscriptions

Sample Response

{
  "subscriptionEntities": [
    {
      "id": "9225d0bc-9f5e-4819-a637-799c0c4fh3f1",
      "title": "Team Scorecard-test",
      "artifactId": "0b50f0bf-b22b-4685-83b9-b6d17f7f4e46",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": false,
      "frequency": "Daily",
      "startDate": "8/10/2021 12:00:00 AM",
      "endDate": "8/10/2022 12:00:00 AM",
      "linkToContent": false,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "users": []
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/subscriptions?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

定義

名稱 Description
PrincipalType

主體類型

ServicePrincipalProfile

Power BI 服務主體設定檔。 僅適用于Power BI Embedded多租使用者解決方案

Subscription

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

SubscriptionsByUserResponse

使用者 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 專案的類型 (例如 ReportDashboardDataset)

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 報表或儀表板上的訂閱資訊。

SubscriptionsByUserResponse

使用者 Power BI 訂閱的 OData 回應包裝函式

名稱 類型 Description
continuationToken

string

用來取得結果集下一個區塊的權杖

continuationUri

string

結果集中下一個區塊的 URI

odata.context

string

subscriptionEntities

Subscription[]

使用者的訂用帳戶

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

使用者的類型。