Compartir a través de

Items - Get Notebook Definition

Servicio:
Notebook
Versión de la API:
v1

Devuelve la definición pública del cuaderno especificada.
Esta API admite operaciones de larga duración (LRO).

Cuando se obtiene la definición pública de un cuaderno, la etiqueta de confidencialidad no forma parte de la definición.

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

Limitaciones

Esta API está bloqueada para un cuaderno con una etiqueta de confidencialidad cifrada.

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}/getDefinition
Con parámetros opcionales: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

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.
format
 query

string

Formato de la definición pública del cuaderno. Formato admitido: ipynb y fabricGitSource. Si no se proporciona ningún formato, fabricGitSource se usa.

Respuestas

Nombre Tipo Description
200 OK

NotebookDefinitionResponse

Solicitud completada correctamente.
202 Accepted

Solicitud aceptada. La recuperación de la definició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.

Ejemplos

Get a notebook definition in fabricGitSource format example
Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
status code:
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

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.
NotebookDefinitionResponse

Respuesta de definición pública 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.

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.

NotebookDefinitionResponse

Object

Respuesta 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.

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.