Admin - Dashboards GetDashboardSubscriptionsAsAdmin

参考

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/dashboards/{dashboardId}/subscriptions

URI 参数

名称	在	必需	类型	说明
dashboardId	path	True	string uuid	仪表板 ID

响应

名称	类型	说明
200 OK	Subscriptions	确定

示例

Example

Sample Request

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

Sample Response

Status code:: 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"
        }
      ]
    }
  ]
}

定义

名称	说明
PrincipalType	主体类型
ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。
Subscription	Power BI 项的电子邮件订阅 (如报表或仪表板)
Subscriptions	Power BI 订阅的 OData 响应包装器
SubscriptionUser	Power BI 电子邮件订阅用户

PrincipalType

主体类型

名称	类型	说明
App	string	服务主体类型
Group	string	组主体类型
None	string	无主体类型。用于整个组织级别的访问。
User	string	用户主体类型

ServicePrincipalProfile

Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。

名称	类型	说明
displayName	string	服务主体配置文件名称
id	string	服务主体配置文件 ID

Subscription

Power BI 项的电子邮件订阅 (如报表或仪表板)

名称	类型	说明
artifactDisplayName	string	订阅的 Power BI 项的名称 (，例如报表或仪表板)
artifactId	string	订阅的 Power BI 项 (的 ID，例如报表或仪表板)
artifactType	string	Power BI 项的类型 (例如 `Report`、 `Dashboard`或 `Dataset`)
attachmentFormat	string	电子邮件订阅中附加的报表的格式
endDate	string	电子邮件订阅的结束日期和时间
frequency	string	电子邮件订阅的频率
id	string	订阅 ID
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 响应包装器

名称	类型	说明
odata.context	string
value	Subscription[]	Power BI 电子邮件订阅

SubscriptionUser

Power BI 电子邮件订阅用户

名称	类型	说明
displayName	string	主体的显示名称
emailAddress	string	用户的电子邮件地址
graphId	string	Microsoft Graph 中主体的标识符。仅适用于管理员 API。
identifier	string	主体的标识符
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。
userType	string	用户的类型。

通过