Items - Update Notebook Definition

Служба:: Notebook

Версия API:: v1

Переопределяет определение указанной записной книжки.
Этот API поддерживает длительные операции (LRO).

Обновление определения записной книжки не влияет на метку конфиденциальности.

Разрешения

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

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

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

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

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

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

Интерфейс

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

С использованием необязательных параметров:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/updateDefinition?updateMetadata={updateMetadata}

Параметры URI

Имя	В	Обязательно	Тип	Описание
notebookId	path	True	string (uuid)	Идентификатор записной книжки.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
updateMetadata	query		boolean	Если задано значение true и файл платформы предоставляется в рамках определения, метаданные элемента обновляются с помощью метаданных в файле платформы.

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

Имя	Обязательно	Тип	Описание
definition	True	NotebookDefinition	Объект общедоступного определения записной книжки. Дополнительные сведения о структуре определения записной книжки см. в этой статье .

Ответы

Имя	Тип	Описание
200 OK		Запрос успешно завершен.
202 Accepted		Запрос принят. Определение обновления выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента. Поврежденный Payload — предоставленные полезные данные повреждены.

Примеры

Update a notebook definition in fabricGitSource format example

Update a notebook definition in ipynb format example

Update a notebook definition in fabricGitSource format example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

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

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

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Update a notebook definition in ipynb format example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

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

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

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Определения

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

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

NotebookDefinition

Объект

Объект общедоступного определения записной книжки. Дополнительные сведения о структуре определения записной книжки см. в этой статье .

Имя	Тип	Описание
format	string	Формат определения записной книжки. Поддерживаемый формат: `ipynb` и `fabricGitSource`. Если формат не указан, `fabricGitSource` используется.
parts	NotebookDefinitionPart[]	Список частей определения.

NotebookDefinitionPart

Объект

Объект части определения записной книжки.

Имя	Тип	Описание
path	string	Путь к части записной книжки. Поддерживаемые расширения содержимого записной книжки: `.ipynb` для `ipynb` формата; `.py`, `.scala`, `.r.sql` для `fabricGitSource` формата.
payload	string	Полезные данные части записной книжки.
payloadType	PayloadType	Тип полезных данных.

PayloadType

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

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

Значение	Описание
InlineBase64	Встроенная база 64.

UpdateNotebookDefinitionRequest

Объект

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

Имя	Тип	Описание
definition	NotebookDefinition	Объект общедоступного определения записной книжки. Дополнительные сведения о структуре определения записной книжки см. в этой статье .

Поделиться через

Items - Update Notebook Definition

Разрешения

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

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

Интерфейс

Параметры URI

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

Ответы

Примеры

Update a notebook definition in fabricGitSource format example

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

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

Update a notebook definition in ipynb format example

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

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

Определения

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NotebookDefinition

NotebookDefinitionPart

PayloadType

UpdateNotebookDefinitionRequest