Megosztás a következőn keresztül:

Items - Create Notebook

  • Referencia
Szolgáltatás:
Notebook
API-verzió:
v1

Létrehoz egy jegyzetfüzetet a megadott munkaterületen.
Ez az API támogatja hosszú ideig futó műveleteket (LRO).

Ha definícióval szeretne jegyzetfüzetet létrehozni, tekintse meg jegyzetfüzetdefiníciós cikket.

Engedélyek

A hívónak közreműködői vagy magasabb munkaterületi szerepkört kell tartalmaznia.

Kötelező delegált hatókörök

Notebook.ReadWrite.All vagy Item.ReadWrite.All

Korlátozások

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Azonosság Támogat
Felhasználó Igen
szolgáltatásnév és felügyelt identitások Igen

Interfész

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

URI-paraméterek

Name In Kötelező Típus Description
workspaceId
 path True

string

uuid

A munkaterület azonosítója.

Kérelem törzse

Name Kötelező Típus Description
displayName True

string

A jegyzetfüzet megjelenítendő neve. A megjelenítendő névnek az elemtípusnak megfelelő elnevezési szabályokat kell követnie.
definition

NotebookDefinition

A jegyzetfüzet nyilvános definíciója.
description

string

A jegyzetfüzet leírása. A maximális hossz 256 karakter.

Válaszok

Name Típus Description
201 Created

Notebook

Sikeresen létrehozva
202 Accepted

A kérelem elfogadva, a jegyzetfüzet kiépítése folyamatban van.

Fejlécek

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Gyakori hibakódok:

  • InvalidItemType – Az elem típusa érvénytelen

  • ItemDisplayNameAlreadyInUse – Az elem megjelenítendő neve már használatban van.

  • CorruptedPayload – A megadott hasznos adatok sérültek.

Példák

Create a notebook example
Create a notebook with public definition example

Create a notebook example

Mintakérelem

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

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

Mintaválasz

Állapotkód:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Állapotkód:
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

Mintakérelem

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

Mintaválasz

Állapotkód:
201 
{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Állapotkód:
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

Definíciók

Name Description
CreateNotebookRequest

Jegyzetfüzet-kérelem hasznos adatainak létrehozása.
ErrorRelatedResource

A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse

A hibaválasz.
ErrorResponseDetails

A hibaválasz részletei.
ItemType

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.
Notebook

Jegyzetfüzet-objektum.
NotebookDefinition

Jegyzetfüzet nyilvános definíciós objektuma. Ebben a cikkben további információt a jegyzetfüzetek nyilvános definícióinak elkészítéséről.
NotebookDefinitionPart

Jegyzetfüzetdefiníciós részobjektum.
PayloadType

A definíciórész hasznos adattípusa. Idővel további hasznos adattípusok is hozzáadhatók.

CreateNotebookRequest

Objektum

Jegyzetfüzet-kérelem hasznos adatainak létrehozása.

Name Típus Description
definition

NotebookDefinition

A jegyzetfüzet nyilvános definíciója.
description

string

A jegyzetfüzet leírása. A maximális hossz 256 karakter.
displayName

string

A jegyzetfüzet megjelenítendő neve. A megjelenítendő névnek az elemtípusnak megfelelő elnevezési szabályokat kell követnie.

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name Típus Description
resourceId

string

A hibában érintett erőforrás-azonosító.
resourceType

string

A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
moreDetails

ErrorResponseDetails[]

További hibaadatok listája.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.
requestId

string

A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.

ItemType

Enumerálás

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.

Érték Description
Dashboard

PowerBI-irányítópult.
DataPipeline

Egy adatfolyam.
Datamart

PowerBI datamart.
Environment

Egy környezet.
Eventhouse

Egy rendezvényház.
Eventstream

Eseménystream.
GraphQLApi

Api a GraphQL-elemhez.
KQLDashboard

KQL-irányítópult.
KQLDatabase

KQL-adatbázis.
KQLQueryset

KQL-lekérdezéskészlet.
Lakehouse

Egy tóház.
MLExperiment

Gépi tanulási kísérlet.
MLModel

Gépi tanulási modell.
MirroredDatabase

Tükrözött adatbázis.
MirroredWarehouse

Egy tükrözött raktár.
MountedDataFactory

A MountedDataFactory.
Notebook

Egy jegyzetfüzet.
PaginatedReport

Többoldalas PowerBI-jelentés.
Reflex

Egy reflex.
Report

PowerBI-jelentés.
SQLDatabase

A SQLDatabase.
SQLEndpoint

EGY SQL-végpont.
SemanticModel

PowerBI szemantikai modell.
SparkJobDefinition

Spark-feladat definíciója.
Warehouse

Egy raktár.

Notebook

Objektum

Jegyzetfüzet-objektum.

Name Típus Description
description

string

Az elem leírása.
displayName

string

Az elem megjelenítendő neve.
id

string

uuid

Az elem azonosítója.
type

ItemType

Az elem típusa.
workspaceId

string

uuid

A munkaterület azonosítója.

NotebookDefinition

Objektum

Jegyzetfüzet nyilvános definíciós objektuma. Ebben a cikkben további információt a jegyzetfüzetek nyilvános definícióinak elkészítéséről.

Name Típus Description
format

string

A jegyzetfüzetdefiníció formátuma. Támogatott formátum: ipynb.
parts

NotebookDefinitionPart[]

Definíciórészek listája.

NotebookDefinitionPart

Objektum

Jegyzetfüzetdefiníciós részobjektum.

Name Típus Description
path

string

A jegyzetfüzetrész elérési útja.
payload

string

A jegyzetfüzetrész hasznos adatai.
payloadType

PayloadType

A hasznos adat típusa.

PayloadType

Enumerálás

A definíciórész hasznos adattípusa. Idővel további hasznos adattípusok is hozzáadhatók.

Érték Description
InlineBase64

Beágyazott 64-es alap.