Admin - Reports GetReportsAsAdmin

参考

服务:: Power BI REST APIs

API 版本:: v1.0

返回组织的报表列表。

权限

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

在服务特权身份验证下运行时，应用不得在 Azure 门户中为其上设置的 Power BI 提供任何管理员许可。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

仅在通过标准委派管理员访问令牌进行身份验证时相关。使用服务主体进行身份验证时不得存在。

局限性

每个租户每小时最多 50 个请求或每分钟 5 个请求。

GET https://api.powerbi.com/v1.0/myorg/admin/reports

具有可选参数:

GET https://api.powerbi.com/v1.0/myorg/admin/reports?$filter={$filter}&$top={$top}&$skip={$skip}

URI 参数

名称	在	类型	说明
$filter	query	string	根据 Odata 筛选器查询参数条件返回结果的子集。
$skip	query	integer (int32)	跳过前 n 个结果
$top	query	integer (int32)	仅返回前 n 个结果

响应

名称	类型	说明
200 OK	AdminReports	还行

示例

Example

示例请求

GET https://api.powerbi.com/v1.0/myorg/admin/reports

示例响应

状态代码:: 200

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715",
      "workspaceId": "278e22a3-2aee-4057-886d-c3225423bc10"
    }
  ]
}

定义

名称	说明
AdminReport	管理员 API 返回的 Power BI 报表。 API 返回以下报表属性列表的子集。子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
AdminReports	Power BI 管理员报表集合的 OData 响应包装器
PrincipalType	主体类型
ReportUser	报表的 Power BI 用户访问权限条目
ReportUserAccessRight	用户对报表拥有的访问权限（权限级别）
ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于 Power BI Embedded 多租户解决方案。
Subscription	Power BI 项的电子邮件订阅（例如报表或仪表板）
SubscriptionUser	Power BI 电子邮件订阅用户

AdminReport

Object

管理员 API 返回的 Power BI 报表。 API 返回以下报表属性列表的子集。子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称	类型	说明
appId	string	仅当报表属于应用时才返回的应用 ID
createdBy	string	报表所有者。仅适用于 2019 年 6 月之后创建的报表。
createdDateTime	string (date-time)	报表创建日期和时间
datasetId	string	报表的数据集 ID
description	string	报表说明
embedUrl	string	报表的嵌入 URL
id	string (uuid)	报表 ID
isOwnedByMe	boolean	指示当前用户是否可以修改或创建报表的副本。
modifiedBy	string	修改报表的最后一个用户
modifiedDateTime	string (date-time)	上次修改报表的日期和时间
name	string	报表的名称。应用报告以前缀 [App] 开头。
originalReportId	string (uuid)	工作区发布为应用时的实际报表 ID。
reportType	enum: PaginatedReport PowerBIReport	报表类型
subscriptions	Subscription[]	（空值）Power BI 项（例如报表或仪表板）的订阅详细信息。将在即将发布的版本中从有效负载响应中删除此属性。可以使用获取报表订阅作为管理员 API 调用来检索 Power BI 报表的订阅信息。
users	ReportUser[]	（空值）Power BI 报表的用户访问详细信息。将在即将发布的版本中从有效负载响应中删除此属性。可以使用获取报表用户作为管理员 API 调用，或使用参数 `getArtifactUsers` API 调用来检索有关 Power BI 报表的用户信息。
webUrl	string	报表的 Web URL
workspaceId	string (uuid)	报表的工作区 ID （GUID）。此属性仅在 GetReportsAsAdmin 中返回。

AdminReports

Object

Power BI 管理员报表集合的 OData 响应包装器

名称	类型	说明
@odata.context	string	OData 上下文
value	AdminReport[]	报表集合

PrincipalType

枚举

主体类型

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

ReportUser

Object

报表的 Power BI 用户访问权限条目

名称	类型	说明
displayName	string	主体的显示名称
emailAddress	string	用户电子邮件地址
graphId	string	Microsoft Graph 中主体的标识符。仅适用于管理员 API。
identifier	string	主体的标识符
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于 Power BI Embedded 多租户解决方案。
reportUserAccessRight	ReportUserAccessRight	用户对报表拥有的访问权限（权限级别）
userType	string	用户的类型。

ReportUserAccessRight

枚举

用户对报表拥有的访问权限（权限级别）

值	说明
None	对报表中的内容没有权限
Owner	授予对报表中内容的读取、写入和重新共享访问权限
Read	授予对报表中内容的读取访问权限
ReadCopy	授予对报表中内容的读取和复制访问权限
ReadReshare	授予对报表中内容的读取和重新共享访问权限
ReadWrite	授予对报表中内容的读取和写入访问权限

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 报表或仪表板上的订阅信息。

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	用户的类型。

通过

Admin - Reports GetReportsAsAdmin

权限

所需范围

局限性

URI 参数

响应

示例

Example

示例请求

示例响应

定义

AdminReport

AdminReports

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

其他资源