Jaa

Items - Create Notebook

  • Viite
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 tai suurempi työtilarooli.

Vaaditut delegoidut vaikutusalueet

Notebook.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Microsoft Entran tukemat käyttäjätiedot

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ä.

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
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.

Esimerkit

Create a notebook example
Create a notebook with public definition example

Create a notebook example

Mallipyyntö

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

Mallipyyntö

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

Mallivastaus

Tilakoodi:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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.
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 julkisesta määritelmästä.
NotebookDefinitionPart

Muistikirjan määritelmäosan objekti.
PayloadType

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

CreateNotebookRequest

Object

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.

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Description
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Object

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

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Object

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.

ItemType

Luettelointi

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

Arvo Description
Dashboard

Power BI -koontinäyttö.
DataPipeline

Tietoputki.
Datamart

PowerBI -tietomarssi.
Environment

Ympäristö.
Eventhouse

Tapahtumatalo.
Eventstream

Tapahtumavirta.
GraphQLApi

Ohjelmointirajapinta GraphQL-kohteelle.
KQLDashboard

KQL-koontinäyttö.
KQLDatabase

KQL-tietokanta.
KQLQueryset

KQL-kyselyjoukko.
Lakehouse

Tämä on lakehouse.
MLExperiment

Koneoppimisen kokeilu.
MLModel

Koneoppimismalli.
MirroredDatabase

Peilattu tietokanta.
MirroredWarehouse

Peilattu varasto.
MountedDataFactory

A MountedDataFactory.
Notebook

Muistikirja.
PaginatedReport

PowerBI:n sivutettu raportti.
Reflex

Refleksi.
Report

PowerBI -raportti.
SQLDatabase

A SQLDatabase.
SQLEndpoint

SQL-päätepiste.
SemanticModel

PowerBI:n semanttinen malli.
SparkJobDefinition

Spark-työn määritelmä.
Warehouse

Varasto.

Notebook

Object

Muistikirjan objekti.

Nimi Tyyppi Description
description

string

Kohteen kuvaus.
displayName

string

Kohteen näyttönimi.
id

string

uuid

Kohdetunnus.
type

ItemType

Kohdetyyppi.
workspaceId

string

uuid

Työtilan tunnus.

NotebookDefinition

Object

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

Nimi Tyyppi Description
format

string

Muistikirja-määritelmän muoto. Tuettu muoto: ipynb.
parts

NotebookDefinitionPart[]

Luettelo määritysosista.

NotebookDefinitionPart

Object

Muistikirjan määritelmäosan objekti.

Nimi Tyyppi Description
path

string

Muistikirjan osan polku.
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.