Items - Create Notebook

Referanse

Tjeneste:: Notebook

API-versjon:: v1

Oppretter en notatblokk i det angitte arbeidsområdet.
Denne API-en støtter langvarige operasjoner (LRO).

Hvis du vil opprette notatblokk med definisjon, kan du se notatblokkdefinisjon artikkel.

Tillatelser

Innringeren må ha bidragsyter eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

Notebook.ReadWrite.All eller Item.ReadWrite.All

Begrensninger

Hvis du vil opprette en notatblokk, må arbeidsområdet være på en støttet Stoff-kapasitet. Hvis du vil ha mer informasjon, kan du se: Microsoft Fabric-lisenstyper.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string uuid	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
displayName	True	string	Visningsnavnet for notatblokken. Visningsnavnet må følge navnereglene i henhold til elementtype.
definition		NotebookDefinition	Den offentlige definisjonen for notatblokken.
description		string	Notatblokkbeskrivelsen. Maksimal lengde er 256 tegn.

Svar

Navn	Type	Beskrivelse
201 Created	Notebook	Opprettet
202 Accepted		Forespørsel godtatt, klargjøring av notatblokk pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: InvalidItemType – elementtypen er ugyldig ItemDisplayNameAlreadyInUse – visningsnavnet for elementet er allerede brukt. CorruptedPayload – den angitte nyttelasten er skadet.

Navn

Type

Beskrivelse

201 Created

Notebook

Opprettet

202 Accepted

Forespørsel godtatt, klargjøring av notatblokk pågår.

Overskrifter

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

Other Status Codes

ErrorResponse

Vanlige feilkoder:

InvalidItemType – elementtypen er ugyldig
ItemDisplayNameAlreadyInUse – visningsnavnet for elementet er allerede brukt.
CorruptedPayload – den angitte nyttelasten er skadet.

Eksempler

Create a notebook example

Create a notebook with public definition example

Create a notebook example

Eksempelforespørsel

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

Eksempelforespørsel

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

Definisjoner

Navn	Beskrivelse
CreateNotebookRequest	Opprett nyttelast for notatblokkforespørsel.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
Notebook	Et notatblokkobjekt.
NotebookDefinition	Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om hvordan du oppretter en offentlig definisjon for notatblokken.
NotebookDefinitionPart	Notatblokkdefinisjonsdelobjekt.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

CreateNotebookRequest

Object

Opprett nyttelast for notatblokkforespørsel.

Navn	Type	Beskrivelse
definition	NotebookDefinition	Den offentlige definisjonen for notatblokken.
description	string	Notatblokkbeskrivelsen. Maksimal lengde er 256 tegn.
displayName	string	Visningsnavnet for notatblokken. Visningsnavnet må følge navnereglene i henhold til elementtype.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
DataPipeline	Et datasamlebånd.
Datamart	PowerBI-datamart.
Environment	Et miljø.
Eventhouse	Et arrangementshus.
Eventstream	En hendelsesstrøm.
GraphQLApi	En API for GraphQL-element.
KQLDashboard	Et KQL-instrumentbord.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
Lakehouse	Et innsjøhus.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
MirroredDatabase	En speilvendt database.
MirroredWarehouse	Et speilvendt lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notatblokk.
PaginatedReport	Paginert powerbi-rapport.
Reflex	En refleks.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	Et SQL-endepunkt.
SemanticModel	Semantisk PowerBI-modell.
SparkJobDefinition	En spark-jobbdefinisjon.
Warehouse	Et lager.

Notebook

Object

Et notatblokkobjekt.

Navn	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Visningsnavnet for elementet.
id	string uuid	Element-ID-en.
type	ItemType	Elementtypen.
workspaceId	string uuid	Arbeidsområde-ID-en.

NotebookDefinition

Object

Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om hvordan du oppretter en offentlig definisjon for notatblokken.

Navn	Type	Beskrivelse
format	string	Formatet for notatblokkdefinisjonen. Støttet format: `ipynb`.
parts	NotebookDefinitionPart[]	En liste over definisjonsdeler.

NotebookDefinitionPart

Object

Notatblokkdefinisjonsdelobjekt.

Navn	Type	Beskrivelse
path	string	Notatblokkdelbanen.
payload	string	Nyttelasten for notatblokkdelen.
payloadType	PayloadType	Nyttelasttypen.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.

Del via

Items - Create Notebook

Tillatelser

Nødvendige delegerte omfang

Begrensninger

Microsoft Entra-støttede identiteter

Grensesnitt

URI-parametere

Brødtekst for forespørsel

Svar

Eksempler

Create a notebook example

Eksempelforespørsel

Eksempelsvar

Create a notebook with public definition example

Eksempelforespørsel

Eksempelsvar

Definisjoner

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

Flere ressurser