Items - Create Notebook

Service:: Notebook

API-versie:: v1

Hiermee maakt u een notebook in de opgegeven werkruimte.
Deze API ondersteunt langlopende bewerkingen (LRO).

Raadpleeg notebookdefinitie artikel voor het maken van een notitieblok met definitie.

Machtigingen

De aanroeper moet een werkruimterol inzender hebben.

Vereiste gedelegeerde bereiken

Notebook.ReadWrite.All of Item.ReadWrite.All

Beperkingen

Als u een notebook wilt maken, moet de werkruimte zich op een ondersteund Fabric capaciteit bevinden. Zie voor meer informatie: Microsoft Fabric licentietypen.

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft identities die in deze sectie worden vermeld.

Identiteit	Steunen
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

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

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-id.

Aanvraagbody

Name	Vereist	Type	Description
displayName	True	string	De weergavenaam van het notitieblok. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype.
definition		NotebookDefinition	De openbare definitie van het notitieblok.
description		string	De beschrijving van het notitieblok. De maximale lengte is 256 tekens.
folderId		string (uuid)	De map-id. Als dit niet is opgegeven of null is, wordt het notitieblok gemaakt met de werkruimte als map.
sensitivityLabelSettings		SensitivityLabelSettings	De instellingen voor vertrouwelijkheidslabels voor het notitieblok.

Antwoorden

Name	Type	Description
201 Created	Notebook	Gemaakt
202 Accepted		Aanvraag geaccepteerd, inrichting van notitieblokken wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: InvalidItemType - Itemtype is ongeldig ItemDisplayNameAlreadyInUse - Weergavenaam van item wordt al gebruikt. CorruptedPayload: de opgegeven nettolading is beschadigd. WorkspaceItemsLimitExceeded - Limiet voor werkruimte-items is overschreden.

Voorbeelden

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

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 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"
  }
}

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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"
  }
}

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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"
  }
}

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

Definities

Name	Description
CreateNotebookRequest	Maak nettolading voor notebookaanvragen.
EntireTenantPrincipal	Vertegenwoordigt een tenant-principal
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
GroupPrincipal	Vertegenwoordigt een beveiligingsgroep.
GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.
ItemTag	Vertegenwoordigt een tag die is toegepast op een item.
ItemType	Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
Notebook	Een notebookobject.
NotebookDefinition	Public Definition-object van notebook. Raadpleeg dit artikel voor meer informatie over de structuur van de notebookdefinitie.
NotebookDefinitionPart	Notitieblokdefinitieonderdeelobject.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.
PrincipalType	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
SensitivityLabel	Vertegenwoordigt een vertrouwelijkheidslabel dat is toegepast op een item.
SensitivityLabelApplyStrategy	De strategie voor het toepassen van het gevoeligheidslabel. De standaardwaarde is ApplyOrFail. Er kunnen in de loop van de tijd extra typen worden toegevoegd.
SensitivityLabelSettings	De instellingen voor vertrouwelijkheidslabels.
ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
ServicePrincipalPrincipal	Vertegenwoordigt een Microsoft Entra service-principal.
ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Vertegenwoordigt een service-principalprofiel.
UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.
UserPrincipal	Vertegenwoordigt een Microsoft Entra gebruikersprincipaal.

CreateNotebookRequest

Object

Maak nettolading voor notebookaanvragen.

Name	Type	Description
definition	NotebookDefinition	De openbare definitie van het notitieblok.
description	string	De beschrijving van het notitieblok. De maximale lengte is 256 tekens.
displayName	string	De weergavenaam van het notitieblok. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype.
folderId	string (uuid)	De map-id. Als dit niet is opgegeven of null is, wordt het notitieblok gemaakt met de werkruimte als map.
sensitivityLabelSettings	SensitivityLabelSettings	De instellingen voor vertrouwelijkheidslabels voor het notitieblok.

EntireTenantPrincipal

Object

Vertegenwoordigt een tenant-principal

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
type	string: EntireTenant	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GroupDetails

Object

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name	Type	Description
groupType	GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupPrincipal

Object

Vertegenwoordigt een beveiligingsgroep.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
groupDetails	GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
id	string (uuid)	De id van de principal.
type	string: Group	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

GroupType

Opsomming

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde	Description
Unknown	Het type Principal-groep is onbekend.
SecurityGroup	Principal is een beveiligingsgroep.
DistributionList	Principal is een distributielijst.

ItemTag

Object

Vertegenwoordigt een tag die is toegepast op een item.

Name	Type	Description
displayName	string	De naam van de tag.
id	string (uuid)	De tag-id.

ItemType

Opsomming

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde	Description
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisch Power BI-model.
PaginatedReport	Gepagineerd Power BI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Een lakehouse.
Eventhouse	Een eventhouse.
Environment	Een omgeving.
KQLDatabase	Een KQL-database.
KQLQueryset	Een KQL-queryset.
KQLDashboard	Een KQL-dashboard.
DataPipeline	Een gegevenspijplijn.
Notebook	Een notitieblok.
SparkJobDefinition	Een Spark-taakdefinitie.
MLExperiment	Een machine learning-experiment.
MLModel	Een machine learning-model.
Warehouse	Een magazijn.
Eventstream	Een eventstream.
SQLEndpoint	Een SQL-eindpunt.
MirroredWarehouse	Een gespiegeld magazijn.
MirroredDatabase	Een gespiegelde database.
Reflex	Een reflex.
GraphQLApi	Een API voor GraphQL-item.
MountedDataFactory	Een MountedDataFactory.
SQLDatabase	Een SQLDatabase.
CopyJob	Een kopieertaak.
VariableLibrary	Een VariableLibrary.
Dataflow	Een gegevensstroom.
ApacheAirflowJob	Een ApacheAirflowJob.
WarehouseSnapshot	Een momentopname van een magazijn.
DigitalTwinBuilder	Een DigitalTwinBuilder.
DigitalTwinBuilderFlow	Een Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Een gespiegelde Azure Databricks-catalogus.
Map	Een kaart.
AnomalyDetector	Een Anomaly Detector.
UserDataFunction	Een gebruikersgegevensfunctie.
GraphModel	Een GraphModel.
GraphQuerySet	Een Graph QuerySet.
SnowflakeDatabase	Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.
OperationsAgent	Een OperationsAgent.
CosmosDBDatabase	Een Cosmos DB-database.
Ontology	Een Ontologie.
EventSchemaSet	Een EventSchemaSet.
DataAgent	Een DataAgent.

Notebook

Object

Een notebookobject.

Name	Type	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	De standaardidentiteit van het item.
description	string	De beschrijving van het item.
displayName	string	De weergavenaam van het item.
folderId	string (uuid)	De map-id.
id	string (uuid)	De item-id.
sensitivityLabel	SensitivityLabel	Het vertrouwelijkheidslabel voor items.
tags	ItemTag[]	Lijst met toegepaste tags.
type	ItemType	Het itemtype.
workspaceId	string (uuid)	De werkruimte-id.

NotebookDefinition

Object

Public Definition-object van notebook. Raadpleeg dit artikel voor meer informatie over de structuur van de notebookdefinitie.

Name	Type	Description
format	string	De indeling van de notebookdefinitie. Ondersteunde indeling: `ipynb` en `fabricGitSource`. Als er geen indeling is opgegeven, `fabricGitSource` wordt deze gebruikt.
parts	NotebookDefinitionPart[]	Een lijst met definitieonderdelen.

NotebookDefinitionPart

Object

Notitieblokdefinitieonderdeelobject.

Name	Type	Description
path	string	Het pad naar het notitieblokonderdeel. Ondersteunde extensies voor notitieblokinhoud: `.ipynb` voor indeling; `ipynb`, `.py`, `.scala`, voor `.r.sqlfabricGitSource` indeling.
payload	string	De nettolading van het notebookonderdeel.
payloadType	PayloadType	Het nettoladingstype.

PayloadType

Opsomming

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.

PrincipalType

Opsomming

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde	Description
User	Principal is een Microsoft Entra user principal.
ServicePrincipal	Principal is een Microsoft Entra service-principal.
Group	Principal is een beveiligingsgroep.
ServicePrincipalProfile	Principal is een service-principalprofiel.
EntireTenant	Principal vertegenwoordigt alle tenantgebruikers.

SensitivityLabel

Object

Vertegenwoordigt een vertrouwelijkheidslabel dat is toegepast op een item.

Name	Type	Description
id	string (uuid)	De vertrouwelijkheidslabel-id.

SensitivityLabelApplyStrategy

Opsomming

De strategie voor het toepassen van het gevoeligheidslabel. De standaardwaarde is ApplyOrFail. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

Waarde	Description
ApplyOrFail	Pas het vertrouwelijkheidslabel toe of mislukt de bewerking als deze niet kan worden toegepast.
Ignore	Negeer het vertrouwelijkheidslabel als het niet kan worden toegepast en ga door met de bewerking zonder het label toe te passen.

SensitivityLabelSettings

Object

De instellingen voor vertrouwelijkheidslabels.

Name	Type	Description
labelId	string (uuid)	De vertrouwelijkheidslabel-id.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	De strategie voor het toepassen van het gevoeligheidslabel.

ServicePrincipalDetails

Object

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name	Type	Description
aadAppId	string (uuid)	De Microsoft Entra AppId van de service-principal.

ServicePrincipalPrincipal

Object

Vertegenwoordigt een Microsoft Entra service-principal.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
servicePrincipalDetails	ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
type	string: ServicePrincipal	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ServicePrincipalProfileDetails

Object

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	De bovenliggende principal van het service-principalprofiel.

ServicePrincipalProfilePrincipal

Object

Vertegenwoordigt een service-principalprofiel.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

UserDetails

Object

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name	Type	Description
userPrincipalName	string	De gebruikersprincipe-naam (UPN).

UserPrincipal

Object

Vertegenwoordigt een Microsoft Entra gebruikersprincipaal.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
type	string: User	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
userDetails	UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.