通过

Admin - Reports GetReportSubscriptionsAsAdmin

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

返回报表订阅列表以及订阅者详细信息。 这是预览 API 调用。

权限

  • 用户必须是 Fabric 管理员或使用服务主体进行身份验证。
  • 支持委派的权限。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

局限性

每小时最多 200 个请求。 

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

URI 参数

名称 在 必需 类型 说明
reportId
 path True

string (uuid)

报表 ID

响应

名称 类型 说明
200 OK

Subscriptions

还行

示例

Example

示例请求

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

示例响应

状态代码:
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"
        }
      ]
    }
  ]
}

定义

名称 说明
PrincipalType

主体类型
ServicePrincipalProfile

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

Power BI 项的电子邮件订阅（例如报表或仪表板）
Subscriptions

Power BI 订阅的 OData 响应包装器
SubscriptionUser

Power BI 电子邮件订阅用户

PrincipalType

枚举

主体类型

值 说明
None

无主体类型。 用于整个组织级别的访问。
User

用户主体类型
Group

组主体类型
App

服务主体类型

ServicePrincipalProfile

Object

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

名称 类型 说明
displayName

string

服务主体配置文件名称
id

string (uuid)

服务主体配置文件 ID

Subscription

Object

Power BI 项的电子邮件订阅（例如报表或仪表板）

名称 类型 说明
artifactDisplayName

string

订阅的 Power BI 项的名称（例如报表或仪表板）
artifactId

string (uuid)

订阅的 Power BI 项的 ID（例如报表或仪表板）
artifactType

string

Power BI 项的类型（例如 Report、Dashboard或 Dataset）
attachmentFormat

string

电子邮件订阅中附加的报表的格式
endDate

string (date-time)

电子邮件订阅的结束日期和时间
frequency

string

电子邮件订阅的频率
id

string (uuid)

订阅 ID
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 响应包装器

名称 类型 说明
@odata.context

string

value

Subscription[]

Power BI 电子邮件订阅

SubscriptionUser

Object

Power BI 电子邮件订阅用户

名称 类型 说明
displayName

string

主体的显示名称
emailAddress

string

用户的电子邮件地址
graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。
identifier

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

string

用户的类型。