Items - Get Item

服务:

Core

API 版本:

v1

返回指定项的属性。
许多项类型都支持此 API，可在 项管理概述中找到受支持的项类型。

若要检索其他类型特定的属性，请参阅特定项类型的获取 API 参考页。

权限

调用方必须在工作区上具有 查看器 或更高版本的角色。

所需的委派范围

对于项 API，请使用以下范围类型：

• 泛型范围：Item.Read.All 或 Item.ReadWrite.All
• 特定范围：itemType。Read.All 或 itemType。ReadWrite.All（例如：Notebook.ReadWrite.All）

有关范围的详细信息，请参阅：范围文章。

Microsoft Entra 支持的标识

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

身份	支持
用户	是的
服务主体 和 托管标识	是的

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}

URI 参数

名称	在	必需	类型	说明
itemId	path	True	string uuid	项 ID。
workspaceId	path	True	string uuid	工作区 ID。

响应

名称	类型	说明
200 OK	Item	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： ItemNotFound - 找不到请求的项目。

示例

Get an item example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715

示例响应

状态代码:

200

{
  "displayName": "Item 1",
  "description": "Item 1 description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
Item	项对象。
ItemType	项的类型。 可能会随着时间的推移添加其他项类型。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

错误响应。

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

ErrorResponseDetails

Object

错误响应详细信息。

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

Item

Object

项对象。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
id	string uuid	项 ID。
type	ItemType	项类型。
workspaceId	string uuid	工作区 ID。

ItemType

Enumeration

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

值	说明
Dashboard	PowerBI 仪表板。
DataPipeline	数据管道。
Datamart	PowerBI Datamart。
Environment	环境。
Eventhouse	事件屋。
Eventstream	事件流。
GraphQLApi	GraphQL 项的 API。
KQLDashboard	KQL 仪表板。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
Lakehouse	湖屋
MLExperiment	机器学习试验。
MLModel	机器学习模型。
MirroredDatabase	镜像数据库。
MirroredWarehouse	镜像仓库。
MountedDataFactory	MountedDataFactory。
Notebook	笔记本。
PaginatedReport	PowerBI 分页报表。
Reflex	反射。
Report	PowerBI 报表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 终结点。
SemanticModel	PowerBI 语义模型。
SparkJobDefinition	spark 作业定义。
Warehouse	仓库。