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 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
user
|
path | True |
string |
图 ID 或用户主体名称 (用户的 UPN) |
continuation
|
query |
string |
获取结果集的下一个区块所需的令牌 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
示例
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"
}
定义
名称 | 说明 |
---|---|
Principal |
主体类型 |
Service |
Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。 |
Subscription |
Power BI 项的电子邮件订阅 (,例如报表或仪表板) |
Subscriptions |
用户的 Power BI 订阅的 OData 响应包装器 |
Subscription |
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 项的类型 (例如 |
attachmentFormat |
string |
电子邮件订阅中附加的报表的格式 |
endDate |
string |
电子邮件订阅的结束日期和时间 |
frequency |
string |
电子邮件订阅的频率 |
id |
string |
订阅 ID |
isEnabled |
boolean |
是否启用电子邮件订阅 |
linkToContent |
boolean |
电子邮件订阅中是否存在订阅链接 |
previewImage |
boolean |
电子邮件订阅中是否存在报表的屏幕截图 |
startDate |
string |
电子邮件订阅的开始日期和时间 |
subArtifactDisplayName |
string |
订阅的 Power BI 项的页面名称(如果是报表)。 |
title |
string |
应用名称 |
users |
每个电子邮件订阅者的详细信息。 使用获取用户订阅作为管理员 API 调用时,返回的值是空数组, (null) 。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取报表订阅作为管理员或获取仪表板订阅作为管理员 API 调用检索 Power BI 报表或仪表板上的订阅信息。 |
SubscriptionsByUserResponse
用户的 Power BI 订阅的 OData 响应包装器
名称 | 类型 | 说明 |
---|---|---|
continuationToken |
string |
用于获取结果集下一个区块的令牌 |
continuationUri |
string |
结果集中下一个区块的 URI |
odata.context |
string |
|
subscriptionEntities |
用户的订阅 |
SubscriptionUser
Power BI 电子邮件订阅用户
名称 | 类型 | 说明 |
---|---|---|
displayName |
string |
主体的显示名称 |
emailAddress |
string |
用户的电子邮件地址 |
graphId |
string |
Microsoft Graph 中主体的标识符。 仅适用于管理员 API。 |
identifier |
string |
主体的标识符 |
principalType |
主体类型 |
|
profile |
Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。 |
|
userType |
string |
用户的类型。 |