Items - Update Notebook

Служба:

Notebook

Версия API:

v1

Обновляет свойства указанной записной книжки.

Разрешения

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

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

Notebook.ReadWrite.All или Item.ReadWrite.All

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

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

Тождество	Поддержка
Пользователь	Да
субъекта-службы и управляемых удостоверений	Да

Интерфейс

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}

Параметры URI

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

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

Имя	Тип	Описание
description	string	Описание записной книжки. Максимальная длина — 256 символов.
displayName	string	Отображаемое имя записной книжки. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.

Ответы

Имя	Тип	Описание
200 OK	Notebook	Запрос успешно завершен.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенный элемент не найден. InvalidRequest — недопустимый запрос на обновление

Примеры

Update a notebook example

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

HTTP

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

{
  "displayName": "Notebook's New name",
  "description": "A new description for notebook."
}

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

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

200

{
  "displayName": "Notebook's New name",
  "description": "A new description for notebook.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Notebook	Объект записной книжки.
UpdateNotebookRequest	Обновление запроса записной книжки.

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

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

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

ErrorResponseDetails

Object

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

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

ItemType

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

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

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
DataPipeline	Конвейер данных.
Datamart	Datamart PowerBI.
Environment	Среда.
Eventhouse	Хранилище событий.
Eventstream	Поток событий.
GraphQLApi	API для элемента GraphQL.
KQLDashboard	Панель мониторинга KQL.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
Lakehouse	Озеро.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
MirroredDatabase	Зеркальная база данных.
MirroredWarehouse	Зеркальный склад.
MountedDataFactory	ПодключеннаяdataFactory.
Notebook	Записная книжка.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Reflex	Рефлекс.
Report	Отчет PowerBI.
SQLDatabase	База данных SQLDatabase.
SQLEndpoint	Конечная точка SQL.
SemanticModel	Семантическая модель PowerBI.
SparkJobDefinition	Определение задания Spark.
Warehouse	Склад.

Notebook

Object

Объект записной книжки.

Имя	Тип	Описание
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
id	string uuid	Идентификатор элемента.
type	ItemType	Тип элемента.
workspaceId	string uuid	Идентификатор рабочей области.

UpdateNotebookRequest

Object

Обновление запроса записной книжки.

Имя	Тип	Описание
description	string	Описание записной книжки. Максимальная длина — 256 символов.
displayName	string	Отображаемое имя записной книжки. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.