Items - Create Notebook

Referencia

Servicio:: Notebook

Versión de la API:: v1

Crea un cuaderno en el área de trabajo especificada.
Esta API admite operaciones de larga duración (LRO).

Para crear cuadernos con definición, consulte artículo definición del cuaderno.

Permisos

El autor de la llamada debe tener rol de colaborador o superior.

Ámbitos delegados necesarios

Notebook.ReadWrite.All o Item.ReadWrite.All

Limitaciones

Para crear un cuaderno, el área de trabajo debe estar en una capacidad de Fabric compatible. Para obtener más información, consulte: tipos de licencia de Microsoft Fabric.

Identidades admitidas de Microsoft Entra

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

Identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string uuid	Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
displayName	True	string	Nombre para mostrar del cuaderno. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.
definition		NotebookDefinition	Definición pública del cuaderno.
description		string	Descripción del cuaderno. La longitud máxima es de 256 caracteres.

Respuestas

Nombre	Tipo	Description
201 Created	Notebook	Creado correctamente
202 Accepted		Solicitud aceptada, aprovisionamiento de cuadernos en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidItemType: el tipo de elemento no es válido ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento. CorruptedPayload: la carga proporcionada está dañada.

Nombre

Tipo

Description

201 Created

Notebook

Creado correctamente

202 Accepted

Solicitud aceptada, aprovisionamiento de cuadernos en curso.

Encabezados

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

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidItemType: el tipo de elemento no es válido
ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento.
CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks

{
  "displayName": "Notebook 1",
  "description": "A notebook description."
}

Respuesta de muestra

status code:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a notebook with public definition example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Respuesta de muestra

status code:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definiciones

Nombre	Description
CreateNotebookRequest	Cree una carga de solicitud de cuaderno.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
Notebook	Un objeto notebook.
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.

CreateNotebookRequest

Object

Cree una carga de solicitud de cuaderno.

Nombre	Tipo	Description
definition	NotebookDefinition	Definición pública del cuaderno.
description	string	Descripción del cuaderno. La longitud máxima es de 256 caracteres.
displayName	string	Nombre para mostrar del cuaderno. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

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.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
Dashboard	Panel de PowerBI.
DataPipeline	Una canalización de datos.
Datamart	Datamart de PowerBI.
Environment	Un entorno.
Eventhouse	Un centro de eventos.
Eventstream	Una secuencia de eventos.
GraphQLApi	Una API para el elemento GraphQL.
KQLDashboard	Un panel de KQL.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
Lakehouse	Una casa de lago.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
MirroredDatabase	Una base de datos reflejada.
MirroredWarehouse	Un almacén reflejado.
MountedDataFactory	A MountedDataFactory.
Notebook	Un cuaderno.
PaginatedReport	Informe paginado de PowerBI.
Reflex	Un reflejo.
Report	Informe de PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Un punto de conexión de SQL.
SemanticModel	Modelo semántico de PowerBI.
SparkJobDefinition	Una definición de trabajo de Spark.
Warehouse	Un almacén.

Notebook

Object

Un objeto notebook.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
id	string uuid	Identificador del elemento.
type	ItemType	Tipo de elemento.
workspaceId	string uuid	Identificador del área de trabajo.

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`.
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.
payload	string	Carga útil del elemento del cuaderno.
payloadType	PayloadType	Tipo de carga.

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.

Compartir a través de

Items - Create Notebook

Permisos

Ámbitos delegados necesarios

Limitaciones

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create a notebook example

Solicitud de ejemplo

Respuesta de muestra

Create a notebook with public definition example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Recursos adicionales