Items - Create Notebook

Reference

Tjeneste:: Notebook

API-version:: v1

Opretter en notesbog i det angivne arbejdsområde.
Denne API understøtter LRO-handlinger (Long Running Operations).

Hvis du vil oprette en notesbog med definition, skal du se artiklen Definition af notesbog.

Tilladelser

Den, der ringer op, skal have bidragyder eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Notebook.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Hvis du vil oprette en notesbog, skal arbejdsområdet være på en understøttet Fabric-kapacitet. Du kan få flere oplysninger under: Microsoft Fabric-licenstyper.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string uuid	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
displayName	True	string	Det viste navn på notesbogen. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.
definition		NotebookDefinition	Den offentlige definition af notesbogen.
description		string	Notesbogbeskrivelsen. Maksimumlængden er 256 tegn.

Svar

Name	Type	Beskrivelse
201 Created	Notebook	Oprettet
202 Accepted		Anmodning accepteret, klargøring af notesbog er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidItemType – Elementtypen er ugyldig ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede. CorruptedPayload – Den angivne nyttedata er beskadiget.

Name

Type

Beskrivelse

201 Created

Notebook

Oprettet

202 Accepted

Anmodning accepteret, klargøring af notesbog er i gang.

Headere

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

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

InvalidItemType – Elementtypen er ugyldig
ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede.
CorruptedPayload – Den angivne nyttedata er beskadiget.

Eksempler

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Eksempelanmodning

HTTP

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

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

Eksempelsvar

Statuskode:: 201

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

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

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 201

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

Statuskode:: 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	Beskrivelse
CreateNotebookRequest	Opret nyttedata for notesboganmodning.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
Notebook	Et notesbogobjekt.
NotebookDefinition	Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om, hvordan du opretter en offentlig definition af en notesbog.
NotebookDefinitionPart	Objekt for notesbogdefinitionsdel.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

CreateNotebookRequest

Object

Opret nyttedata for notesboganmodning.

Name	Type	Beskrivelse
definition	NotebookDefinition	Den offentlige definition af notesbogen.
description	string	Notesbogbeskrivelsen. Maksimumlængden er 256 tegn.
displayName	string	Det viste navn på notesbogen. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	Et miljø.
Eventhouse	Et eventhouse.
Eventstream	En hændelsesstream.
GraphQLApi	En API til GraphQL-element.
KQLDashboard	Et KQL-dashboard.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
Lakehouse	Et søhus.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
MirroredDatabase	En spejlet database.
MirroredWarehouse	Et spejlvendt lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notesbog.
PaginatedReport	Sideinddelt PowerBI-rapport.
Reflex	En refleks.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	Et SQL-slutpunkt.
SemanticModel	Semantisk PowerBI-model.
SparkJobDefinition	En spark jobdefinition.
Warehouse	Et lager.

Notebook

Object

Et notesbogobjekt.

Name	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
id	string uuid	Element-id'et.
type	ItemType	Elementtypen.
workspaceId	string uuid	Arbejdsområde-id'et.

NotebookDefinition

Object

Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om, hvordan du opretter en offentlig definition af en notesbog.

Name	Type	Beskrivelse
format	string	Formatet af notesbogdefinitionen. Understøttet format: `ipynb`.
parts	NotebookDefinitionPart[]	En liste over definitionsdele.

NotebookDefinitionPart

Object

Objekt for notesbogdefinitionsdel.

Name	Type	Beskrivelse
path	string	Stien til notesbogdelen.
payload	string	Nyttedata for notesbogdelen.
payloadType	PayloadType	Nyttedatatypen.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

Del via

Items - Create Notebook

Tilladelser

Påkrævede delegerede områder

Begrænsninger

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Brødtekst for anmodning

Svar

Eksempler

Create a notebook example

Eksempelanmodning

Eksempelsvar

Create a notebook with public definition example

Eksempelanmodning

Eksempelsvar

Definitioner

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Yderligere ressourcer