Items - List Items

服务:: Admin

API 版本:: v1

返回活动 Fabric 和 PowerBI 项的列表。

Note

此 API 是预览版的一部分，仅用于评估和开发目的。它可能会根据反馈进行更改，不建议将其用于生产。

此 API 支持分页。每个请求最多可以返回 10,000 条记录。使用响应中提供的连续令牌，可以获取接下来的 10,000 条记录。

页面顺序：

织物物品
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

Permissions

调用方必须是 Fabric 管理员或使用服务主体进行身份验证。

所需的委派范围

Tenant.Read.All 或 Tenant.ReadWrite.All

Limitations

每小时最多 200 个请求。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity	Support
User	Yes
服务主体和托管标识	Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/items

具有可选参数:

GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}

URI 参数

名称	在	类型	说明
capacityId	query	string (uuid)	工作区的容量 ID。
continuationToken	query	string	用于获取下一页项的连续标记。
state	query	string	项状态。支持的状态处于活动状态。
type	query	string	项类型。
workspaceId	query	string (uuid)	工作区 ID。

响应

名称	类型	说明
200 OK	Items	作成功。
Other Status Codes	ErrorResponse	常见错误代码： ItemNotFound - 项 ID 不存在。 InvalidItemType - 项类型无效。 InvalidItemState - 项状态无效。

名称

类型

说明

200 OK

Items

作成功。

Other Status Codes

ErrorResponse

常见错误代码：

ItemNotFound - 项 ID 不存在。
InvalidItemType - 项类型无效。
InvalidItemState - 项状态无效。

示例

Get a list of items using type query parameter example

Get all items in the tenant example

Get list of datamarts using type query parameter example

Get a list of items using type query parameter example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Report

示例响应

状态代码:: 200

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Report",
      "name": "Test Report",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "Jacob@example.com"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items

示例响应

状态代码:: 200

{
  "itemEntities": [
    {
      "id": "17d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "Notebook",
      "name": "Test",
      "description": "Test notebook.",
      "state": "Active",
      "lastUpdatedDate": "2022-04-29T17:47:29.98673",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    },
    {
      "id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "KQLDatabase",
      "name": "TestKusto",
      "description": "Test KQL database.",
      "state": "Active",
      "lastUpdatedDate": "2022-06-30T17:47:29.98673",
      "workspaceId": "8f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F881A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/items?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

Get list of datamarts using type query parameter example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Lakehouse

示例响应

状态代码:: 200

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Lakehouse",
      "name": "Lakehouse 2022-03-16T21:42:38.442Z",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GroupDetails	组特定详细信息。当主体类型 `Group`时适用。
GroupType	组的类型。可能会随着时间的推移添加其他组类型。
Item	项详细信息。
Items	项列表。
ItemState	项状态。可能会随着时间的推移添加其他项状态。
ItemTag	表示应用于项的标记。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。
Principal	表示标识或Microsoft Entra 组。
PrincipalType	主体的类型。可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails	服务主体特定详细信息。当主体类型 `ServicePrincipal`时适用。
ServicePrincipalProfileDetails	服务主体配置文件详细信息。当主体类型 `ServicePrincipalProfile`时适用。
UserDetails	用户主体特定详细信息。当主体类型 `User`时适用。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

GroupDetails

对象

组特定详细信息。当主体类型 Group时适用。

名称	类型	说明
groupType	GroupType	组的类型。可能会随着时间的推移添加其他组类型。

GroupType

枚举

组的类型。可能会随着时间的推移添加其他组类型。

值	说明
Unknown	主体组类型未知。
SecurityGroup	主体是安全组。
DistributionList	主体是通讯组列表。

Item

对象

项详细信息。

名称	类型	说明
capacityId	string (uuid)	工作区的容量 ID。
creatorPrincipal	Principal	项的所有者。
description	string	项目详细信息，包括项类型和项使用情况。
folderId	string (uuid)	项的文件夹 ID。
id	string (uuid)	项 ID。
lastUpdatedDate	string (date-time)	上次更新的日期和时间。
name	string	项名称。
state	ItemState	项状态。
tags	ItemTag[]	已应用的标记列表。
type	ItemType	项类型。包括 Synapse、Notebook、Kqldatabase 和 SynapseWorkbook 等值。
workspaceId	string (uuid)	项的工作区 ID。

Items

对象

项列表。

名称	类型	说明
continuationToken	string	下一个结果集批处理的令牌。如果没有更多记录，则会从响应中删除该记录。
continuationUri	string	下一个结果集批处理的 URI。如果没有更多记录，则会从响应中删除该记录。
itemEntities	Item[]	给定租户的项列表。

ItemState

枚举

项状态。可能会随着时间的推移添加其他项状态。

值	说明
Active	活动项。

ItemTag

对象

表示应用于项的标记。

名称	类型	说明
displayName	string	标签的名称。
id	string (uuid)	标记 ID。

ItemType

枚举

项的类型。可能会随着时间的推移添加其他项类型。

值	说明
Dashboard	PowerBI 仪表板。
Report	PowerBI 报表。
SemanticModel	PowerBI 语义模型。
PaginatedReport	PowerBI 分页报表。
Datamart	PowerBI Datamart。
Lakehouse	湖屋
Eventhouse	事件屋。
Environment	环境。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
KQLDashboard	KQL 仪表板。
DataPipeline	数据管道。
Notebook	笔记本。
SparkJobDefinition	spark 作业定义。
MLExperiment	机器学习试验。
MLModel	机器学习模型。
Warehouse	仓库。
Eventstream	事件流。
SQLEndpoint	SQL 终结点。
MirroredWarehouse	镜像仓库。
MirroredDatabase	镜像数据库。
Reflex	反射。
GraphQLApi	GraphQL 项的 API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	复制作业。
VariableLibrary	VariableLibrary。
Dataflow	数据流。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	仓库快照。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	数字孪生生成器流。
MirroredAzureDatabricksCatalog	镜像的 Azure databricks 目录。
Map	地图。
AnomalyDetector	异常检测器。
UserDataFunction	用户数据函数。
GraphModel	GraphModel。
GraphQuerySet	图形查询集。
SnowflakeDatabase	用于存储从 Snowflake 帐户创建的 Iceberg 表的 Snowflake 数据库。
OperationsAgent	OperationsAgent。
CosmosDBDatabase	Cosmos DB 数据库。

Principal

对象

表示标识或Microsoft Entra 组。

名称	类型	说明
displayName	string	主体的显示名称。
groupDetails	GroupDetails	组特定详细信息。当主体类型 `Group`时适用。
id	string (uuid)	主体的 ID。
servicePrincipalDetails	ServicePrincipalDetails	服务主体特定详细信息。当主体类型 `ServicePrincipal`时适用。
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	服务主体配置文件详细信息。当主体类型 `ServicePrincipalProfile`时适用。
type	PrincipalType	主体的类型。可能会随着时间的推移添加其他主体类型。
userDetails	UserDetails	用户主体特定详细信息。当主体类型 `User`时适用。

PrincipalType

枚举

主体的类型。可能会随着时间的推移添加其他主体类型。

值	说明
User	主体是Microsoft Entra 用户主体。
ServicePrincipal	主体是Microsoft Entra 服务主体。
Group	主体是安全组。
ServicePrincipalProfile	主体是服务主体配置文件。
EntireTenant	主体表示所有租户用户。

ServicePrincipalDetails

对象

服务主体特定详细信息。当主体类型 ServicePrincipal时适用。

名称	类型	说明
aadAppId	string (uuid)	服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

对象

服务主体配置文件详细信息。当主体类型 ServicePrincipalProfile时适用。

名称	类型	说明
parentPrincipal	Principal	服务主体配置文件的父主体。

UserDetails

对象

用户主体特定详细信息。当主体类型 User时适用。

名称	类型	说明
userPrincipalName	string	用户主体名称。

通过

Items - List Items

Permissions

所需的委派范围

Limitations

Microsoft Entra 支持的标识

Interface

URI 参数

响应

示例

Get a list of items using type query parameter example

示例请求

示例响应

Get all items in the tenant example

示例请求

示例响应

Get list of datamarts using type query parameter example

示例请求

示例响应

定义

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails