Items - Get Notebook Definition

Служба:: Notebook

Версия API:: v1

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

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

Разрешения

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

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

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

Ограничения

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

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

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

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

Интерфейс

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
notebookId	path	True	string (uuid)	Идентификатор записной книжки.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
format	query		string	Формат общедоступного определения записной книжки. Поддерживаемый формат: `ipynb` и `fabricGitSource`. Если формат не указан, `fabricGitSource` используется.

Ответы

Имя	Тип	Описание
200 OK	NotebookDefinitionResponse	Запрос успешно завершен.
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 — операция не поддерживается для запрошенного элемента.

Примеры

Get a notebook definition in fabricGitSource format example

Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

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

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

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

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

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get a notebook definition in ipynb format example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb

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

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

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

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

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Определения

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

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	Тип полезных данных.

NotebookDefinitionResponse

Объект

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

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

PayloadType

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

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

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

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

Items - Get Notebook Definition

Разрешения

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

Ограничения

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

Интерфейс

Параметры URI

Ответы

Примеры

Get a notebook definition in fabricGitSource format example

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

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

Get a notebook definition in ipynb format example

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

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

Определения

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NotebookDefinition

NotebookDefinitionPart

NotebookDefinitionResponse

PayloadType