Baca dalam bahasa Inggris

Bagikan melalui

Items - Create Notebook

  • Referensi
Layanan:
Notebook
Versi API:
v1

Membuat buku catatan di ruang kerja yang ditentukan.
API ini mendukung operasi jangka panjang (LRO).

Untuk membuat buku catatan dengan definisi, lihat artikel definisi Notebook.

Izin

Pemanggil harus memiliki kontributor atau peran ruang kerja yang lebih tinggi.

Cakupan yang Didelegasikan yang Diperlukan

Notebook.ReadWrite.All atau Item.ReadWrite.All

Keterbatasan

  • Untuk membuat buku catatan, ruang kerja harus berada pada kapasitas Fabric yang didukung. Untuk informasi selengkapnya, lihat: jenis lisensi Microsoft Fabric.

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas Dukung
Pengguna Ya
perwakilan Layanan dan identitas terkelola Ya

Antarmuka

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
workspaceId
 path True

string

uuid

ID ruang kerja.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
displayName True

string

Nama tampilan buku catatan. Nama tampilan harus mengikuti aturan penamaan sesuai dengan jenis item.
definition

NotebookDefinition

Definisi publik buku catatan.
description

string

Deskripsi buku catatan. Panjang maksimum adalah 256 karakter.

Respons

Nama Jenis Deskripsi
201 Created

Notebook

Berhasil dibuat
202 Accepted

Permintaan diterima, provisi buku catatan sedang berlangsung.

Header

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

ErrorResponse

Kode kesalahan umum:

  • InvalidItemType - Tipe item tidak valid

  • ItemDisplayNameAlreadyInUse - Nama tampilan item sudah digunakan.

  • CorruptedPayload - Payload yang disediakan rusak.

Contoh

Create a notebook example
Create a notebook with public definition example

Create a notebook example

Permintaan sampel

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

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
CreateNotebookRequest

Buat payload permintaan buku catatan.
ErrorRelatedResource

Objek detail sumber daya terkait kesalahan.
ErrorResponse

Respons kesalahan.
ErrorResponseDetails

Detail respons kesalahan.
ItemType

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
Notebook

Objek buku catatan.
NotebookDefinition

Objek definisi publik notebook. Lihat artikel ini untuk detail selengkapnya tentang cara membuat definisi publik notebook.
NotebookDefinitionPart

Objek bagian definisi buku catatan.
PayloadType

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

CreateNotebookRequest

Objek

Buat payload permintaan buku catatan.

Nama Jenis Deskripsi
definition

NotebookDefinition

Definisi publik buku catatan.
description

string

Deskripsi buku catatan. Panjang maksimum adalah 256 karakter.
displayName

string

Nama tampilan buku catatan. Nama tampilan harus mengikuti aturan penamaan sesuai dengan jenis item.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama Jenis Deskripsi
resourceId

string

ID sumber daya yang terlibat dalam kesalahan.
resourceType

string

Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message

string

Representasi kesalahan yang dapat dibaca manusia.
moreDetails

ErrorResponseDetails[]

Daftar detail kesalahan tambahan.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.
requestId

string

ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message

string

Representasi kesalahan yang dapat dibaca manusia.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.

ItemType

Enumeration

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
Dashboard

Dasbor PowerBI.
DataPipeline

Alur data.
Datamart

Datamart PowerBI.
Environment

Lingkungan.
Eventhouse

Sebuah rumah acara.
Eventstream

Eventstream.
GraphQLApi

API untuk item GraphQL.
KQLDashboard

Dasbor KQL.
KQLDatabase

Database KQL.
KQLQueryset

Set kueri KQL.
Lakehouse

Sebuah lakehouse.
MLExperiment

Eksperimen pembelajaran mesin.
MLModel

Model pembelajaran mesin.
MirroredDatabase

Database cermin.
MirroredWarehouse

Sebuah gudang cermin.
MountedDataFactory

A MountedDataFactory.
Notebook

Buku catatan.
PaginatedReport

Laporan paginasi PowerBI.
Reflex

Sebuah Refleks.
Report

Laporan PowerBI.
SQLDatabase

Sebuah SQLDatabase.
SQLEndpoint

Titik akhir SQL.
SemanticModel

Model semantik PowerBI.
SparkJobDefinition

Definisi pekerjaan spark.
Warehouse

Sebuah gudang.

Notebook

Objek

Objek buku catatan.

Nama Jenis Deskripsi
description

string

Deskripsi item.
displayName

string

Nama tampilan item.
id

string

uuid

ID item.
type

ItemType

Jenis item.
workspaceId

string

uuid

ID ruang kerja.

NotebookDefinition

Objek

Objek definisi publik notebook. Lihat artikel ini untuk detail selengkapnya tentang cara membuat definisi publik notebook.

Nama Jenis Deskripsi
format

string

Format definisi Notebook. Format yang didukung: ipynb.
parts

NotebookDefinitionPart[]

Daftar bagian definisi.

NotebookDefinitionPart

Objek

Objek bagian definisi buku catatan.

Nama Jenis Deskripsi
path

string

Jalur bagian buku catatan.
payload

string

Payload bagian notebook.
payloadType

PayloadType

Jenis payload.

PayloadType

Enumeration

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
InlineBase64

Dasar Sebaris 64.