Items - Update Notebook Definition

Servicio:: Notebook

Versión de la API:: v1

Invalida la definición del cuaderno especificado.
Esta API admite operaciones de larga duración (LRO).

La actualización de la definición del cuaderno no afecta a su etiqueta de confidencialidad.

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para el cuaderno.

Ámbitos delegados necesarios

Notebook.ReadWrite.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
notebookId	path	True	string (uuid)	Identificador del cuaderno.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
updateMetadata	query		boolean	Cuando se establece en true y el archivo .platform se proporciona como parte de la definición, los metadatos del elemento se actualizan mediante los metadatos del archivo .platform.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
definition	True	NotebookDefinition	Objeto de definición pública del cuaderno. Consulte este artículo de para obtener más información sobre cómo crear una definición pública de cuadernos.

Respuestas

Nombre	Tipo	Description
200 OK		Solicitud completada correctamente.
202 Accepted		Solicitud aceptada. La definición de actualización está en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: OperationNotSupportedForItem: no se admite la operación para el elemento solicitado. CorruptedPayload: la carga proporcionada está dañada.

Nombre

Tipo

Description

200 OK

Solicitud completada correctamente.

202 Accepted

Solicitud aceptada. La definición de actualización está en curso.

Encabezados

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

OperationNotSupportedForItem: no se admite la operación para el elemento solicitado.
CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Update a notebook definition in fabricGitSource format example

Update a notebook definition in ipynb format example

Update a notebook definition in fabricGitSource format example

Solicitud de ejemplo

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"
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

status code:: 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

Solicitud de ejemplo

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"
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

status code:: 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

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
NotebookDefinition	Objeto de definición pública del cuaderno. Consulte este artículo de para obtener más información sobre cómo crear una definición pública de cuadernos.
NotebookDefinitionPart	Objeto de parte de definición del cuaderno.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
UpdateNotebookDefinitionRequest	Actualice la carga de la solicitud de definición pública del cuaderno.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

NotebookDefinition

Object

Objeto de definición pública del cuaderno. Consulte este artículo de para obtener más información sobre cómo crear una definición pública de cuadernos.

Nombre	Tipo	Description
format	string	Formato de la definición del cuaderno. Formato admitido: `ipynb` y `fabricGitSource`. Si no se proporciona ningún formato, `fabricGitSource` se usa.
parts	NotebookDefinitionPart[]	Lista de elementos de definición.

NotebookDefinitionPart

Object

Objeto de parte de definición del cuaderno.

Nombre	Tipo	Description
path	string	Ruta de acceso del elemento del cuaderno. Extensiones de contenido de bloc de notas admitidas: `.ipynb` para `ipynb` formato; `.py`, `.scala`, `.r`, `.sql` para `fabricGitSource` formato.
payload	string	Carga útil del elemento del cuaderno.
payloadType	PayloadType	Tipo de carga útil.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.

UpdateNotebookDefinitionRequest

Object

Actualice la carga de la solicitud de definición pública del cuaderno.

Nombre	Tipo	Description
definition	NotebookDefinition	Objeto de definición pública del cuaderno. Consulte este artículo de para obtener más información sobre cómo crear una definición pública de cuadernos.

Compartir a través de

Items - Update Notebook Definition

Permisos

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Update a notebook definition in fabricGitSource format example

Solicitud de ejemplo

Respuesta de muestra

Update a notebook definition in ipynb format example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NotebookDefinition

NotebookDefinitionPart

PayloadType

UpdateNotebookDefinitionRequest