Items - Create Notebook

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 un rol de área de trabajo colaborador .

Á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.
folderId		string (uuid)	Identificador de carpeta. Si no se especifica o null, el cuaderno se crea con el área de trabajo como carpeta.

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. WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

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.
WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

Ejemplos

Create a notebook example

Create a notebook with public definition in fabricGitSource format example

Create a notebook with public definition in ipynb format 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 in fabricGitSource format 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": "fabricGitSource",
    "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

Create a notebook with public definition in ipynb format 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.ipynb",
        "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.
ItemTag	Representa una etiqueta aplicada en un elemento.
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

Objeto

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.
folderId	string (uuid)	Identificador de carpeta. Si no se especifica o null, el cuaderno se crea con el área de trabajo como carpeta.

ErrorRelatedResource

Objeto

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

Objeto

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

Objeto

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.

ItemTag

Objeto

Representa una etiqueta aplicada en un elemento.

Nombre	Tipo	Description
displayName	string	Nombre de la etiqueta.
id	string (uuid)	Identificador de etiqueta.

ItemType

Enumeración

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

Valor	Description
Dashboard	Panel de PowerBI.
Report	Informe de PowerBI.
SemanticModel	Modelo semántico de PowerBI.
PaginatedReport	Informe paginado de PowerBI.
Datamart	Datamart de PowerBI.
Lakehouse	Una casa de lago.
Eventhouse	Un centro de eventos.
Environment	Un entorno.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
KQLDashboard	Un panel de KQL.
DataPipeline	Una canalización de datos.
Notebook	Un cuaderno.
SparkJobDefinition	Una definición de trabajo de Spark.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
Warehouse	Un almacén.
Eventstream	Una secuencia de eventos.
SQLEndpoint	Un punto de conexión de SQL.
MirroredWarehouse	Un almacén reflejado.
MirroredDatabase	Una base de datos reflejada.
Reflex	Un reflejo.
GraphQLApi	Una API para el elemento GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Un trabajo de copia.
VariableLibrary	A VariableLibrary.
Dataflow	Flujo de datos.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Una instantánea de almacenamiento.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
Map	Un mapa.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	Una función de datos de usuario.
GraphModel	Un GraphModel.
GraphQuerySet	Un conjunto de consultas de Graph.
SnowflakeDatabase	Una base de datos de Snowflake para almacenar tablas de Cosmos creadas a partir de la cuenta de Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Una base de datos de Cosmos DB.
Ontology	Una ontología.
EventSchemaSet	An EventSchemaSet.

Notebook

Objeto

Un objeto notebook.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
folderId	string (uuid)	Identificador de carpeta.
id	string (uuid)	Identificador del elemento.
tags	ItemTag[]	Lista de etiquetas aplicadas.
type	ItemType	Tipo de elemento.
workspaceId	string (uuid)	Identificador del área de trabajo.

NotebookDefinition

Objeto

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

Objeto

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.

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 in fabricGitSource format example

Solicitud de ejemplo

Respuesta de muestra

Create a notebook with public definition in ipynb format example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType