通过

Items - Update Item

服务:
Core
API 版本:
v1

更新指定项的属性。
许多项类型都支持此 API，可在 项管理概述中找到支持的项类型和有关其定义结构的信息。

权限

调用方必须具有项的 读取和写入 权限。

所需的委派范围

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

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

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

Microsoft Entra 支持的标识

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

身份 支持
用户 是的
服务主体 和 托管标识 支持调用中的项类型时。 检查要调用的项目类型的相应 API，以查看调用是否受支持。 例如，支持语义模型。

接口

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

URI 参数

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

string (uuid)

项 ID。
workspaceId
 path True

string (uuid)

工作区 ID。

请求正文

名称 类型 说明
description

string

项说明。 最大长度为 256 个字符。
displayName

string

项显示名称。 显示名称必须遵循项类型的命名规则。

响应

名称 类型 说明
200 OK

Item

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • ItemNotFound - 找不到请求的项目。

  • InvalidRequest - 更新请求无效。

示例

Update an item example

示例请求

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

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

示例响应

状态代码:
200 
{
  "displayName": "Item's New name",
  "description": "Item's New description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

定义

名称 说明
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
Item

项对象。
ItemTag

表示应用于项的标记。
ItemType

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

更新项请求。

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

项显示名称。
folderId

string (uuid)

文件夹 ID。
id

string (uuid)

项 ID。
tags

ItemTag[]

已应用的标记列表。
type

ItemType

项类型。
workspaceId

string (uuid)

工作区 ID。

ItemTag

Object

表示应用于项的标记。

名称 类型 说明
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

图形查询集。

UpdateItemRequest

Object

更新项请求。

名称 类型 说明
description

string

项说明。 最大长度为 256 个字符。
displayName

string

项显示名称。 显示名称必须遵循项类型的命名规则。