Freigeben über

Items - Create Notebook

  • Referenz
Dienst:
Notebook
API-Version:
v1

Erstellt ein Notizbuch im angegebenen Arbeitsbereich.
Diese API unterstützt LRO-.

Informationen zum Erstellen eines Notizbuchs mit Definition finden Sie in Notizbuchdefinition Artikel.

Erlaubnisse

Der Anrufer muss Mitwirkender oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Notebook.ReadWrite.All oder Item.ReadWrite.All

Begrenzungen

  • Zum Erstellen eines Notizbuchs muss sich der Arbeitsbereich auf einer unterstützten Fabric-Kapazität befinden. Weitere Informationen finden Sie unter: Microsoft Fabric-Lizenztypen.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützen
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string

uuid

Die Arbeitsbereichs-ID.

Anforderungstext

Name Erforderlich Typ Beschreibung
displayName True

string

Der Anzeigename des Notizbuchs. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
definition

NotebookDefinition

Die öffentliche Notizbuchdefinition.
description

string

Die Notizbuchbeschreibung. Die maximale Länge beträgt 256 Zeichen.

Antworten

Name Typ Beschreibung
201 Created

Notebook

Erfolgreich erstellt
202 Accepted

Anforderung akzeptiert, Notizbuchbereitstellung wird ausgeführt.

Header

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • InvalidItemType – Elementtyp ist ungültig.

  • ItemDisplayNameAlreadyInUse - Der Anzeigename des Elements wird bereits verwendet.

  • CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Create a notebook example
Create a notebook with public definition example

Create a notebook example

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Statuscode:
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

Definitionen

Name Beschreibung
CreateNotebookRequest

Erstellen Sie die Nutzlast der Notizbuchanforderung.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
ItemType

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
Notebook

Ein Notizbuchobjekt.
NotebookDefinition

Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen Notizbuchdefinition finden Sie in diesem Artikel.
NotebookDefinitionPart

Notizbuchdefinitionsteilobjekt.
PayloadType

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

CreateNotebookRequest

Objekt

Erstellen Sie die Nutzlast der Notizbuchanforderung.

Name Typ Beschreibung
definition

NotebookDefinition

Die öffentliche Notizbuchdefinition.
description

string

Die Notizbuchbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName

string

Der Anzeigename des Notizbuchs. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Dashboard

PowerBI-Dashboard.
DataPipeline

Eine Datenpipeline.
Datamart

PowerBI datamart.
Environment

Eine Umgebung.
Eventhouse

Ein Eventhouse.
Eventstream

Ein Ereignisstream.
GraphQLApi

Eine API für GraphQL-Element.
KQLDashboard

Ein KQL-Dashboard.
KQLDatabase

Eine KQL-Datenbank.
KQLQueryset

Ein KQL-Abfrageset.
Lakehouse

Ein Seehaus.
MLExperiment

Ein Machine Learning-Experiment.
MLModel

Ein Machine Learning-Modell.
MirroredDatabase

Eine gespiegelte Datenbank.
MirroredWarehouse

Ein gespiegeltes Lager.
MountedDataFactory

Eine MountedDataFactory.
Notebook

Ein Notizbuch.
PaginatedReport

PowerBI-Paginated-Bericht.
Reflex

Ein Reflex.
Report

PowerBI-Bericht.
SQLDatabase

Eine SQLDatabase.
SQLEndpoint

Ein SQL-Endpunkt.
SemanticModel

PowerBI-Semantikmodell.
SparkJobDefinition

Eine Sparkauftragsdefinition.
Warehouse

Ein Lagerhaus.

Notebook

Objekt

Ein Notizbuchobjekt.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.
displayName

string

Der Anzeigename des Elements.
id

string

uuid

Die Element-ID.
type

ItemType

Der Elementtyp.
workspaceId

string

uuid

Die Arbeitsbereichs-ID.

NotebookDefinition

Objekt

Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen Notizbuchdefinition finden Sie in diesem Artikel.

Name Typ Beschreibung
format

string

Das Format der Notizbuchdefinition. Unterstütztes Format: ipynb.
parts

NotebookDefinitionPart[]

Eine Liste der Definitionsteile.

NotebookDefinitionPart

Objekt

Notizbuchdefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Notizbuchteilpfad.
payload

string

Die Nutzlast des Notizbuchteils.
payloadType

PayloadType

Der Nutzlasttyp.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
InlineBase64

Inlinebasis 64.