Admin - WorkspaceInfo PostWorkspaceInfo

参考

Service:: Power BI REST APIs

API Version:: v1.0

启动调用以接收所请求的工作区列表的元数据。

重要

如果将或 datasetExpressions 参数设置为 datasetSchematrue，则必须完全启用元数据扫描才能返回数据。有关详细信息，请参阅启用元数据扫描的租户设置。

权限

用户必须具有管理员权限 (，例如 Microsoft 365 全局管理员或 Power BI 服务管理员) 或使用服务主体进行身份验证。

在服务主体身份验证下运行时，应用不得在Azure 门户中为其设置任何管理员同意所需的 Power BI 权限。

必需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

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

限制

每小时最多 500 个请求。
最多 16 个同时请求。

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}

URI 参数

名称	在	类型	说明
datasetExpressions	query	boolean	是否) DAX 和 Mashup 查询 (返回数据集表达式。如果将此参数设置为 `true`，则必须完全启用元数据扫描才能返回数据。有关详细信息，请参阅启用元数据扫描的租户设置。
datasetSchema	query	boolean	是否) 表、列和度量值 (返回数据集架构。如果将此参数设置为 `true`，则必须完全启用元数据扫描才能返回数据。有关详细信息，请参阅启用元数据扫描的租户设置。
datasourceDetails	query	boolean	是否返回数据源详细信息
getArtifactUsers	query	boolean	是否返回 Power BI 项 (（例如报表或仪表板）的用户详细信息)
lineage	query	boolean	是否 (上游数据流、磁贴、数据源 ID) 返回世系信息

请求正文

名称	类型	说明
workspaces	string[]	要扫描的必需工作区 ID (支持 1 到 100 个工作区 ID)

响应

名称	类型	说明
202 Accepted	ScanRequest	已接受

示例

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True

Request Body

{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

Sample Response

Status code:: 202

{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "NotStarted"
}

定义

名称	说明
PowerBIApiErrorResponseDetail	有关 Power BI 错误响应的详细信息
RequiredWorkspaces	所需的工作区请求
ScanRequest	扫描请求

PowerBIApiErrorResponseDetail

有关 Power BI 错误响应的详细信息

名称	类型	说明
code	string	错误代码
message	string	错误消息
target	string	错误目标

RequiredWorkspaces

所需的工作区请求

名称	类型	说明
workspaces	string[]	要扫描的必需工作区 ID (支持 1 到 100 个工作区 ID)

ScanRequest

扫描请求

名称	类型	说明
createdDateTime	string	扫描创建日期和时间
error	PowerBIApiErrorResponseDetail	如果有任何) ，则 (扫描错误
id	string	扫描 ID
status	string	扫描状态

通过