Sdílet prostřednictvím

Správa prostředí prostřednictvím veřejných rozhraní API

  • Článek

Rozhraní MICROSOFT Fabric REST API poskytuje koncový bod služby pro operace vytvoření, čtení, aktualizace a odstranění (CRUD) položky Fabric. Tento článek popisuje dostupná rozhraní REST API prostředí a jejich použití.

Důležité

Tato funkce je ve verzi Preview.

Souhrn dostupných rozhraní API prostředí

API Popis Kategorie
Vytvoření prostředí Vytvořte nové prostředí v pracovním prostoru. OBECNÉ
Získání prostředí Získejte metadata prostředí. Odpověď zahrnuje stav prostředí. OBECNÉ
Aktualizace prostředí Aktualizujte metadata prostředí, jako je název a popis. OBECNÉ
Odstranění prostředí Odstraňte existující prostředí. OBECNÉ
Zobrazení seznamu prostředí v pracovním prostoru Získejte seznam prostředí v pracovním prostoru. OBECNÉ
Publikování prostředí Aktivujte publikování prostředí s aktuálními čekajícími změnami. OBECNÉ
Publikování zrušení Zrušení průběžného publikování prostředí OBECNÉ
Získání publikovaných výpočetních prostředků Sparku Získejte konfigurace výpočetních prostředků Sparku, které jsou efektivní. Výpočetní prostředí Spark
Získání přípravného výpočetního prostředí Spark Získejte úplné přípravné konfigurace výpočetních prostředků. Přípravné konfigurace zahrnují publikované a čekající konfigurace výpočetních prostředků. Výpočetní prostředí Spark
Získání publikovaných knihoven Získejte seznam knihoven, který je efektivní. Knihovny
Získání pracovních knihoven Získejte úplný seznam pracovních knihoven. Tento seznam obsahuje publikované a čekající knihovny. Knihovny
Nahrání přípravných knihoven Přidání jedné vlastní knihovny nebo jedné/více veřejných knihoven v prostředí Knihovny
Odstranění pracovních knihoven Odstraňte jednu pracovní vlastní knihovnu nebo všechny veřejné knihovny. Knihovny

Další informace o veřejných rozhraních API prostředí v rozhraních API pro položky – Prostředí

Případy použití veřejného rozhraní API prostředí

Tato část vás provede několika běžnými scénáři při práci s prostředím. V následujících příkladech můžete nahradit {WORKSPACE_ID} {ARTIFACT_ID} odpovídajícími hodnotami.

Vytvoření nového prostředí

Pomocí následujícího rozhraní API můžete vytvořit nové prázdné prostředí.

  • Ukázkový požadavek

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

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

Správa pracovních knihoven

K správě oddílu knihovny v prostředí můžete použít rozhraní API pracovních knihoven pro nahrání/odstranění.

Kontrola publikovaných knihoven pro prostředí

Před přidáním nebo odstraněním knihovny můžete pomocí rozhraní API pro získání publikovaných knihoven zkontrolovat, které knihovny jsou aktuálně efektivní.

  • Ukázkový požadavek

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

  • Ukázková odpověď

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

Nahrání knihoven

Rozhraní API pro nahrání pracovní knihovny přijímá současně jeden soubor. Podporované typy souborů jsou .whl, .jar, .tar.gz, .py a environment.yml pro veřejnou knihovnu. Soubor můžete zadat prostřednictvím vícedílového/form-datového typu obsahu.

Poznámka:

  • Aby bylo možné pracovat s veřejnou knihovnou efektivněji, důrazně doporučujeme vytvořit všechny očekávané knihovny z PyPI a conda v souboru environment.yml.
  • Rozhraní API pro nahrávání umožňuje v jednom požadavku až 200 MB souboru, knihovnu, která překračuje tento limit velikosti, se v současné době ve veřejném rozhraní API nepodporuje.

  • Ukázkové požadavky

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

Odstranění knihoven

Zadáním úplného názvu souboru knihovny s příponou typu můžete současně odstranit jednu knihovnu.

Poznámka:

  • Pokud jako soubor, který chcete odstranit, zadáte environment.yml , odeberete všechny veřejné knihovny.
  • Pokud chcete odebrat podmnožinu existující veřejné knihovny, použijte místo toho knihovnu pro nahrání a nahrajte environment.yml, která obsahuje pouze očekávané knihovny. Nahraný environment.yml nahradí stávající oddíl veřejné knihovny zcela.

  • Ukázkové požadavky

    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

Správa přípravného výpočetního prostředí Spark

Ke správě výpočetních prostředků Sparku můžete použít přípravné výpočetní prostředky Sparku.

Kontrola publikovaných výpočetních prostředků Sparku pro prostředí

Před změnou konfigurací pro prostředí můžete pomocí publikovaného výpočetního rozhraní API Sparku zkontrolovat, jaké výpočetní konfigurace Sparku jsou aktuálně efektivní.

  • Ukázkový požadavek

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

  • Ukázková odpověď

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

Aktualizace konfigurací výpočetních prostředků

Modul runtime Sparku můžete aktualizovat, přepnout do jiného fondu, upřesnit konfiguraci výpočetních prostředků a přidat nebo odebrat vlastnosti Sparku prostřednictvím úprav textu požadavku tohoto rozhraní API.

Pokud chcete odebrat existující vlastnost Sparku, musíte zadat hodnotu jako null klíč, který chcete odebrat, jak je znázorněno v následujícím příkladu.

  • Ukázkový požadavek

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

Efektivní provedení změn

Pomocí následujících sad rozhraní API publikujte změny.

Příprava na publikování

Prostředí může přijmout jedno publikování najednou. Před publikováním prostředí můžete ověřit stav prostředí a provést konečnou kontrolu přípravných změn. Po úspěšném publikování prostředí se všechny konfigurace v přípravném stavu stanou efektivními.

  • Krok 1: Získání metadat prostředí

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

    V těle odpovědi můžete jasně zjistit stav prostředí. Než přejdete k dalšímu kroku, ujistěte se, že nedochází k probíhajícímu publikování.

  • Krok 2: Získání přípravných knihoven nebo výpočetních prostředků Sparku pro konečnou kontrolu

    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

Aktivace publikování prostředí

Změny provedené v pracovních knihovnách a výpočetních prostředcích Sparku se ukládají do mezipaměti, ale vyžadují, aby publikování bylo efektivní. Publikování aktivujte pomocí následujícího příkladu.

  • Ukázkový požadavek

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

  • Ukázková odpověď

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

Během publikování můžete také volat následující rozhraní API a zrušit ho.

  • Ukázkový požadavek

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

Související obsah