Aracılığıyla paylaş

Items - Create Notebook

  • Başvuru
Hizmet:
Notebook
API Sürümü:
v1

Belirtilen çalışma alanında bir not defteri oluşturur.
Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Tanımıyla not defteri oluşturmak için Not Defteri tanımı makalesine bakın.

İzinler

Çağıranın katkıda bulunan veya daha yüksek çalışma alanı rolü olmalıdır.

Gerekli Temsilci Kapsamları

Notebook.ReadWrite.All veya Item.ReadWrite.All

Sınırlama

  • Not defteri oluşturmak için çalışma alanının desteklenen bir Doku kapasitesinde olması gerekir. Daha fazla bilgi için bkz. Microsoft Fabric lisans türleri.

Microsoft Entra tarafından desteklenen kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik Destek
Kullanıcı Evet
Hizmet sorumlusu ve yönetilen kimlikler Evet

Arayüz

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

URI Parametreleri

Name İçinde Gerekli Tür Description
workspaceId
 path True

string

uuid

Çalışma alanı kimliği.

İstek Gövdesi

Name Gerekli Tür Description
displayName True

string

Not defterinin görünen adı. Görünen ad, öğe türüne göre adlandırma kurallarına uymalıdır.
definition

NotebookDefinition

Not defteri genel tanımı.
description

string

Not defteri açıklaması. Uzunluk üst sınırı 256 karakterdir.

Yanıtlar

Name Tür Description
201 Created

Notebook

Başarıyla oluşturuldu
202 Accepted

İstek kabul edildi, not defteri sağlama devam ediyor.

Üst Bilgiler

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

ErrorResponse

Yaygın hata kodları:

  • InvalidItemType - Öğe türü geçersiz

  • ItemDisplayNameAlreadyInUse - Öğe görünen adı zaten kullanılıyor.

  • BozukPayload - Sağlanan yük bozuk.

Örnekler

Create a notebook example
Create a notebook with public definition example

Create a notebook example

Örnek isteği

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

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

Örnek yanıt

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

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Name Description
CreateNotebookRequest

Not defteri isteği yükü oluşturun.
ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse

Hata yanıtı.
ErrorResponseDetails

Hata yanıtı ayrıntıları.
ItemType

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.
Notebook

Not defteri nesnesi.
NotebookDefinition

Not defteri genel tanım nesnesi. Not defteri genel tanımı oluşturma hakkında daha fazla bilgi için bu makale bakın.
NotebookDefinitionPart

Not defteri tanımı parça nesnesi.
PayloadType

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

CreateNotebookRequest

Object

Not defteri isteği yükü oluşturun.

Name Tür Description
definition

NotebookDefinition

Not defteri genel tanımı.
description

string

Not defteri açıklaması. Uzunluk üst sınırı 256 karakterdir.
displayName

string

Not defterinin görünen adı. Görünen ad, öğe türüne göre adlandırma kurallarına uymalıdır.

ErrorRelatedResource

Object

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name Tür Description
resourceId

string

Hataya dahil olan kaynak kimliği.
resourceType

string

Hataya dahil olan kaynağın türü.

ErrorResponse

Object

Hata yanıtı.

Name Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message

string

Hatanın okunabilir bir gösterimi.
moreDetails

ErrorResponseDetails[]

Ek hata ayrıntılarının listesi.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.
requestId

string

Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Object

Hata yanıtı ayrıntıları.

Name Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message

string

Hatanın okunabilir bir gösterimi.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

ItemType

Listeleme

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.

Değer Description
Dashboard

PowerBI panosu.
DataPipeline

Veri işlem hattı.
Datamart

PowerBI datamart.
Environment

Bir ortam.
Eventhouse

Bir olay evi.
Eventstream

Bir olay akışı.
GraphQLApi

GraphQL öğesi için bir API.
KQLDashboard

KQL panosu.
KQLDatabase

KQL veritabanı.
KQLQueryset

KQL sorgu kümesi.
Lakehouse

Göl evi.
MLExperiment

Makine öğrenmesi denemesi.
MLModel

Makine öğrenmesi modeli.
MirroredDatabase

Yansıtılmış veritabanı.
MirroredWarehouse

Aynalı bir depo.
MountedDataFactory

Bir MountedDataFactory.
Notebook

Bir not defteri.
PaginatedReport

PowerBI sayfalandırılmış raporu.
Reflex

Bir refleks.
Report

PowerBI raporu.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Bir SQL uç noktası.
SemanticModel

PowerBI anlam modeli.
SparkJobDefinition

Spark iş tanımı.
Warehouse

Bir depo.

Notebook

Object

Not defteri nesnesi.

Name Tür Description
description

string

Öğe açıklaması.
displayName

string

Öğenin görünen adı.
id

string

uuid

Öğe kimliği.
type

ItemType

Öğe türü.
workspaceId

string

uuid

Çalışma alanı kimliği.

NotebookDefinition

Object

Not defteri genel tanım nesnesi. Not defteri genel tanımı oluşturma hakkında daha fazla bilgi için bu makale bakın.

Name Tür Description
format

string

Not Defteri tanımının biçimi. Desteklenen biçim: ipynb.
parts

NotebookDefinitionPart[]

Tanım bölümlerinin listesi.

NotebookDefinitionPart

Object

Not defteri tanımı parça nesnesi.

Name Tür Description
path

string

Not defteri bölüm yolu.
payload

string

Not defteri bölümü yükü.
payloadType

PayloadType

Yük türü.

PayloadType

Listeleme

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer Description
InlineBase64

Satır içi Temel 64.