Items - Update Notebook
Обновляет свойства указанной записной книжки.
Разрешения
Вызывающий объект должен иметь участника или более поздней роли рабочей области.
Обязательные делегированные области
Notebook.ReadWrite.All или Item.ReadWrite.All
Поддерживаемые удостоверения Microsoft Entra
Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.
Тождество | Поддержка |
---|---|
Пользователь | Да |
субъекта-службы и управляемых удостоверений | Да |
Интерфейс
PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
notebook
|
path | True |
string uuid |
Идентификатор записной книжки. |
workspace
|
path | True |
string uuid |
Идентификатор рабочей области. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
description |
string |
Описание записной книжки. Максимальная длина — 256 символов. |
displayName |
string |
Отображаемое имя записной книжки. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос успешно завершен. |
|
Other Status Codes |
Распространенные коды ошибок:
|
Примеры
Update a notebook example
Образец запроса
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."
}
Пример ответа
{
"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"
}
Определения
Имя | Описание |
---|---|
Error |
Объект сведений об ошибках, связанных с ресурсом. |
Error |
Ответ на ошибку. |
Error |
Сведения об ответе на ошибку. |
Item |
Тип элемента. С течением времени могут добавляться дополнительные типы элементов. |
Notebook |
Объект записной книжки. |
Update |
Обновление запроса записной книжки. |
ErrorRelatedResource
Объект сведений об ошибках, связанных с ресурсом.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса, участвующий в ошибке. |
resourceType |
string |
Тип ресурса, который участвует в ошибке. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
moreDetails |
Список дополнительных сведений об ошибке. |
|
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
|
requestId |
string |
Идентификатор запроса, связанного с ошибкой. |
ErrorResponseDetails
Сведения об ответе на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
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
Объект записной книжки.
Имя | Тип | Описание |
---|---|---|
description |
string |
Описание элемента. |
displayName |
string |
Отображаемое имя элемента. |
id |
string uuid |
Идентификатор элемента. |
type |
Тип элемента. |
|
workspaceId |
string uuid |
Идентификатор рабочей области. |
UpdateNotebookRequest
Обновление запроса записной книжки.
Имя | Тип | Описание |
---|---|---|
description |
string |
Описание записной книжки. Максимальная длина — 256 символов. |
displayName |
string |
Отображаемое имя записной книжки. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента. |