Items - Update Item

Служба:
Core
Версия API:
v1

Обновляет свойства указанного элемента.
Этот API поддерживается для ряда типов элементов, найдите поддерживаемые типы элементов и сведения о структуре их определения в обзоре управления элементами.

Разрешения

Вызывающий объект должен иметь разрешения на чтение и запись для элемента.

Обязательные делегированные области

Для API элементов используются следующие типы областей:

  • Универсальная область: Item.ReadWrite.All
  • Конкретная область: itemType. ReadWrite.All (например: Notebook.ReadWrite.All)

Дополнительные сведения о областях см. в статье области.

поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает Microsoft identities, перечисленных в этом разделе.

Тождество Поддержка
Пользователь Да
Представитель службы и управляемые удостоверения Если тип элемента в вызове поддерживается. Проверьте соответствующий API для вызываемого типа элемента, чтобы узнать, поддерживается ли ваш вызов. Например, поддерживаются семантические модели.

Интерфейс

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

Параметры URI

Имя В Обязательно Тип Описание
itemId
 path True

string (uuid)

Идентификатор элемента.
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя Тип Описание
description

string

Описание элемента. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя элемента. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.

Ответы

Имя Тип Описание
200 OK

Item

Запрос успешно завершен.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Определения

Имя Описание
EntireTenantPrincipal

Представляет субъект клиента
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
GroupDetails

Группировка конкретных сведений. Применимо, если тип субъекта Group.
GroupPrincipal

Представляет группу безопасности.
GroupType

Тип группы. С течением времени могут добавляться дополнительные типы групп.
Item

Объект элемента.
ItemTag

Представляет тег, примененный к элементу.
ItemType

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PrincipalType

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
SensitivityLabel

Представляет метку конфиденциальности, примененную к элементу.
ServicePrincipalDetails

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.
ServicePrincipalPrincipal

Представляет субъект-службу Microsoft Entra.
ServicePrincipalProfileDetails

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Представляет профиль субъекта-службы.
UpdateItemRequest

Обновление запроса элемента.
UserDetails

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.
UserPrincipal

Представляет субъект пользователя Microsoft Entra.

EntireTenantPrincipal

Объект

Представляет субъект клиента

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
type string:

EntireTenant

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

GroupDetails

Объект

Группировка конкретных сведений. Применимо, если тип субъекта Group.

Имя Тип Описание
groupType

GroupType

Тип группы. С течением времени могут добавляться дополнительные типы групп.

GroupPrincipal

Объект

Представляет группу безопасности.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
groupDetails

GroupDetails

Группировка конкретных сведений. Применимо, если тип субъекта Group.
id

string (uuid)

Идентификатор субъекта.
type string:

Group

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

GroupType

Перечисление

Тип группы. С течением времени могут добавляться дополнительные типы групп.

Значение Описание
Unknown

Тип основной группы неизвестен.
SecurityGroup

Субъект — это группа безопасности.
DistributionList

Субъект — это список рассылки.

Item

Объект

Объект элемента.

Имя Тип Описание
defaultIdentity Principal:

Удостоверение элемента по умолчанию.
description

string

Описание элемента.
displayName

string

Отображаемое имя элемента.
folderId

string (uuid)

Идентификатор папки.
id

string (uuid)

Идентификатор элемента.
sensitivityLabel

SensitivityLabel

Метка конфиденциальности элементов.
tags

ItemTag[]

Список примененных тегов.
type

ItemType

Тип элемента.
workspaceId

string (uuid)

Идентификатор рабочей области.

ItemTag

Объект

Представляет тег, примененный к элементу.

Имя Тип Описание
displayName

string

Имя тега.
id

string (uuid)

Идентификатор тега.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение Описание
Dashboard

Панель мониторинга PowerBI.
Report

Отчет PowerBI.
SemanticModel

Семантическая модель PowerBI.
PaginatedReport

Отчет с разбивкой на страницы PowerBI.
Datamart

Datamart PowerBI.
Lakehouse

Озеро.
Eventhouse

Хранилище событий.
Environment

Среда.
KQLDatabase

База данных KQL.
KQLQueryset

Набор запросов KQL.
KQLDashboard

Панель мониторинга KQL.
DataPipeline

Конвейер данных.
Notebook

Записная книжка.
SparkJobDefinition

Определение задания Spark.
MLExperiment

Эксперимент машинного обучения.
MLModel

Модель машинного обучения.
Warehouse

Склад.
Eventstream

Поток событий.
SQLEndpoint

Конечная точка SQL.
MirroredWarehouse

Зеркальный склад.
MirroredDatabase

Зеркальная база данных.
Reflex

Рефлекс.
GraphQLApi

API для элемента GraphQL.
MountedDataFactory

ПодключеннаяdataFactory.
SQLDatabase

База данных SQLDatabase.
CopyJob

Задание копирования.
VariableLibrary

ПеременнаяLibrary.
Dataflow

Поток данных.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Моментальный снимок хранилища.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog

Зеркальный каталог azure databricks.
Map

Карта.
AnomalyDetector

Детектор аномалий.
UserDataFunction

Функция данных пользователя.
GraphModel

A GraphModel.
GraphQuerySet

Набор запросов Graph.
SnowflakeDatabase

База данных Snowflake для хранения таблиц Iceberg, созданных из учетной записи Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

База данных Cosmos DB.
Ontology

An Ontology.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

ЗеркальныйCatalog.

PrincipalType

Перечисление

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

Значение Описание
User

Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal

Субъект является субъектом-службой Microsoft Entra.
Group

Субъект — это группа безопасности.
ServicePrincipalProfile

Субъект — это профиль субъекта-службы.
EntireTenant

Субъект представляет всех пользователей клиента.

SensitivityLabel

Объект

Представляет метку конфиденциальности, примененную к элементу.

Имя Тип Описание
id

string (uuid)

Идентификатор метки конфиденциальности.

ServicePrincipalDetails

Объект

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя Тип Описание
aadAppId

string (uuid)

Microsoft Entra AppId субъекта-службы.

ServicePrincipalPrincipal

Объект

Представляет субъект-службу Microsoft Entra.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
servicePrincipalDetails

ServicePrincipalDetails

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.
type string:

ServicePrincipal

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ServicePrincipalProfileDetails

Объект

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя Тип Описание
parentPrincipal Principal:

Родительский субъект профиля субъекта-службы.

ServicePrincipalProfilePrincipal

Объект

Представляет профиль субъекта-службы.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

UpdateItemRequest

Объект

Обновление запроса элемента.

Имя Тип Описание
description

string

Описание элемента. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя элемента. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.

UserDetails

Объект

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя Тип Описание
userPrincipalName

string

Основное имя пользователя.

UserPrincipal

Объект

Представляет субъект пользователя Microsoft Entra.

Имя Тип Описание
displayName

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
type string:

User

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails

UserDetails

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.