Fabric'de API'lerle defterleri yönetme ve yürütme.

Microsoft Fabric REST API'si, bir Fabric öğesinin oluşturma, okuma, güncelleştirme ve silme (CRUD) işlemleri için bir hizmet uç noktası sağlar. Bu makalede, kullanılabilir not defteri REST API'leri ve bunların kullanımı açıklanmaktadır.

Not defteri API'leri sayesinde veri mühendisleri ve veri bilimcileri kendi işlem hatlarını otomatikleştirebilir ve ci/CD'yi rahatça ve verimli bir şekilde kurabilir. Bu API'ler, kullanıcıların Doku not defteri öğelerini yönetmesini ve manipüle etmesini ve not defterlerini diğer araçlar ve sistemlerle tümleştirmesini de kolaylaştırır. Not defterleri bu API'ler aracılığıyla Doku işlem hatlarından ve dış zamanlayıcılardan düzenlenebilir ve otomatik iş akışlarıyla sorunsuz tümleştirmeye olanak tanır.

Bu Öğe yönetimi eylemleri not defterleri için kullanılabilir:

Eylem Açıklama
Öğe oluştur Çalışma alanı içinde bir not defteri oluşturur.
Öğeyi güncelleştir Not defterinin meta verilerini güncelleştirir.
Öğe tanımını güncelleştirme Not defterinin içeriğini güncelleştirir.
Öğeyi sil Bir defteri siler.
Öğeyi al Not defterinin meta verilerini alır.
Öğe tanımını alma Not defterinin içeriğini alır.
Liste öğesi Çalışma alanı içindeki tüm öğeleri listeleme.

Daha fazla bilgi için bkz . Öğeler - REST API.

Not defterleri için aşağıdaki İş zamanlayıcı eylemleri kullanılabilir:

Eylem Açıklama
Talep Üzerine Ürün Görevi Yürütme Parametreleştirme, oturum yapılandırması (Spark/işlem ayarları gibi), ortam ve çalışma zamanı seçimi ve hedef Fabric Lakehouse seçimi desteğiyle isteğe bağlı olarak bir not defteri çalıştırın.
Öğeyi Görev Örneğini İptal Et Not defteri işi çalıştırmayı iptal etme.
Öğe İş Örneğini Al Defter çalışmasının durumunu edinin ve çalışmanın döndürdüğü çıkış değerini alın.

Daha fazla bilgi için bkz . İş Zamanlayıcı.

Not

Hizmet sorumlusu kimlik doğrulaması hem Items REST API (not defteri CRUD işlemleri) hem de İş Zamanlayıcı API'sinde (yürütme, izleme ve iptal) desteklenir. Bu, güvenli katılımsız otomasyon ve CI/CD senaryolarına olanak tanır. Not defterlerini yönetmek ve yürütmek için uygun bir role (Yönetici, Üye veya Katkıda Bulunan) sahip hizmet sorumlusunu çalışma alanına ekleyin.

Notebook çalıştırmalarının çıkış değerleri

İş Zamanlayıcı API'si aracılığıyla yürütülen not defteri çalıştırmaları, koşullu düzenleme için kullanabileceğiniz bir çıkış değeri döndürebilir. Çıkış değeriexitValue yanıt yükünün alanında görünür.

Bir not defteri, çalıştırma tamamlanmadan önce çağırarak mssparkutils.notebook.exit("your-value") çıkış değerini ayarlayabilir. Çıkış değeri bir dizedir ve herhangi bir sonuç sinyalini (örneğin, "success", "no_rows_processed"veya JSON serileştirilmiş sonucu) kodlayabilir.

Dış orkestratörler, Fabric işlem hatları ve diğer otomasyon araçları, çalıştırma tamamlandıktan sonra çıkış değerini okumak ve sonuçlara göre dallanmak için Get Item Job Instance'yi çağırabilir. Örneğin:

  1. Parametreler ve yürütme ayarlarıyla isteğe bağlı çalıştır Öğe İşi gönderin.
  2. Öğe Alma İşi Örneğinistatus, Completed (veya Failed) olana kadar yokla.
  3. İş akışınızdaki bir sonraki adımı belirlemek için yanıttan okuyun exitValue .

Bu desen, defter yürütme sonuçlarına göre koşullu orkestrasyon ve aşağı yönlü sinyalleme sağlar.

Uçtan uca örnek

Aşağıdaki örnek, bir çalışma kitabı çalıştırmasını nasıl başlatıp, durumunu ve çıkış değerini nasıl alacağınızı göstermektedir. Parametreler, oturum yapılandırması ve Lakehouse seçim alanları dahil olmak üzere istek gövdesi şemasının tamamını görmek için Job Scheduler - İsteğe Bağlı Çalıştırma İş Ögesi API başvurusuna bakın.

1. Adım: Çalıştırma işlemini gönder

Bir not defteri çalıştırmasını başlatmak için Talep Üzerine Çalıştırma Görevi uç noktasını kullanın:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{notebookId}/jobs/instances?jobType=RunNotebook

Yanıt, çalıştırmayı izlemek için kullandığınız iş örneğinin URL'sini içeren Location başlığıyla 202 Accepted döner.

2. Adım: Çalıştırma durumunu ve çıkış değerini alma

Durumu denetlemek ve çalıştırma tamamlandıktan sonra çıkış değerini okumak için üst bilgideki Location URL'yi kullanın:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{notebookId}/jobs/instances/{jobInstanceId}

Örnek yanıt (kısaltılmış):

{
  "id": "<jobInstanceId>",
  "itemId": "<notebookId>",
  "jobType": "RunNotebook",
  "invokeType": "OnDemand",
  "status": "Completed",
  "startTimeUtc": "2026-03-01T10:00:00Z",
  "endTimeUtc": "2026-03-01T10:05:00Z",
  "failureReason": null,
  "exitValue": "success"
}

Okuyun exitValue sonucu belirlemek ve otomasyon mantığınızı buna göre dallandırın.

  • Last updated on