Items - Create Notebook

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 en bidragyderarbejdsområderolle.

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 identities, der er 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.
folderId		string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes notesbogen med arbejdsområdet som mappe.
sensitivityLabelSettings		SensitivityLabelSettings	Indstillinger for følsomhedsmærkat for notesbogen.

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
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere 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. WorkspaceItemsLimitExceeded – Grænsen for arbejdsområdeelement er overskredet.

Eksempler

Create a notebook example

Create a notebook with public definition in fabricGitSource format example

Create a notebook with public definition in ipynb format 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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

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 in fabricGitSource format 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": "fabricGitSource",
    "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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

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 in ipynb format 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.ipynb",
        "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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

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.
EntireTenantPrincipal	Repræsenterer en lejerprincipal
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
GroupPrincipal	Repræsenterer en sikkerhedsgruppe.
GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.
ItemTag	Repræsenterer et mærke, der er anvendt på et element.
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 strukturen i definitionen af notesbogen.
NotebookDefinitionPart	Objekt for notesbogdefinitionsdel.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
PrincipalType	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
SensitivityLabel	Repræsenterer en følsomhedsmærkat, der er anvendt på et element.
SensitivityLabelApplyStrategy	Strategien for anvendelse af følsomhedsmærkaten. Standardværdien er ApplyOrFail. Der kan tilføjes flere typer over tid.
SensitivityLabelSettings	Indstillinger for følsomhedsmærkat.
ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
ServicePrincipalPrincipal	Repræsenterer en Microsoft Entra tjenesteprincipal.
ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Repræsenterer en tjenesteprincipalprofil.
UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.
UserPrincipal	Repræsenterer en Microsoft Entra brugerprincipal.

CreateNotebookRequest

Objekt

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.
folderId	string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes notesbogen med arbejdsområdet som mappe.
sensitivityLabelSettings	SensitivityLabelSettings	Indstillinger for følsomhedsmærkat for notesbogen.

EntireTenantPrincipal

Objekt

Repræsenterer en lejerprincipal

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: EntireTenant	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

ErrorRelatedResource

Objekt

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

Objekt

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 (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

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.

GroupDetails

Objekt

Gruppér specifikke oplysninger. Gælder, når hovedtypen er Group.

Name	Type	Beskrivelse
groupType	GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.

GroupPrincipal

Objekt

Repræsenterer en sikkerhedsgruppe.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
groupDetails	GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
id	string (uuid)	Hovedprincipalens id.
type	string: Group	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

GroupType

Optælling

Gruppens type. Der kan tilføjes flere gruppetyper over tid.

Værdi	Beskrivelse
Unknown	Hovedgruppetypen er ukendt.
SecurityGroup	Principal er en sikkerhedsgruppe.
DistributionList	Principal er en distributionsliste.

ItemTag

Objekt

Repræsenterer et mærke, der er anvendt på et element.

Name	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

ItemType

Optælling

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

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	Et EventSchemaSet.
DataAgent	En DataAgent.

Notebook

Objekt

Et notesbogobjekt.

Name	Type	Beskrivelse
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Elementets standardidentitet.
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
folderId	string (uuid)	Mappe-id'et.
id	string (uuid)	Element-id'et.
sensitivityLabel	SensitivityLabel	Elementets følsomhedsmærkat.
tags	ItemTag[]	Liste over anvendte mærker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

NotebookDefinition

Objekt

Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af notesbogen.

Name	Type	Beskrivelse
format	string	Formatet af notesbogdefinitionen. Understøttet format: `ipynb` og `fabricGitSource`. Hvis der ikke er angivet et format, `fabricGitSource` bruges .
parts	NotebookDefinitionPart[]	En liste over definitionsdele.

NotebookDefinitionPart

Objekt

Objekt for notesbogdefinitionsdel.

Name	Type	Beskrivelse
path	string	Stien til notesbogdelen. Understøttede udvidelser til notesbogindhold: `.ipynb` for `ipynb` format; `.py`, `.scala`, `.r`for `.sqlfabricGitSource` format.
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.

PrincipalType

Optælling

Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

Værdi	Beskrivelse
User	Principal er en Microsoft Entra brugerprincipal.
ServicePrincipal	Principal er en Microsoft Entra tjenesteprincipal.
Group	Principal er en sikkerhedsgruppe.
ServicePrincipalProfile	Principal er en tjenesteprincipalprofil.
EntireTenant	Principal repræsenterer alle lejerbrugere.

SensitivityLabel

Objekt

Repræsenterer en følsomhedsmærkat, der er anvendt på et element.

Name	Type	Beskrivelse
id	string (uuid)	Id'et for følsomhedsmærkaten.

SensitivityLabelApplyStrategy

Optælling

Strategien for anvendelse af følsomhedsmærkaten. Standardværdien er ApplyOrFail. Der kan tilføjes flere typer over tid.

Værdi	Beskrivelse
ApplyOrFail	Anvend følsomhedsmærkaten, eller handlingen mislykkes, hvis den ikke kan anvendes.
Ignore	Ignorer følsomhedsmærkaten, hvis den ikke kan anvendes, og fortsæt med handlingen uden at anvende mærkaten.

SensitivityLabelSettings

Objekt

Indstillinger for følsomhedsmærkat.

Name	Type	Beskrivelse
labelId	string (uuid)	Id'et for følsomhedsmærkaten.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategien for anvendelse af følsomhedsmærkaten.

ServicePrincipalDetails

Objekt

Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipal.

Name	Type	Beskrivelse
aadAppId	string (uuid)	Tjenesteprincipalens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Repræsenterer en Microsoft Entra tjenesteprincipal.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalDetails	ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
type	string: ServicePrincipal	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

ServicePrincipalProfileDetails

Objekt

Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipalProfile.

Name	Type	Beskrivelse
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Profilen for tjenesteprincipalens overordnede hoved.

ServicePrincipalProfilePrincipal

Objekt

Repræsenterer en tjenesteprincipalprofil.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

UserDetails

Objekt

Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er User.

Name	Type	Beskrivelse
userPrincipalName	string	Brugerens hovednavn.

UserPrincipal

Objekt

Repræsenterer en Microsoft Entra brugerprincipal.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: User	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
userDetails	UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.

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 in fabricGitSource format example

Eksempelanmodning

Eksempelsvar

Create a notebook with public definition in ipynb format example

Eksempelanmodning

Eksempelsvar

Definitioner

CreateNotebookRequest

EntireTenantPrincipal

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemTag

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

PrincipalType

SensitivityLabel

SensitivityLabelApplyStrategy

SensitivityLabelSettings

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

UserDetails

UserPrincipal