Items - Update Logical Id

Служба:: Core

Версия API:: v1

Обновляет логический идентификатор для указанного элемента.
Соответствующие экземпляры элементов используют один и тот же логический идентификатор. Используйте эту операцию для разрешения конфликтов логического идентификатора. Перед изменением логического идентификатора просмотрите все службы автоматизации, которые зависят от текущего значения и при необходимости обновите их. В противном случае эти автоматизации могут не найти элемент или завершиться ошибкой из-за повторяющегося отображаемого имени. Дополнительные сведения см. в разделе "Устранение конфликтов логического идентификатора" в Microsoft Fabric.

Permissions

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

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

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

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

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

Limitations

Логический идентификатор не может быть пустым GUID (00000000-0000-0000-0000-000000000000).
Логический идентификатор должен быть уникальным в рабочей области.
Операция не поддерживается, пока операция CI/CD активна в рабочей области.

Идентификаторы, поддерживаемые Microsoft Entra

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

Identity	Поддержка
User	Да
Представитель службы и управляемые удостоверения	Да

Interface

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

Параметры URI

Имя.	В	Обязательно	Тип	Описание
itemId	path	True	string (uuid)	Идентификатор элемента.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

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

Имя.	Обязательно	Тип	Описание
logicalId	True	string (uuid)	Логический идентификатор для обновления элемента.

Ответы

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

200 OK

Имя.	Тип	Описание
200 OK	LogicalIdResponse	Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенный элемент не найден. ActiveCiCdOperationInProgress— операция CI/CD активна в рабочей области.

LogicalIdResponse

Запрос успешно завершен.

429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

ItemNotFound — запрошенный элемент не найден.
ActiveCiCdOperationInProgress— операция CI/CD активна в рабочей области.

Примеры

Update logical ID example

Образец запроса

HTTP

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

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Пример ответа

Код состояния:: 200

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Определения

Имя.	Описание
ErrorParameter	Структурированный параметр, предоставляющий дополнительный контекст, доступный для чтения компьютера, об ошибке.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
LogicalIdResponse	Ответ логического идентификатора.
UpdateLogicalIdRequest	Обновите полезные данные запроса логического идентификатора.

ErrorParameter

Объект

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

Имя.	Тип	Описание
message	string	Читаемое человеком описание значения параметра.
name	string	Идентификатор параметра.
value	string	Значение параметра.

ErrorRelatedResource

Объект

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

Имя.	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

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

Имя.	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable	boolean	Если задано значение true, запрос можно получить. `Retry-After` Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
parameters	ErrorParameter[]	Структурированные параметры, предоставляющие дополнительный контекст, доступный для чтения компьютера, об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

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

Имя.	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
parameters	ErrorParameter[]	Структурированные параметры, предоставляющие дополнительный контекст, доступный для чтения компьютера, об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

LogicalIdResponse

Объект

Ответ логического идентификатора.

Имя.	Тип	Описание
logicalId	string (uuid)	Логический идентификатор элемента.

UpdateLogicalIdRequest

Объект

Обновите полезные данные запроса логического идентификатора.

Имя.	Тип	Описание
logicalId	string (uuid)	Логический идентификатор для обновления элемента.