Admin - WorkspaceInfo GetScanResult

  • 参考
Service:
Power BI REST APIs
API Version:
v1.0

获取指定扫描的扫描结果。

仅在成功调用 GetScanStatus API 后进行此 API 调用。 扫描结果将保留 24 小时。

权限

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

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

必需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

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

限制

每小时最多 500 个请求。 

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/{scanId}

URI 参数

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

string

uuid

扫描 ID，包含在来自工作区的响应或触发扫描的 管理员 - WorkspaceInfo PostWorkspaceInfo API 调用中。

响应

名称 类型 说明
200 OK

WorkspaceInfoResponse

确定

示例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/e7d03602-4873-4760-b37e-1563ef5358e3

Sample Response

Status code:
200 
{
  "workspaces": [
    {
      "id": "d507422c-8d6d-4361-ac7a-30074a8cd0a1",
      "name": "V2 shared",
      "type": "Workspace",
      "state": "Active",
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "reports": [
        {
          "id": "c6d072d1-ed20-4b60-8329-16c4b934203b",
          "name": "CompositeModelParams-RLS",
          "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c",
          "createdDateTime": "2020-06-16T08:22:49.14",
          "modifiedDateTime": "2020-06-16T08:22:49.14",
          "modifiedBy": "john@contoso.com",
          "reportType": "PaginatedReport",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "sensitivityLabel": {
            "labelId": "85b38049-4259-43a2-8feb-244e222d96c0"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "dashboards": [
        {
          "id": "80814ece-9302-49e3-b6bc-bad2f7a86c1a",
          "displayName": "CompositeModelParamsDashboard",
          "isReadOnly": false,
          "tiles": [
            {
              "id": "e687cc21-5b32-48f5-8c5e-4b844f190579",
              "title": "CompositeModelParamsDashboard",
              "reportId": "c6d072d1-ed20-4b60-8329-16c4b934203b",
              "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c"
            }
          ],
          "sensitivityLabel": {
            "labelId": "d9b9581a-0594-4c39-81c5-91ddf40baeda"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "datasets": [
        {
          "id": "e7e8a355-e77b-4418-a7b8-ae5972fdaa03",
          "name": "ExportB",
          "tables": [
            {
              "name": "DW_Revenues",
              "columns": [
                {
                  "name": "RowNumber-2662979B-1795-4F74-8F37-6A1BA8059B61",
                  "dataType": "Int64",
                  "isHidden": true
                }
              ],
              "measures": [
                {
                  "name": "MyMeasure",
                  "expression": "CALCULATE(SELECTEDVALUE('DW_Revenues DW_RevenuesTestToBeDeleted'[Numbers])*10)",
                  "description": "My measure",
                  "isHidden": false
                }
              ],
              "isHidden": false,
              "description": "My table",
              "source": [
                {
                  "expression": "let\n    Source = Revenues,\n    Param = RevenuesParam\nin\n    Source"
                }
              ]
            }
          ],
          "relationships": [],
          "configuredBy": "john@contoso.com",
          "targetStorageMode": "Abf",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "expressions": [
            {
              "name": "Revenues",
              "description": "revenues",
              "expression": "let\n    Source = Sql.Database(\"sqlserver.database.windows.net\", \"DB\"),\n    RevenuesTable = Source{[Schema=\"DB_SCHEMA\",Item=\"DB_SCHEMA_ITEM\"]}[Data]\nin\n    RevenuesTable"
            },
            {
              "name": "RevenuesParam",
              "description": "revenues param",
              "expression": "\"revenues param value\" meta [IsParameterQuery=true, Type=\"Text\", IsParameterQueryRequired=true]"
            }
          ],
          "roles": [
            {
              "name": "Teams",
              "modelPermission": "Read",
              "members": [
                {
                  "memberName": "john@contoso.com",
                  "memberId": "ee96296b-fb71-4f65-a8af-c0ec5a7daced",
                  "memberType": "User",
                  "identityProvider": "AzureAD"
                },
                {
                  "memberName": "group@contoso.com",
                  "memberId": "0a1cdbc3-f82c-4001-8b96-be04ae9d25a3",
                  "memberType": "Group",
                  "identityProvider": "AzureAD"
                }
              ],
              "tablePermissions": [
                {
                  "name": "DW_Revenues DW_RevenuesTest",
                  "filterExpression": "[InTeams] = \"True\""
                }
              ]
            }
          ],
          "upstreamDataflows": [
            {
              "targetDataflowId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
              "groupId": "b7416115-7421-42c0-b525-1505ce40d2f0"
            },
            {
              "targetDataflowId": "06898194-2eaf-4122-bacc-133db1f8585d",
              "groupId": "7263838d-80d7-4b8d-a1f6-50fc27e74a97"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "bf3dc57d-d796-41c0-bbe9-a47f5ee3331e"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "dataflows": [
        {
          "objectId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
          "name": "Azure SQL",
          "description": "Azure SQL dataflow",
          "configuredBy": "john@contoso.com",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "datamarts": [
        {
          "id": "9df8d63c-db5b-44c3-a8e3-9f8c8ec1eec2",
          "name": "MyDatamart",
          "description": "SQL datamart",
          "type": "Sql",
          "configuredBy": "john@contoso.com",
          "configuredById": "5c9f8c24-2a94-4fd2-a105-9a8b096cdsew",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "UpstreamDataflows": [
            {
              "targetDataflowId": "5c9f8c24-2a94-34fd-a105-9a8b096c4555",
              "groupId": "5c9f8c24-4dsc-4fd2-a105-9a8b096c4fgt"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "Users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User",
              "userType": "User",
              "profile": {
                "id": "45416453",
                "displayName": "John's profile"
              },
              "datamartUserAccessRight": "Read"
            }
          ]
        }
      ],
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "appUserAccessRight": "ReadExplore",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ],
  "datasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "qlserver.database.windows.net",
        "database": "dbo.largest_table"
      },
      "datasourceId": "c79ad907-df19-43fe-a0f7-d9f365d67070",
      "gatewayId": "e820592e-f8cf-4a6f-b1ed-566799d29565"
    }
  ],
  "misconfiguredDatasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "sqlserver.database.windows.net",
        "database": "dbo.table"
      },
      "datasourceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab",
      "gatewayId": "505a19c1-4190-4e8e-a4f6-dd72722feced"
    }
  ]
}

定义

名称 说明
ASMashupExpression

数据集表源
Column

数据集列
DashboardUser

仪表板的 Power BI 用户访问权限条目
DashboardUserAccessRight

用户对仪表板 (权限级别的访问权限)

DataflowUser

数据流的 Power BI 用户访问权限条目
DataflowUserAccessRight

用户对数据流的访问权限 (权限级别)

datamartState

数据市场当前状态
datamartStatus

数据市场状态
datamartType

数据市场类型
DatamartUser

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

用户对数据市场的访问权限 (权限级别)

DatasetUser

数据集的 Power BI 用户访问权限条目
DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

Datasource

Power BI 数据源
DatasourceConnectionDetails

Power BI 数据源连接详细信息。 请参阅 获取数据源 或 获取组中的数据源中的示例。
DatasourceUsage

数据源使用情况
DefaultDatasetStorageFormat

组中的默认数据集存储格式
DependentDataflow

依赖于 Power BI 的数据流
DependentDatamart

依赖于 Power BI 的数据市场
DependentDataset

Power BI 相关数据集
EndorsementDetails

Power BI 认可详细信息
Expression

数据集表达式
GroupUser

有权访问工作区的 Power BI 用户
GroupUserAccessRight

访问权限 (用户对工作区拥有的权限级别)

Measure

Power BI 度量值
PrincipalType

主体类型
ReportUser

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

用户对报表的访问权限 (权限级别)

Role

数据集的 RLS 配置中的角色
RoleMember

角色成员
RoleTablePermission

角色筛选器
Row

数据集中的数据行
SensitivityLabel

Power BI 项 (（如报表或仪表板) ）的敏感度标签信息
ServicePrincipalProfile

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

数据集表
WorkspaceInfo

工作区信息详细信息
WorkspaceInfoDashboard

WorkspaceInfo API 返回的 Power BI 仪表板。 API 返回以下仪表板属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
WorkspaceInfoDataflow

工作区信息 API 返回的数据流的元数据。 下面是可能为数据流返回的属性列表。 根据调用的 API、调用方权限和 Power BI 数据库中数据的可用性，仅返回一部分属性。
WorkspaceInfoDatamart

工作区信息 API 返回的 Power BI 数据市场。 API 返回以下数据市场属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
WorkspaceInfoDataset

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

工作区信息 API 返回的 Power BI 报表。 API 返回以下报表属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
WorkspaceInfoResponse

工作区信息响应
WorkspaceInfoTile

WorkspaceInfo API 返回的 Power BI 磁贴

ASMashupExpression

数据集表源

名称 类型 说明
expression

string

源表达式

Column

数据集列

名称 类型 说明
dataCategory

string

可选。 要用于描述此列中数据的数据类别的字符串值。
dataType

string

列数据类型
formatString

string

可选。 FORMAT_STRING中指定的列的格式。
isHidden

boolean

可选。 列是否隐藏。 默认值为 false。
name

string

列名
sortByColumn

string

可选。 在同一个表中用于排序当前列的某一列的字符串名称。
summarizeBy

string

可选。 用于汇总此列的聚合函数。

DashboardUser

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

名称 类型 说明
dashboardUserAccessRight

DashboardUserAccessRight

用户对仪表板 (权限级别的访问权限)

displayName

string

主体的显示名称
emailAddress

string

用户的电子邮件地址
graphId

string

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

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

string

用户的类型。

DashboardUserAccessRight

用户对仪表板 (权限级别的访问权限)

名称 类型 说明
None

string

对 仪表板 中的内容没有权限
Owner

string

授予对报表中内容的读取、写入和重新共享访问权限
Read

string

授予对 仪表板 中内容的读取访问权限
ReadCopy

string

授予对 仪表板 中内容的读取和复制访问权限
ReadReshare

string

授予对 仪表板 中内容的读取和重新共享访问权限
ReadWrite

string

授予对 仪表板 中内容的读取和写入访问权限

DataflowUser

数据流的 Power BI 用户访问权限条目

名称 类型 说明
DataflowUserAccessRight

DataflowUserAccessRight

用户对数据流的访问权限 (权限级别)

displayName

string

主体的显示名称
emailAddress

string

用户的电子邮件地址
graphId

string

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

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

string

用户的类型。

DataflowUserAccessRight

用户对数据流的访问权限 (权限级别)

名称 类型 说明
None

string

删除对数据流中内容的权限
Owner

string

授予对数据流中内容的读取、写入和重新共享访问权限
Read

string

授予对数据流中内容的读取访问权限
ReadReshare

string

授予对数据流中内容的读取和重新共享访问权限
ReadWrite

string

授予对数据流中内容的读取和写入访问权限

datamartState

数据市场当前状态

名称 类型 说明
Active

string

数据市场处于活动状态
Deleted

string

数据市场已删除
Evicted

string

数据市场被逐出
Initialized

string

数据市场已初始化
Invalid

string

数据市场状态无效
Migrating

string

数据市场正在迁移

datamartStatus

数据市场状态

名称 类型 说明
Available

string

数据市场可用
Error

string

数据市场出现错误状态
InProgress

string

数据市场正在进行中
Invalid

string

数据市场具有无效状态
NoCapacity

string

数据市场没有容量
OutOfRegion

string

数据市场已走出区域
SuspendedInCriticalPhase

string

数据市场在关键阶段暂停

datamartType

数据市场类型

名称 类型 说明
Dataverse

string

数据市场为 Dataverse 类型
Datawarehouse

string

数据市场为 Datawarehouse 类型
Ignore

string

数据市场没有类型
Lakehouse

string

数据市场为 Lakehouse 类型
Sql

string

数据市场为 Sql 类型
Unset

string

数据市场类型未设置

DatamartUser

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

名称 类型 说明
datamartUserAccessRight

DatamartUserAccessRight

用户对数据市场的访问权限 (权限级别)

displayName

string

主体的显示名称
emailAddress

string

用户的电子邮件地址
graphId

string

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

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

string

用户的类型。

DatamartUserAccessRight

用户对数据市场的访问权限 (权限级别)

名称 类型 说明
Explore

string

授予浏览数据市场中内容的访问权限
None

string

对数据市场中的内容没有权限
Read

string

授予对数据市场中内容的读取访问权限
ReadExplore

string

授予对数据市场中内容的读取和浏览访问权限
ReadReshare

string

授予对数据市场中内容的读取和重新共享访问权限
ReadReshareExplore

string

授予对数据市场中内容的读取和重新共享和浏览访问权限
ReadWrite

string

授予对数据市场中内容的读取和写入访问权限
ReadWriteExplore

string

授予对数据市场中内容的读取和写入和浏览访问权限
ReadWriteReshare

string

授予对数据市场中内容的读取、写入和重新共享访问权限
ReadWriteReshareExplore

string

授予对数据市场中内容的读取、写入和重新共享和浏览访问权限
Reshare

string

授予对数据市场中内容的重新共享访问权限
Write

string

授予对数据市场中内容的写入访问权限

DatasetUser

数据集的 Power BI 用户访问权限条目

名称 类型 说明
datasetUserAccessRight

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

displayName

string

主体的显示名称
emailAddress

string

用户的电子邮件地址
graphId

string

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

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

string

用户的类型。

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

名称 类型 说明
None

string

删除对数据集中内容的权限
Read

string

授予对数据集中内容的读取访问权限
ReadExplore

string

授予对数据集中内容的读取和浏览访问权限
ReadReshare

string

授予对数据集中内容的读取和重新共享访问权限
ReadReshareExplore

string

授予对数据集中内容的读取、重新共享和浏览访问权限
ReadWrite

string

授予对数据集中内容的读取和写入访问权限
ReadWriteExplore

string

授予对数据集中内容的读取、写入和浏览访问权限
ReadWriteReshare

string

授予对数据集中内容的读取、写入和重新共享访问权限
ReadWriteReshareExplore

string

授予对数据集中内容的读取、写入、重新共享和浏览访问权限

Datasource

Power BI 数据源

名称 类型 说明
connectionDetails

DatasourceConnectionDetails

数据源连接详细信息
connectionString

string

(已弃用) 数据源连接字符串。 仅适用于 DirectQuery。
datasourceId

string

绑定数据源 ID，未绑定到网关时为空
datasourceType

string

数据源类型
gatewayId

string

绑定网关 ID，未绑定到网关时为空。 使用网关群集时，网关 ID 是指主 (群集中第一个) 网关，类似于网关群集 ID。
name

string

(已弃用) 数据源名称。 仅适用于 DirectQuery。

DatasourceConnectionDetails

Power BI 数据源连接详细信息。 请参阅 获取数据源 或 获取组中的数据源中的示例。

名称 类型 说明
account

string

连接帐户
classInfo

string

连接类信息
database

string

连接数据库
domain

string

连接域
emailAddress

string

连接电子邮件地址
kind

string

连接类型
loginServer

string

连接登录服务器
path

string

连接路径
server

string

连接服务器
url

string

连接 URL

DatasourceUsage

数据源使用情况

名称 类型 说明
datasourceInstanceId

string

数据源实例 ID

DefaultDatasetStorageFormat

组中的默认数据集存储格式

名称 类型 说明
Large

string

大型数据集存储格式
Small

string

小型数据集存储格式

DependentDataflow

依赖于 Power BI 的数据流

名称 类型 说明
groupId

string

目标组 ID
targetDataflowId

string

目标数据流 ID

DependentDatamart

依赖于 Power BI 的数据市场

名称 类型 说明
groupId

string

目标组 ID
targetDatamartId

string

目标数据市场 ID

DependentDataset

Power BI 相关数据集

名称 类型 说明
groupId

string

目标组 ID
targetDatasetId

string

目标数据集 ID

EndorsementDetails

Power BI 认可详细信息

名称 类型 说明
certifiedBy

string

认证 Power BI 项的用户 (，例如报表或仪表板)

endorsement

string

认可状态

Expression

数据集表达式

名称 类型 说明
description

string

表达式说明
expression

ASMashupExpression

数据集表源
name

string

表达式名称

GroupUser

有权访问工作区的 Power BI 用户

名称 类型 说明
displayName

string

主体的显示名称
emailAddress

string

用户的电子邮件地址
graphId

string

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

GroupUserAccessRight

访问权限 (用户对工作区拥有的权限级别)

identifier

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

string

用户的类型。

GroupUserAccessRight

访问权限 (用户对工作区拥有的权限级别)

名称 类型 说明
Admin

string

工作区内容的管理员权限
Contributor

string

读取和浏览 (ReadExplore) 工作区内容的访问权限
Member

string

读取、重新共享和浏览 (ReadReshareExplore) 工作区内容的访问权限
None

string

无法访问工作区内容
Viewer

string

只读 (读取对工作区内容的) 访问权限

Measure

Power BI 度量值

名称 类型 说明
description

string

可选。 度量值说明。
expression

string

有效的 DAX 表达式
formatString

string

可选。 一个字符串，描述在按 FORMAT_STRING 中指定的方式显示值时应如何设置值的格式。
isHidden

boolean

可选。 度量值是否隐藏。
name

string

度量值名称

PrincipalType

主体类型

名称 类型 说明
App

string

服务主体类型
Group

string

组主体类型
None

string

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

string

用户主体类型

ReportUser

报表的 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

string

对报表中的内容没有权限
Owner

string

授予对报表中内容的读取、写入和重新共享访问权限
Read

string

授予对报表中内容的读取访问权限
ReadCopy

string

授予对报表中内容的读取和复制访问权限
ReadReshare

string

授予对报表中内容的读取和重新共享访问权限
ReadWrite

string

授予对报表中内容的读取和写入访问权限

Role

数据集的 RLS 配置中的角色

名称 类型 说明
members

RoleMember

列出角色成员的数组
modelPermission

string

角色对数据集拥有的权限。 例如，读取
name

string

角色的名称
tablePermissions

RoleTablePermission

列出为角色定义的所有筛选器的数组

RoleMember

角色成员

名称 类型 说明
identityProvider

string

角色成员标识提供者
memberId

string

标识提供者分配的角色成员 GUID
memberName

string

角色成员的名称
memberType

string

角色成员类型 (用户或组)

RoleTablePermission

角色筛选器

名称 类型 说明
filterExpression

string

筛选筛选器中指定的表的表达式
name

string

筛选器中指定的表的名称

Row

数据集中的数据行

名称 类型 说明
id

string

唯一行 ID

SensitivityLabel

Power BI 项 (（如报表或仪表板) ）的敏感度标签信息

名称 类型 说明
labelId

string

敏感度标签 ID

ServicePrincipalProfile

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

名称 类型 说明
displayName

string

服务主体配置文件名称
id

string

服务主体配置文件 ID

Table

数据集表

名称 类型 说明
columns

Column[]

此表的列架构
description

string

表说明
isHidden

boolean

可选。 此数据集表是否隐藏。
measures

Measure[]

此表中的度量值
name

string

表名称
rows

Row[]

此表中的数据行
source

ASMashupExpression[]

表源

WorkspaceInfo

工作区信息详细信息

名称 类型 说明
capacityId

string

工作区容量 ID
dashboards

WorkspaceInfoDashboard[]

与此工作区关联的仪表板。 返回的仪表板属性列表因 API 调用而异，因此可能不会在 API 响应中看到所有仪表板属性。
dataRetrievalState

string

工作区数据检索状态
dataflows

WorkspaceInfoDataflow[]

与此工作区关联的数据流。 返回的数据流属性列表因 API 调用而异，因此可能不会在 API 响应中看到所有数据流属性。
datamarts

WorkspaceInfoDatamart[]

与此工作区关联的数据市场。 返回的数据市场属性列表因 API 调用而异，因此你可能看不到 API 响应中的所有数据市场属性。
datasets

WorkspaceInfoDataset[]

与此工作区关联的数据集。 返回的数据集属性列表因 API 调用而异，因此可能不会在 API 响应中看到所有数据集属性。
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

工作区中的默认数据集存储格式。 仅在 为 时 isOnDedicatedCapacity 返回 true
description

string

工作区说明
id

string

工作区对象 ID
isOnDedicatedCapacity

boolean

是否将工作区分配给专用容量
name

string

工作区名称
reports

WorkspaceInfoReport[]

与此工作区关联的报表。 返回的报表属性列表因 API 调用而异，因此可能不会在 API 响应中看到所有报表属性。
state

string

工作区状态
type

string

工作区类型
users

GroupUser[]

有权访问工作区的用户。 仅当显式请求时，才会返回该列表。 若要检索经典工作区的用户列表，请使用 Azure Active Directory 图形 API。

WorkspaceInfoDashboard

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

名称 类型 说明
appId

string

应用 ID，仅当仪表板属于某个应用时才返回
dataClassification

string

Power BI 项的数据分类标记 (，例如报表或仪表板)

displayName

string

仪表板的显示名称
id

string

仪表板 ID
isReadOnly

boolean

仪表板是否为只读
sensitivityLabel

SensitivityLabel

敏感度标签
tiles

WorkspaceInfoTile[]

属于仪表板的磁贴
users

DashboardUser[]

() 仪表板用户访问详细信息的空值。 在即将发布的版本中，将从有效负载响应中删除此属性。 可以使用获取仪表板用户作为管理员 API 调用或使用 带 参数的 PostWorkspaceInfo API 调用来检索 Power BI 仪表板上的用户getArtifactUsers信息。

WorkspaceInfoDataflow

工作区信息 API 返回的数据流的元数据。 下面是可能为数据流返回的属性列表。 根据调用的 API、调用方权限和 Power BI 数据库中数据的可用性，仅返回一部分属性。

名称 类型 说明
configuredBy

string

数据流所有者
datasourceUsages

DatasourceUsage[]

数据源用法
description

string

数据流说明
endorsementDetails

EndorsementDetails

认可详细信息
misconfiguredDatasourceUsages

DatasourceUsage[]

数据源配置错误的用法
modelUrl

string

数据流定义文件的 URL (model.json)

modifiedBy

string

修改数据流的用户
modifiedDateTime

string

上次修改数据流的日期和时间
name

string

数据流名称
objectId

string

数据流 ID
sensitivityLabel

SensitivityLabel

敏感度标签
upstreamDataflows

DependentDataflow[]

此项目所依赖的所有数据流的列表
upstreamDatamarts

DependentDatamart[]

此项目所依赖的所有数据市场的列表
users

DataflowUser[]

(数据流用户访问详细信息) 空值。 在即将发布的版本中，将从有效负载响应中删除此属性。 可以使用获取数据流用户作为 管理员 API 调用，或使用带 参数的 PostWorkspaceInfo API 调用getArtifactUser来检索 Power BI 数据流上的用户信息。

WorkspaceInfoDatamart

工作区信息 API 返回的 Power BI 数据市场。 API 返回以下数据市场属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
configuredBy

string

数据市场所有者的名称
configuredById

string

数据市场所有者的 ID
datasourceUsages

DatasourceUsage[]

数据源用法
description

string

数据市场说明
endorsementDetails

EndorsementDetails

数据市场认可详细信息
id

string

数据市场 ID
modifiedBy

string

最后一个修改数据市场的用户
modifiedById

string

修改数据市场的最后一个用户的 ID
modifiedDateTime

string

上次修改数据市场的日期和时间
name

string

数据市场名称
sensitivityLabel

SensitivityLabel

数据市场敏感度标签
state

datamartState

数据市场当前状态
status

datamartStatus

数据市场状态
suspendedBatchId

string

数据市场挂起的批处理 ID
type

datamartType

数据市场类型
upstreamDataflows

DependentDataflow[]

此项目所依赖的所有数据流的列表
upstreamDatamarts

DependentDatamart[]

此项目所依赖的所有数据市场的列表
users

DatamartUser[]

用户访问 Power BI 数据市场的详细信息。

WorkspaceInfoDataset

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

名称 类型 说明
ContentProviderType

string

数据集的内容提供程序类型
CreatedDate

string

数据集创建日期和时间
configuredBy

string

数据集所有者
datasourceUsages

DatasourceUsage[]

数据源用法
description

string

数据集说明
endorsementDetails

EndorsementDetails

认可详细信息
expressions

Expression[]

数据集表达式
id

string

数据集 ID
misconfiguredDatasourceUsages

DatasourceUsage[]

数据源配置错误的使用情况
name

string

数据集名称
roles

Role[]

数据集角色
schemaMayNotBeUpToDate

boolean

数据集架构是否不是最新的
schemaRetrievalError

string

数据集架构检索错误
sensitivityLabel

SensitivityLabel

敏感度标签
tables

Table[]

数据集表
targetStorageMode

string

数据集存储模式
upstreamDataflows

DependentDataflow[]

此项所依赖的所有数据流的列表
upstreamDatamarts

DependentDatamart[]

此项目所依赖的所有数据市场的列表
upstreamDatasets

DependentDataset[]

上游数据集
users

DatasetUser[]

(数据集用户访问详细信息) 空值。 在即将发布的版本中，将从有效负载响应中删除此属性。 可以使用获取数据集用户作为 管理员 API 或带 getArtifactUsers 参数的 PostWorkspaceInfo API，检索有关 Power BI 项 (的用户信息，例如报表或仪表板) 。

WorkspaceInfoReport

工作区信息 API 返回的 Power BI 报表。 API 返回以下报表属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
appId

string

应用 ID，仅在报表属于某个应用时才返回
createdBy

string

报表所有者。 仅适用于 2019 年 6 月之后创建的报表。
createdById

string

报表所有者的 ID。 仅适用于 2019 年 6 月之后创建的报表。
createdDateTime

string

报表创建日期和时间
datasetId

string

报表的数据集 ID
datasetWorkspaceId

string

仅当相关数据集属于其他工作区时，才会返回相关数据集的工作区 ID
description

string

报表说明
endorsementDetails

EndorsementDetails

认可详细信息
id

string

报表 ID
modifiedBy

string

上次修改报表的用户
modifiedById

string

上次修改报表的用户的 ID
modifiedDateTime

string

上次修改报表的日期和时间
name

string

报表的名称
originalReportId

string

将工作区发布为应用时的实际报表 ID。
reportType enum:
  • PaginatedReport
  • PowerBIReport

报表类型
sensitivityLabel

SensitivityLabel

敏感度标签
users

ReportUser[]

() Power BI 报表的用户访问详细信息为空值。 在即将发布的版本中，将从有效负载响应中删除此属性。 可以使用获取报表用户作为管理员 API 调用或带 参数的 PostWorkspaceInfo API 调用来检索 Power BI 报表上的用户getArtifactUsers信息。

WorkspaceInfoResponse

工作区信息响应

名称 类型 说明
datasourceInstances

Datasource[]

与此扫描关联的数据源实例
misconfiguredDatasourceInstances

Datasource[]

与此扫描关联的数据源配置错误实例
workspaces

WorkspaceInfo[]

与此扫描关联的工作区信息

WorkspaceInfoTile

WorkspaceInfo API 返回的 Power BI 磁贴

名称 类型 说明
datasetId

string

数据集 ID。 仅适用于从报表或使用数据集创建的磁贴，例如 Q&A 磁贴。
datasetWorkspaceId

string

仅当相关数据集属于其他工作区时才返回相关数据集的工作区 ID
id

string

磁贴 ID
reportId

string

报表 ID。 仅适用于从报表创建的磁贴。
title

string

磁贴的显示名称