Items - Create Notebook

Referens

Tjänst:: Notebook

API-version:: v1

Skapar en notebook-fil på den angivna arbetsytan.
Det här API:et stöder tidskrävande åtgärder (LRO).

Information om hur du skapar notebook-filer med definition finns i artikeln Notebook-definition.

Behörigheter

Anroparen måste ha deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Notebook.ReadWrite.All eller Item.ReadWrite.All

Begränsningar

Om du vill skapa en notebook-fil måste arbetsytan ha en infrastrukturkapacitet som stöds. Mer information finns i: Microsoft Fabric-licenstyper.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string uuid	Arbetsytans ID.

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string	Anteckningsbokens visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.
definition		NotebookDefinition	Den offentliga definitionen för notebook-filen.
description		string	Beskrivningen av anteckningsboken. Maximal längd är 256 tecken.

Svar

Name	Typ	Description
201 Created	Notebook	Har skapats
202 Accepted		Begäran accepterad, notebook-etablering pågår. Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Objekttypen är ogiltig ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan. CorruptedPayload – den angivna nyttolasten är skadad.

Name

Typ

Description

201 Created

Notebook

Har skapats

202 Accepted

Begäran accepterad, notebook-etablering pågår.

Sidhuvuden

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

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Objekttypen är ogiltig
ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan.
CorruptedPayload – den angivna nyttolasten är skadad.

Exempel

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:: 201

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

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 201

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

Statuskod:: 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

Definitioner

Name	Description
CreateNotebookRequest	Skapa nyttolasten för notebook-begäran.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
Notebook	Ett notebook-objekt.
NotebookDefinition	Offentligt definitionsobjekt för notebook-fil. Mer information om hur du skapar en offentlig definition för notebook-filer finns i den här artikeln.
NotebookDefinitionPart	Objekt för notebook-definitionsdel.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

CreateNotebookRequest

Objekt

Skapa nyttolasten för notebook-begäran.

Name	Typ	Description
definition	NotebookDefinition	Den offentliga definitionen för notebook-filen.
description	string	Beskrivningen av anteckningsboken. Maximal längd är 256 tecken.
displayName	string	Anteckningsbokens visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	En miljö.
Eventhouse	Ett eventhouse.
Eventstream	En händelseström.
GraphQLApi	Ett API för GraphQL-objekt.
KQLDashboard	En KQL-instrumentpanel.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
Lakehouse	Ett sjöhus.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
MirroredDatabase	En speglad databas.
MirroredWarehouse	Ett speglat lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notebook-fil.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Reflex	En reflex.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	En SQL-slutpunkt.
SemanticModel	PowerBI-semantisk modell.
SparkJobDefinition	En definition för Spark-jobb.
Warehouse	Ett lager.

Notebook

Objekt

Ett notebook-objekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
id	string uuid	Objekt-ID:t.
type	ItemType	Objekttypen.
workspaceId	string uuid	Arbetsytans ID.

NotebookDefinition

Objekt

Offentligt definitionsobjekt för notebook-fil. Mer information om hur du skapar en offentlig definition för notebook-filer finns i den här artikeln.

Name	Typ	Description
format	string	Formatet för notebook-definitionen. Format som stöds: `ipynb`.
parts	NotebookDefinitionPart[]	En lista över definitionsdelar.

NotebookDefinitionPart

Objekt

Objekt för notebook-definitionsdel.

Name	Typ	Description
path	string	Anteckningsbokens delsökväg.
payload	string	Nyttolasten för notebook-delen.
payloadType	PayloadType	Nyttolasttypen.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Description
InlineBase64	Infogad bas 64.

Dela via

Items - Create Notebook

Behörigheter

Obligatoriska delegerade omfång

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Begärandetext

Svar

Exempel

Create a notebook example

Exempelbegäran

Exempelsvar

Create a notebook with public definition example

Exempelbegäran

Exempelsvar

Definitioner

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Ytterligare resurser