Items - Create Notebook

Palvelu:: Notebook

Ohjelmointirajapinnan versio:: v1

Luo muistikirjan määritettyyn työtilaan.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Jos haluat luoda muistikirjan määritelmän, lue Notebook -määritelmä artikkeli.

Käyttöoikeudet

Kutsujalla on oltava osallistujan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Notebook.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Jotta muistikirja voidaan luoda, työtilan on oltava tuetussa Fabric-kapasiteetissa. Lisätietoja on artikkelissa Microsoft Fabric-käyttöoikeustyypit.

tuettujen käyttäjätietojen Microsoft Entra

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
displayName	True	string	Muistikirjan näyttönimi. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
definition		NotebookDefinition	Muistikirjan julkinen määritelmä.
description		string	Muistikirjan kuvaus. Enimmäispituus on 256 merkkiä.
folderId		string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvoinen, muistikirja luodaan siten, että työtila on sen kansio.
sensitivityLabelSettings		SensitivityLabelSettings	Muistikirjan luottamuksellisuustunnisteasetukset.

Vastaukset

Nimi	Tyyppi	Description
201 Created	Notebook	Luonti onnistui
202 Accepted		Pyyntö hyväksytty, muistikirjan valmistelu on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: InvalidItemType – Kohdetyyppi on virheellinen ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä. VioittunutPayload – Annetut tiedot ovat vioittuneet. WorkspaceItemsLimitExceeded – Työtilan kohteen raja ylitetty.

Esimerkit

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

Mallipyyntö

HTTP

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

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

Mallivastaus

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

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

Mallipyyntö

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

Mallivastaus

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

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

Mallipyyntö

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

Mallivastaus

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

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

Määritelmät

Nimi	Description
CreateNotebookRequest	Luo muistikirjapyynnön tiedot.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
Notebook	Muistikirjan objekti.
NotebookDefinition	Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta.
NotebookDefinitionPart	Muistikirjan määritelmäosan objekti.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
SensitivityLabel	Edustaa kohteelle käytettyä luottamuksellisuustunnistetta.
SensitivityLabelApplyStrategy	Tämä on luottamuksellisuustunnisteen käyttöön tarkoitettu strategia. Oletusarvo on ApplyOrFail. Muita tyyppejä voidaan lisätä ajan mittaan.
SensitivityLabelSettings	Luottamuksellisuustunnisteen asetukset.

CreateNotebookRequest

Kohde

Luo muistikirjapyynnön tiedot.

Nimi	Tyyppi	Description
definition	NotebookDefinition	Muistikirjan julkinen määritelmä.
description	string	Muistikirjan kuvaus. Enimmäispituus on 256 merkkiä.
displayName	string	Muistikirjan näyttönimi. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
folderId	string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvoinen, muistikirja luodaan siten, että työtila on sen kansio.
sensitivityLabelSettings	SensitivityLabelSettings	Muistikirjan luottamuksellisuustunnisteasetukset.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ItemTag

Kohde

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Dashboard	Power BI -koontinäyttö.
Report	PowerBI -raportti.
SemanticModel	PowerBI:n semanttinen malli.
PaginatedReport	PowerBI:n sivutettu raportti.
Datamart	PowerBI -tietomarssi.
Lakehouse	Tämä on lakehouse.
Eventhouse	Tapahtumatalo.
Environment	Ympäristö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
KQLDashboard	KQL-koontinäyttö.
DataPipeline	Tietoputki.
Notebook	Muistikirja.
SparkJobDefinition	Spark-työn määritelmä.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
Warehouse	Varasto.
Eventstream	Tapahtumavirta.
SQLEndpoint	SQL-päätepiste.
MirroredWarehouse	Peilattu varasto.
MirroredDatabase	Peilattu tietokanta.
Reflex	Refleksi.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopiotyö.
VariableLibrary	MuuttujaLibrary.
Dataflow	Tietovuo.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Varastotilannevedos.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
Map	Kartta.
AnomalyDetector	Poikkeamien tunnistaminen.
UserDataFunction	Käyttäjätietofunktio.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB -tietokanta.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.

Notebook

Kohde

Muistikirjan objekti.

Nimi	Tyyppi	Description
description	string	Kohteen kuvaus.
displayName	string	Kohteen näyttönimi.
folderId	string (uuid)	Kansion tunnus.
id	string (uuid)	Kohdetunnus.
sensitivityLabel	SensitivityLabel	Kohteen luottamuksellisuustunniste.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi.
workspaceId	string (uuid)	Työtilan tunnus.

NotebookDefinition

Kohde

Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta.

Nimi	Tyyppi	Description
format	string	Muistikirja-määritelmän muoto. Tuettu muoto: `ipynb` ja `fabricGitSource`. Jos muotoa ei ole annettu, `fabricGitSource` käytetään kohdetta .
parts	NotebookDefinitionPart[]	Luettelo määritysosista.

NotebookDefinitionPart

Kohde

Muistikirjan määritelmäosan objekti.

Nimi	Tyyppi	Description
path	string	Muistikirjan osan polku. Tuetut muistikirjan sisältölaajennukset: `.ipynbipynb` for format; `.py`, `.scala`, `.r.sql` for `fabricGitSource` format.
payload	string	Muistikirjan osan hyötykuorma.
payloadType	PayloadType	Hyötykuorman tyyppi.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
InlineBase64	Inline Base 64.

SensitivityLabel

Kohde

Edustaa kohteelle käytettyä luottamuksellisuustunnistetta.

Nimi	Tyyppi	Description
id	string (uuid)	Tämä on luottamuksellisuustunnisteen tunnus.

SensitivityLabelApplyStrategy

Luettelointi

Tämä on luottamuksellisuustunnisteen käyttöön tarkoitettu strategia. Oletusarvo on ApplyOrFail. Muita tyyppejä voidaan lisätä ajan mittaan.

Arvo	Description
ApplyOrFail	Käytä luottamuksellisuustunnistetta tai epäonnistu toiminto, jos sitä ei voi käyttää.
Ignore	Ohita luottamuksellisuustunniste, jos sitä ei voi käyttää, ja jatka toiminnolla ilman tunnisteen käyttämistä.

SensitivityLabelSettings

Kohde

Luottamuksellisuustunnisteen asetukset.

Nimi	Tyyppi	Description
labelId	string (uuid)	Tämä on luottamuksellisuustunnisteen tunnus.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Tämä on luottamuksellisuustunnisteen käyttöön tarkoitettu strategia.

Jaa

Items - Create Notebook

Käyttöoikeudet

Vaaditut delegoidut vaikutusalueet

Rajoitukset

tuettujen käyttäjätietojen Microsoft Entra

Rajapinta

URI-parametrit

Pyynnön leipäteksti

Vastaukset

Esimerkit

Create a notebook example

Mallipyyntö

Mallivastaus

Create a notebook with public definition in fabricGitSource format example

Mallipyyntö

Mallivastaus

Create a notebook with public definition in ipynb format example

Mallipyyntö

Mallivastaus

Määritelmät

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType

SensitivityLabel

SensitivityLabelApplyStrategy

SensitivityLabelSettings