Genel API'ler aracılığıyla ortamı yönetme

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ğlamaktadır. Bu makalede, kullanılabilir ortam REST API'leri ve bunların kullanımı açıklanmaktadır.

Ortam API'lerini kararlı GA sürümlerine geçirme

Önemli

GA sürümü, mevcut API'lerin istek/yanıt sözleşmesindeki güncelleştirmeleri, API kullanımdan kaldırmaları ve yeni API'leri içerir. Ayrıntıları aşağıdaki bölümlerde bulabilirsiniz.
İstek/yanıt sözleşmesi değişikliklerinin geçişini kolaylaştırmak için yeni bir sorgu parametresi beta kullanıma sunulmuştur. beta Sorgu parametresi varsayılan olarak True kadar olur ve önizleme sözleşmelerinin kullanılabilir durumda olmasını sağlar. Sözleşmelerin kararlı Sürüm sürümünü kullanmaya başlamak için değerini False olarak ayarlayın.
Preview sorgu parametresi ile betadeğiştirildi. Geriye dönük uyumluluk için önizleme hala desteklenir ve beta ile aynı şekilde davranır.
Kullanım dışı bırakılacak API'ler 31 Mart 2026'ya kadar desteklenmeye devam edecektir, lütfen yeni tanıtılan API'leri kullanarak mümkün olan en kısa sürede bunları değiştirin.

İstek/yanıt sözleşmesi güncelleştirmeli API'ler

Kategori	API (Uygulama Programlama Arayüzü)	Açıklama	Notes	Swagger önizleme sürümü	Sürüm sürümü swagger
Öğe işlemi	Yayımlama ortamı	Geçerli bekleyen değişikliklerle ortamın yayımlama işlemini tetikleyin.	Yanıt sözleşmesinde güncelleştirme.	Yayımlama ortamı (Önizleme)	Yayımlama ortamı
Hazırlık Aşaması	Hazırlık kitaplıklarını listele	Tüm hazırlık aşaması kitaplığı listesini alın. Bu liste yayımlanan ve bekleyen kütüphaneleri içerir.	Yanıt sözleşmesinde güncelleştirme.	Hazırlama kitaplıklarını listeleme (Önizleme)	Hazırlık kitaplıklarını listele
Hazırlık Aşaması	Spark geçici aşama hesaplamayı listeleme	Tam ön hazırlık bilgi işlem yapılandırmalarını alın. Hazırlama yapılandırmaları yayımlanan ve bekleyen işlem yapılandırmalarını içerir.	Yanıt sözleşmesinde güncelleştirme.	Spark hesaplama geçiş ortamını listele (Önizleme)	Yürütme öncesi Spark işlemeyi listele
Hazırlık Aşaması	Spark hesaplama güncelleştirme	Bir ortamın işlem yapılandırmalarını ve Spark özelliklerini güncelleştirin.	İstek ve yanıt sözleşmelerinde güncelleştirme.	Spark işlem güncelleştirme (Önizleme)	Spark işlem güncelleştirme
Yayımlanmış	Yayımlanan kitaplıkları listeleme	Spark oturumlarında yayımlanan ve kullanılabilir olan kitaplıkları edinin.	Yanıt sözleşmesinde güncelleştirme.	Yayımlanan kitaplıkları listeleme (Önizleme)	Yayımlanan kitaplıkları listeleme
Yayımlanmış	Yayımlanan Spark hesaplamalarını listele	Spark oturumlarında yayımlanan ve etkili olan Spark işlem yapılandırmalarını ve Spark özelliklerini edinin.	Yanıt sözleşmesinde güncelleştirme.	Yayımlanan kitaplıkları listeleme (Önizleme)	Yayımlanan kitaplıkları listeleme

beta parametresi varsayılan olarak True kadardır; yani sistem, kullanımdan kaldırma tarihine kadar bu parametreyi belirtmeden isteğin gönderiliyor gibi True parametresini dikkate alır. Parametreyi beta olarak ayarlayarak uygulamalarınızı en kısa sürede kararlı sürüme False geçirmenizi kesinlikle öneririz.

Örnek olarak, API yanıtında bir güncelleme olan List staging libraries API'sini kullanma.

beta parametresiyle isteği True olarak gönderirken

Örnek talep:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=True

Örnek yanıt:

{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

preview parametresiyle isteği False olarak gönderirken

Örnek talep:

  GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=False

Örnek yanıt:

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Kullanım dışı bırakılacak API'ler

Önemli

Kullanım dışı bırakılacak API'ler 31 Mart 2026 tarihine kadar destek almaya devam edecektir. Uygulamalarınızı en kısa sürede değiştirmek için yeni tanıtılan API'leri kullanmanızı kesinlikle öneririz.

Kategori	API (Uygulama Programlama Arayüzü)	Açıklama	Not
Hazırlık Aşaması	Hazırlama kitaplıklarını yükle	Ortama bir özel kitaplık veya bir/birden çok ortak kitaplık ekleyin.	31 Mart 2026'ya kadar destek sağlanıyor, lütfen yeni eklenen `Import external libraries`/`Upload custom library` API'lerini kullanarak değiştirin.
Hazırlık Aşaması	Hazırlama kütüphanelerini sil	Bir hazırlık özel kitaplığını veya tüm genel kitaplıkları silin.	31 Mart 2026'ya kadar destek sağlanıyor, lütfen yeni eklenen `Remove external library`/`Delete custom library` API'lerini kullanarak değiştirin.

Aşağıda, hazırlama kitaplıklarını yönetirken senaryoları kapsayan birkaç örnek verilmiştir.

Ortamınıza halka açık kütüphaneleri ekleyin

Daha önce güncelleştirilen YAML dosyasını karşıya yüklemek için Upload staging libraries API'sini kullanabilirken, şimdi güncellenmiş YAML dosyasını içeri aktarmak için Import external libraries API'sini kullanabilirsiniz.
Ortamınızdaki bir ortak kitaplığı silme

Daha önce güncellenmiş YAML dosyasını yüklemek için Upload staging libraries API'sini kullanabiliyordunuz ve şimdi kaldırmak için Remove external library API'sini kullanabilirsiniz.
Ortamınızdaki tüm halk kütüphanelerini silin.

Daha önce, TÜM ortak kitaplıkları silmek için Delete staging libraries API'sini kullanabilirsiniz ve şimdi Remove external library API'sini kullanarak ortak kitaplıkları tek tek kaldırabilir veya aynı işlevleri gerçekleştirmek için boş bir YAML dosyasını Import external libraries olarak yükleyebilirsiniz.

Yeni API'ler

Kategori	API (Uygulama Programlama Arayüzü)	Açıklama	Not
Öğe işlemi	Tanım ile ortam oluşturma	Belirli tanımlarla yeni bir ortam oluşturun.	Yeni API.
Öğe işlemi	Ortam tanımını alma	Ortamın tanımını alın.	Yeni API.
Öğe işlemi	Ortam tanımını güncelleştirme	Bir ortamın tanımını güncelleştirin.	Yeni API.
Hazırlık Aşaması	Dış kitaplıkları içeri aktarma	Dış kitaplıkları environment.yml dosyası olarak ortama yükleyin. Bir ortamdaki mevcut dış kitaplıkların listesini geçersiz kılar.	Yeni API.
Hazırlık Aşaması	Dış kitaplıkları dışarı aktarma	Tam dış kitaplıkları environment.yml dosyası olarak alın.	Yeni API.
Hazırlık Aşaması	Dış kitaplığı kaldırma	Bir ortamdan bir dış kütüphaneyi sil. Bu API bir kerede bir kitaplık kabul eder.	Yeni API.
Hazırlık Aşaması	Özel kütüphaneyi yükle	Ortama özel bir paket yükleyin. Bu API, bir kerede bir dosya karşıya yüklemesine izin verir. Desteklenen dosya biçimleri .jar, .py, .whl ve .tar.gz.	Yeni API.
Hazırlık Aşaması	Özel kitaplığı silme	Özel bir paketi ortamdan silin. Özel paketin tam adını api isteğinde uzantıyla birlikte koyarak paketin kaldırılmasını sağlayın.	Yeni API.
Yayımlanmış	Dış kitaplıkları dışarı aktarma	Yayımlanan dış kitaplıkları environment.yml dosyası olarak alın.	Yeni API.

Güncelleştirme olmadan API'ler

Kategori	API (Uygulama Programlama Arayüzü)	Açıklama
Öğe işlemi	Ortam oluşturma	Çalışma alanında yeni bir boş ortam oluşturun.
Öğe işlemi	Ortamı al	Bir ortamın meta verilerini alma. Yanıt, ortamın durumunu içerir.
Öğe işlemi	Ortamı silme	Var olan bir ortamı silin.
Öğe işlemi	Liste ortamı	Çalışma alanında ortamların listesini alın.
Öğe işlemi	Ortamı güncelleştirme	Ad ve açıklama gibi bir ortamın meta verilerini güncelleştirin.
Öğe işlemi	Yayımlama ortamını iptal etme	Ortamın devam eden yayımlama işlemini iptal edin.

Ortam genel API'leri hakkında daha fazla bilgi edinmek için bkz . Öğe API'leri - Ortam.

Çevre açık API kullanım örnekleri

Önemli

Bu bölüm, API'lerin kararlı Sürüm sürümüyle gösterilmiştir.

Bu bölümde, Ortamı yönetirken belirli senaryolara ulaşmak için API'lerin nasıl kullanılacağı gösterilmektedir. Aşağıdaki örneklerde {WORKSPACE_ID} ve {ARTIFACT_ID} özelliklerini uygun değerlerle değiştirebilirsiniz.

Yeni bir ortam oluşturun

Yeni boş bir ortam oluşturmak için aşağıdaki API'yi kullanın.

Örnek isteği

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments

{
    "displayName": "Environment_1",
    "description": "An environment description"
}

Hazırlık kitaplıklarını yönet

Ortamdaki kitaplık bölümünü yönetmek için yükleme ve silme hazırlama kitaplıkları API'lerini kullanabilirsiniz.

Ortamda yayımlanan kitaplıkları kontrol edin

Kitaplık eklemeden veya silmeden önce, hangi kitaplıkların geçerli olduğunu denetlemek için Yayımlanan Kitaplıkları Al API'sini kullanın.

Örnek isteği

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries?beta=False

Örnek yanıt

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Genel kütüphaneleri içe aktar veya özel kütüphaneyi yükle

Ortamınıza yeni genel/özel kütüphaneler eklemek için harici kütüphaneleri içeri aktarma ve özel kütüphaneyi karşıya yükleme API'lerini kullanabilirsiniz. Dış kitaplıkları içeri aktarma API'si environment.yml dosyasını kabul eder. Özel kitaplık API'sini yüklemek için desteklenen dosya türleri .whl, .jar, .tar.gz, .py şeklindedir.

Not

Ortak kitaplığı daha verimli bir şekilde işlemek için PyPI ve Conda'dan beklenen tüm kitaplıkları bir environment.yml dosyasında oluşturmanızı öneririz.

Karşıya yükleme API'si tek bir istekte 200 MB'a kadar dosyaya izin verir. Şu anda bu boyut sınırını aşan bir kitaplık genel API'lerde desteklenmemektedir.

Örnek talepler

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibraries

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Özel kitaplığı silme

Bir özelleştirilmiş kütüphaneyi aynı anda silebilirsiniz, tür ekiyle tam kütüphane dosya adını belirterek.

Not

Mevcut ortak kitaplıkların bir alt kümesini veya tümünü kaldırmak istiyorsanız, güncelleştirilmiş bir YAML dosyasını API aracılığıyla Import public libraries içeri aktarın.

Örnek talepler

DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Spark işlem hazırlamayı yönetme

Spark işlemini yönetmek için Güncelleştirme hazırlama Spark işlemini kullanabilirsiniz.

Ortam için yayımlanan Spark hesaplamasını kontrol et

Ortamın yapılandırmalarını değiştirmeden önce Yayımlanan Spark İşlem API'sini kullanarak hangi Spark işlem yapılandırmalarının geçerli olduğunu denetleyin.

Örnek isteği

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute?beta=False

Örnek yanıt

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

İşlem yapılandırmalarını güncelleştirme

Bu API'nin istek gövdesini düzenleyip Spark çalışma zamanını güncelleştirebilir, başka bir havuza geçebilir, işlem yapılandırmasını iyileştirebilir ve Spark özelliklerini ekleyebilir veya kaldırabilirsiniz.

Havuz adını ve havuzu belirterek ekli havuzu değiştirebilirsiniz. Havuzu varsayılan ayarlara geçmek için havuz adını olarak Starter Pool belirtin. REST API ile çalışma alanının kullanılabilir özel havuzlarının tam listesini almak için bkz. Özel Havuzlar - Çalışma Alanı Özel Havuzlarını Listeleme.

Mevcut bir Spark özelliğini kaldırmak istiyorsanız, kaldırmak istediğiniz anahtarla olarak null değerini belirtin.

Örnek isteği

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=False

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

Değişiklikleri etkili hale getirme

Değişiklikleri yayımlamak için aşağıdaki API kümelerini kullanın.

Yayımlama işlemine hazırlanma

Ortam bir kerede bir yayımlama işlemini kabul edebilir. Ortamınızı yayımlamadan önce ortamın durumunu doğrulayın ve hazırlama değişikliklerini son kez gözden geçirin. Ortam başarıyla yayımlandıktan sonra hazırlama durumundaki tüm yapılandırmalar etkili olur.

1. Adım: Ortamın meta verilerini alın.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
Yanıt gövdesinde ortamın durumunu açıkça belirtebilirsiniz. Sonraki adıma geçmeden önce hiçbir yayımlama işleminin devam etmediğinden emin olun.

2. Adım: Son gözden geçirme için hazırlık kitaplıklarını/Spark işlem birimini hazırlayın.

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?beta=False

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute?beta=False

Ortamın yayımlama işlemini başlat

Hazırlık kitaplıkları ve Spark işlemi için yaptığınız değişiklikler önbelleğe alınır, ancak geçerli olmaları için yayımlanmaları gerekir. Yayımlama işlemini tetikleme için sonraki örneği kullanın. Yanıt uzun süre çalışan işlemler (LRO) desenindedir ve HTTP yanıt kodu 202 döndürülebilir.

Örnek isteği

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=False

Örnek yanıt

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

Yayımlama işlemi sırasında iptal etmek için aşağıdaki API'yi de çağırabilirsiniz.

Örnek isteği

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2025-10-09

Aracılığıyla paylaş

Genel API'ler aracılığıyla ortamı yönetme

Ortam API'lerini kararlı GA sürümlerine geçirme

İstek/yanıt sözleşmesi güncelleştirmeli API'ler

Kullanım dışı bırakılacak API'ler

Yeni API'ler

Güncelleştirme olmadan API'ler

Çevre açık API kullanım örnekleri

Yeni bir ortam oluşturun

Hazırlık kitaplıklarını yönet

Ortamda yayımlanan kitaplıkları kontrol edin

Genel kütüphaneleri içe aktar veya özel kütüphaneyi yükle

Özel kitaplığı silme

Spark işlem hazırlamayı yönetme

Ortam için yayımlanan Spark hesaplamasını kontrol et

İşlem yapılandırmalarını güncelleştirme

Değişiklikleri etkili hale getirme

Yayımlama işlemine hazırlanma

Ortamın yayımlama işlemini başlat

İlgili içerik

Geri Bildirim

Ek kaynaklar