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

  • Makale

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

Önemli

Bu özellik önizleme aşamasındadır.

Kullanılabilir ortam API'lerinin özeti

API Açıklama Kategori
Ortam oluşturma Çalışma alanında yeni bir ortam oluşturun. Genel
Ortamı alma Bir ortamın meta verilerini alma. Yanıt, ortamın durumunu içerir. Genel
Ortamı güncelleştirme Ad ve açıklama gibi bir ortamın meta verilerini güncelleştirin. Genel
Ortam silme Var olan bir ortamı silin. Genel
Çalışma alanında ortamı listeleme Çalışma alanında ortamın listesini alın. Genel
Yayımlama ortamı Geçerli bekleyen değişikliklerle ortamın yayımlanmasını tetikleyin. Genel
İptali yayımlama Ortamın devam eden yayımlamasını iptal etme Genel
Yayımlanan Spark işlem alma Etkili Spark işlem yapılandırmalarını edinin. Spark işlem
Spark işlem hazırlamayı alma Tam hazırlama 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. Spark işlem
Yayımlanan kitaplıkları alma Etkili olan kitaplık listesini alın. Kitaplıklar
Hazırlama kitaplıklarını alma Tam hazırlama kitaplığı listesini alın. Bu liste yayımlanan ve bekleyen kitaplıkları içerir. Kitaplıklar
Hazırlama kitaplıklarını karşıya yükleme Ortama bir özel kitaplık veya bir/birden çok ortak kitaplık ekleme. Kitaplıklar
Hazırlama kitaplıklarını silme Bir hazırlama özel kitaplığını veya tüm ortak kitaplığı silin. Kitaplıklar

Öğe API'lerinde ortam genel API'leri hakkında daha fazla bilgi edinin - Ortam

Ortam genel API kullanım örnekleri

Bu bölüm, ortamla ilgilenirken çeşitli yaygın senaryolarda size yol gösterir. aşağıdaki örneklerde ve {ARTIFACT_ID} değerini uygun değerlerle değiştirebilirsiniz{WORKSPACE_ID}.

Yeni bir ortam oluşturun

Aşağıdaki API'yi kullanarak yeni bir boş ortam oluşturabilirsiniz.

  • Örnek isteği

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

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

Hazırlama kitaplıklarını yönetme

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

Ortam için yayımlanan kitaplıkları denetleyin

Kitaplığı eklemeden/silmeden önce, hangi kitaplıkların geçerli olduğunu denetlemek için yayımlanan kitaplıkları alma API'sini kullanabilirsiniz.

  • Örnek isteği

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

  • Ö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": "dependencies:\r\n- pip:\r\n  - matplotlib==3.4.3"
}

Kitaplıkları karşıya yükleme

Hazırlama kitaplığını karşıya yüklemek için API bir kerede bir dosya kabul eder. Desteklenen dosya türleri ortak kitaplık için .whl, .jar, .tar.gz, .py ve environment.yml'dır. Dosyayı çok parçalı/form-veri içerik türü aracılığıyla belirtebilirsiniz.

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şturmak kesinlikle önerilir.
  • Karşıya yükleme API'si tek bir istekte 200 MB'a kadar dosyaya izin verir. Bu boyut sınırını aşan kitaplık şu anda genel API'de desteklenmemektedir.

  • Örnek istekler

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

Kitaplıkları silme

Tür soneki ile tam kitaplık dosya adını belirterek, bir kerede bir kitaplığı silebilirsiniz.

Not

  • Silinecek dosya olarak belirtirseniz environment.yml , tüm ortak kitaplıkları kaldırmış olursunuz.
  • Mevcut ortak kitaplığın bir alt kümesini kaldırmak istiyorsanız, lütfen bunun yerine karşıya yükleme kitaplığını kullanın ve yalnızca beklenen kitaplıkları içeren bir environment.yml karşıya yükleyin. Karşıya yüklenen environment.yml , mevcut genel kitaplık bölümünün tamamen yerini alır.

  • Örnek istekler

    DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?libraryToDelete=fuzzywuzzy-0.18.0-py2.py3-none-any.whl

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 işlemini denetleme

Ortamın yapılandırmalarını değiştirmeden önce yayımlanan Spark işlem API'sini kullanarak şu anda hangi Spark işlem yapılandırmalarının etkili olduğunu kontrol edebilirsiniz.

  • Örnek isteği

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

  • Örnek yanıt

    {
    "instancePool": {
        "name": "Starter Pool",
        "type": "Workspace"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
        "enabled": false,
        "minExecutors": 1,
        "maxExecutors": 1
    },
    "sparkProperties": {
        "spark.acls.enable": "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/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, aşağıdaki örnekte gösterildiği gibi, kaldırmak istediğiniz anahtarla birlikte null değerini belirtmeniz gerekir.

  • Örnek isteği

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

{
    "instancePool": {
        "name": "Starter Pool",
        "type": "Workspace"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
        "enabled": false,
        "minExecutors": 1,
        "maxExecutors": 1
    },
    "sparkProperties": {
        "spark.acls.enable": null
    },
    "runtimeVersion": "1.2"
}

Değişiklikleri etkili hale getirme

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

Yayımlamaya hazırlanma

Ortam bir kerede bir yayımlamayı kabul edebilir. Ortamınızı yayımlamadan önce ortamın durumunu doğrulayabilir ve hazırlama değişikliklerini son kez gözden geçirebilirsiniz. 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 alma

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

    Yanıt gövdesinde ortamın durumunu net bir şekilde anlayabilirsiniz. Sonraki adıma geçmeden önce devam eden yayımlama olmadığından emin olun.

  • 2. Adım: Son gözden geçirme için hazırlama kitaplıklarını/Spark işlemini alma

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

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

Ortamın yayımlanmasını tetikleme

Hazırlama kitaplıkları ve Spark işlemlerinde yaptığınız değişiklikler önbelleğe alınır, ancak yayımlamanın etkili olmasını gerektirir. Yayımlamayı tetikleme için aşağıdaki örneği izleyin.

  • Örnek isteği

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

  • Örnek yanıt

    {
    "publishDetails":
    {
        "state": "Running",
        "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
        "startTime": "2024-03-29T14:17:09.0697022Z",
        "componentPublishInfo": {
            "sparkLibraries": {
                "state": "Running"
            },
            "sparkSettings": {
                "state": "Running"
            }
        }
    }
}

Yayımlama 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

İlgili içerik