使用 Power BI REST API

Power BI REST API 提供用于嵌入、管理、治理和用户资源的服务终结点。

使用 Power BI REST API,可以执行以下作:

  • 管理 Power BI 内容

  • 执行管理作

  • 嵌入 Power BI 内容

注意

  • 某些 Power BI API 将工作区称为组。 对组的任何引用都意味着你正在使用工作区。

  • 访问 Power BI REST API 时,请求和响应内容和数据可能会被 Power BI 租户主区域以外的区域中的数据中心处理。

范围

若要使用 Power BI REST API,需要在 Azure 中注册 Azure Active Directory (Azure AD) 应用程序。 Azure AD 应用为 Power BI REST 资源建立权限,并允许访问 Power BI REST API。 若要了解如何注册应用,请参阅 注册 Azure AD 应用程序以用于 Power BI

注册 Azure AD 应用后,可以使用 Azure AD(v1.0) 对其进行身份验证;ADAL)或Microsoft标识平台(v2.0;MSAL) 终结点。 若要详细了解这些身份验证方法的工作原理,请参阅 为什么更新到Microsoft标识平台(v2.0)?

有关 Power BI 访问权限的详细信息,请参阅Microsoft标识平台终结点 权限和同意。

使用服务主体

如果使用 服务主体,则不需要作用域。 启用与 Power BI 一起使用的服务主体后,应用程序的 AD 权限将不再生效。 使用服务主体时,应用程序的权限通过 Power BI 管理门户进行管理。 有关详细信息,请参阅 启用 Power BI 服务管理员设置

添加范围

若要向 Azure AD 应用添加权限,请执行以下步骤:

  1. 在 Azure 中打开应用。

  2. 在左侧 管理下,选择 API 权限

  3. 选择“添加权限

  4. 请求 API 权限 窗口中,选择 Power BI 服务

  5. 选择委派权限。 将显示 API 列表。

  6. 展开要向其添加权限的 API,然后选择要向其添加的权限。

  7. 选择“添加权限

删除范围

若要从 Azure AD 应用中删除权限,请执行以下步骤:

  1. 在 Azure 中打开应用。

  2. 在左侧 管理下,选择 API 权限

  3. 选择 上下文菜单(权限省略号)。

  4. 选择“删除权限

节流

Power BI 使用限制来保持最佳性能和可靠性。 为了防止单个用户过度使用资源,Power BI 限制每个用户在一个时间范围内调用的 API 调用数。

当用户在时间范围内发送超过预先确定限制的请求数时,Power BI 会在短时间内限制来自该用户的任何进一步请求。

当应用程序遇到限制时,Power BI 在响应中返回 HTTP 状态代码 429(请求过多),其中 Retry-After HTTP 标头,指示调用应用程序在发出新请求之前必须等待的秒数。

跨地理区域下载

与执行调用的区域不同的区域中下载文件的作可能比预期时间长。

REST作组

下表列出了 Power BI REST API作组。

注意

若要管理 Power BI Embedded 容量,请使用 Power BI Embedded Azure 资源管理器 REST API

作组 描述
管理员 用于处理管理任务的作。
应用 使用应用的作。
可用功能 返回可用功能的作。
容量 使用容量的作。
仪表板 使用仪表板的作。
数据流存储帐户 用于处理数据流存储帐户的作。
数据流 用于处理数据流的作。
数据集 用于处理数据集的作。
嵌入令牌 使用嵌入令牌的作。
网关 用于处理网关的作。
用于处理组的作。
导入 用于处理导入的作。
管道 用于处理部署管道的作。
推送数据集 用于处理推送数据集的作。
报表 用于处理报表的作。
模板应用 使用模板应用的作。
用户 用于处理用户的作。

后续步骤

Power BI 嵌入式分析文档

.NET SDK