Items - Create Notebook

Riferimento

Servizio:: Notebook

Versione API:: v1

Crea un notebook nell'area di lavoro specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Per creare un notebook con definizione, vedere articolo definizione del notebook.

Autorizzazioni

Il chiamante deve avere ruolo collaboratore o superiore dell'area di lavoro.

Ambiti delegati obbligatori

Notebook.ReadWrite.All o Item.ReadWrite.All

Limitazioni

Per creare un notebook, l'area di lavoro deve trovarsi in una capacità di Infrastruttura supportata. Per altre informazioni, vedere: tipi di licenza di Microsoft Fabric.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Appoggiare
Utente	Sì
'entità servizio e identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string uuid	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string	Nome visualizzato del notebook. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.
definition		NotebookDefinition	Definizione pubblica del notebook.
description		string	Descrizione del notebook. La lunghezza massima è di 256 caratteri.

Risposte

Nome	Tipo	Descrizione
201 Created	Notebook	Creazione completata
202 Accepted		Richiesta accettata, provisioning notebook in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: InvalidItemType - Tipo di elemento non valido ItemDisplayNameAlreadyInUse: il nome visualizzato dell'elemento è già usato. CorruptedPayload: il payload fornito è danneggiato.

Nome

Tipo

Descrizione

201 Created

Notebook

Creazione completata

202 Accepted

Richiesta accettata, provisioning notebook in corso.

Intestazioni

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

Other Status Codes

ErrorResponse

Codici di errore comuni:

InvalidItemType - Tipo di elemento non valido
ItemDisplayNameAlreadyInUse: il nome visualizzato dell'elemento è già usato.
CorruptedPayload: il payload fornito è danneggiato.

Esempio

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 201

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

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 201

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

Codice di stato:: 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

Definizioni

Nome	Descrizione
CreateNotebookRequest	Creare il payload della richiesta del notebook.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
ItemType	Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
Notebook	Oggetto notebook.
NotebookDefinition	Oggetto definizione pubblica del notebook. Per altre informazioni su come creare una definizione pubblica di notebook , vedere questo articolo.
NotebookDefinitionPart	Oggetto parte della definizione del notebook.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

CreateNotebookRequest

Object

Creare il payload della richiesta del notebook.

Nome	Tipo	Descrizione
definition	NotebookDefinition	Definizione pubblica del notebook.
description	string	Descrizione del notebook. La lunghezza massima è di 256 caratteri.
displayName	string	Nome visualizzato del notebook. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

ItemType

Enumeration

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore	Descrizione
Dashboard	Dashboard di Power BI.
DataPipeline	Una pipeline di dati.
Datamart	Datamart di PowerBI.
Environment	Un ambiente.
Eventhouse	Una casa eventi.
Eventstream	Flusso di eventi.
GraphQLApi	API per l'elemento GraphQL.
KQLDashboard	Dashboard KQL.
KQLDatabase	Un database KQL.
KQLQueryset	Set di query KQL.
Lakehouse	Una lakehouse.
MLExperiment	Esperimento di Machine Learning.
MLModel	Modello di Machine Learning.
MirroredDatabase	Database con mirroring.
MirroredWarehouse	Magazzino con mirroring.
MountedDataFactory	Oggetto MountedDataFactory.
Notebook	Un notebook.
PaginatedReport	Report impaginato di Power BI.
Reflex	Un riflesso.
Report	Report di Power BI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Endpoint SQL.
SemanticModel	Modello semantico di PowerBI.
SparkJobDefinition	Definizione di processo Spark.
Warehouse	Un magazzino.

Notebook

Object

Oggetto notebook.

Nome	Tipo	Descrizione
description	string	Descrizione dell'elemento.
displayName	string	Nome visualizzato dell'elemento.
id	string uuid	ID elemento.
type	ItemType	Tipo di elemento.
workspaceId	string uuid	ID dell'area di lavoro.

NotebookDefinition

Object

Oggetto definizione pubblica del notebook. Per altre informazioni su come creare una definizione pubblica di notebook , vedere questo articolo.

Nome	Tipo	Descrizione
format	string	Formato della definizione del notebook. Formato supportato: `ipynb`.
parts	NotebookDefinitionPart[]	Elenco di parti di definizione.

NotebookDefinitionPart

Object

Oggetto parte della definizione del notebook.

Nome	Tipo	Descrizione
path	string	Percorso della parte del notebook.
payload	string	Payload della parte del notebook.
payloadType	PayloadType	Tipo di payload.

PayloadType

Enumeration

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

Condividi tramite

Items - Create Notebook

Autorizzazioni

Ambiti delegati obbligatori

Limitazioni

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Create a notebook example

Esempio di richiesta

Risposta di esempio

Create a notebook with public definition example

Esempio di richiesta

Risposta di esempio

Definizioni

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Risorse aggiuntive