Items - Create Notebook

Référence

Service:: Notebook

Version d'API:: v1

Crée un bloc-notes dans l’espace de travail spécifié.
Cette API prend en charge opérations longues (LRO).

Pour créer un bloc-notes avec définition, reportez-vous à 'article définition de notebook.

Autorisations

L’appelant doit avoir rôle de contributeur ou supérieur.

Étendues déléguées requises

Notebook.ReadWrite.All ou Item.ReadWrite.All

Limitations

Pour créer un notebook, l’espace de travail doit se trouver sur une capacité Fabric prise en charge. Pour plus d’informations, consultez : types de licences Microsoft Fabric.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
principal de service et identités managées	Oui

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string uuid	ID de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
displayName	True	string	Nom complet du bloc-notes. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.
definition		NotebookDefinition	Définition publique du bloc-notes.
description		string	Description du bloc-notes. La longueur maximale est de 256 caractères.

Réponses

Nom	Type	Description
201 Created	Notebook	Création réussie
202 Accepted		Demande acceptée, provisionnement de notebooks en cours. En-têtes Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidItemType - Le type d’élément n’est pas valide ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé. CorruptedPayload : la charge utile fournie est endommagée.

Nom

Type

Description

201 Created

Notebook

Création réussie

202 Accepted

Demande acceptée, provisionnement de notebooks en cours.

En-têtes

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

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidItemType - Le type d’élément n’est pas valide
ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé.
CorruptedPayload : la charge utile fournie est endommagée.

Exemples

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 201

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

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 201

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

Code d’état:: 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

Définitions

Nom	Description
CreateNotebookRequest	Créez une charge utile de demande de bloc-notes.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
Notebook	Objet notebook.
NotebookDefinition	Objet de définition publique de notebook. Pour plus d’informations sur la création d’une définition publique de notebook, consultez cet article .
NotebookDefinitionPart	Objet de partie de définition de bloc-notes.
PayloadType	Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

CreateNotebookRequest

Object

Créez une charge utile de demande de bloc-notes.

Nom	Type	Description
definition	NotebookDefinition	Définition publique du bloc-notes.
description	string	Description du bloc-notes. La longueur maximale est de 256 caractères.
displayName	string	Nom complet du bloc-notes. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Dashboard	Tableau de bord PowerBI.
DataPipeline	Un pipeline de données.
Datamart	Datamart PowerBI.
Environment	Environnement.
Eventhouse	Un eventhouse.
Eventstream	Flux d’événements.
GraphQLApi	API pour l’élément GraphQL.
KQLDashboard	Tableau de bord KQL.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
Lakehouse	Un lac.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
MirroredDatabase	Une base de données mise en miroir.
MirroredWarehouse	Un entrepôt mis en miroir.
MountedDataFactory	Un MountedDataFactory.
Notebook	Un bloc-notes.
PaginatedReport	Rapport paginé PowerBI.
Reflex	Un réflexe.
Report	Rapport PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Point de terminaison SQL.
SemanticModel	Modèle sémantique PowerBI.
SparkJobDefinition	Définition d’un travail Spark.
Warehouse	Un entrepôt.

Notebook

Object

Objet notebook.

Nom	Type	Description
description	string	Description de l’élément.
displayName	string	Nom complet de l’élément.
id	string uuid	ID d’élément.
type	ItemType	Type d’élément.
workspaceId	string uuid	ID de l’espace de travail.

NotebookDefinition

Object

Objet de définition publique de notebook. Pour plus d’informations sur la création d’une définition publique de notebook, consultez cet article .

Nom	Type	Description
format	string	Format de la définition du bloc-notes. Format pris en charge : `ipynb`.
parts	NotebookDefinitionPart[]	Liste des parties de définition.

NotebookDefinitionPart

Object

Objet de partie de définition de bloc-notes.

Nom	Type	Description
path	string	Chemin du composant Bloc-notes.
payload	string	Charge utile du composant Notebook.
payloadType	PayloadType	Type de charge utile.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
InlineBase64	Base 64 inline.

Partager via

Items - Create Notebook

Autorisations

Étendues déléguées requises

Limitations

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Corps de la demande

Réponses

Exemples

Create a notebook example

Exemple de requête

Exemple de réponse

Create a notebook with public definition example

Exemple de requête

Exemple de réponse

Définitions

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Ressources supplémentaires