Hantera miljön via offentliga API:er

Artikel
07/17/2024

Rest-API:et för Microsoft Fabric tillhandahåller en tjänstslutpunkt för crud-åtgärder (create, read, update och delete) för ett fabric-objekt. I den här artikeln beskrivs de tillgängliga REST-API:erna för miljön och deras användning.

Viktigt!

Den här funktionen är i förhandsversion.

Sammanfattning av tillgängliga miljö-API:er

API	beskrivning	Kategori
Skapa miljö	Skapa en ny miljö på arbetsytan.	Allmänt
Hämta miljö	Hämta metadata för en miljö. Svaret innehåller status för miljön.	Allmänt
Uppdatera miljö	Uppdatera metadata för en miljö, till exempel namn och beskrivning.	Allmänt
Radera miljö	Ta bort en befintlig miljö.	Allmänt
Lista miljö på arbetsyta	Hämta listan över miljöer på en arbetsyta.	Allmänt
Publicera miljö	Utlös publiceringen av miljön med aktuella väntande ändringar.	Allmänt
Publicera annullering	Avbryt en pågående publicering av miljön	Allmänt
Hämta publicerad Spark-beräkning	Hämta Spark-beräkningskonfigurationerna som är effektiva.	Spark-beräkning
Hämta Spark-mellanlagringsberäkning	Hämta de fullständiga beräkningskonfigurationerna för mellanlagring. Mellanlagringskonfigurationerna omfattar de publicerade och väntande beräkningskonfigurationerna.	Spark-beräkning
Hämta publicerade bibliotek	Hämta den bibliotekslista som är effektiv.	Bibliotek
Hämta mellanlagringsbibliotek	Hämta den fullständiga mellanlagringsbibliotekslistan. Den här listan innehåller de publicerade och väntande biblioteken.	Bibliotek
Ladda upp mellanlagringsbibliotek	Lägga till ett anpassat bibliotek eller ett/flera offentliga bibliotek i miljön.	Bibliotek
Ta bort mellanlagringsbibliotek	Ta bort ett anpassat mellanlagringsbibliotek eller ett offentligt bibliotek.	Bibliotek

Läs mer om offentliga API:er för miljön i objekt-API:er – miljö

Användningsfall för offentliga API:ar för miljön

Det här avsnittet beskriver flera vanliga scenarier när du hanterar miljön. Du kan ersätta {WORKSPACE_ID} och {ARTIFACT_ID} i följande exempel med lämpliga värden.

Skapa en ny miljö

Du kan skapa en ny tom miljö med hjälp av följande API.

Exempelbegäran

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

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

Hantera mellanlagringsbibliotek

Du kan använda API:erna för att ladda upp/ta bort mellanlagringsbibliotek för att hantera biblioteksavsnittet i miljön

Kontrollera de publicerade biblioteken för miljön

Innan du lägger till/tar bort biblioteket kan du använda API:et hämta publicerade bibliotek för att kontrollera vilka bibliotek som för närvarande är effektiva.

Exempelbegäran

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

Exempelsvar

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

Ladda upp biblioteken

API:et för att ladda upp mellanlagringsbiblioteket accepterar en fil i taget. Filtyperna som stöds är .whl, .jar, .tar.gz, .py och environment.yml för offentligt bibliotek. Du kan ange filen via innehållstypen multipart/form-data.

Kommentar

För att kunna ändra det offentliga biblioteket mer effektivt rekommenderar vi starkt att du skapar alla förväntade bibliotek från PyPI och conda i en environment.yml fil.
Uppladdnings-API:et tillåter upp till 200 MB fil i en begäran, bibliotek som överskrider den här storleksgränsen stöds för närvarande inte i offentligt API.

Exempelbegäranden

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

Ta bort biblioteken

Genom att ange det fullständiga biblioteksfilnamnet med typsuffixet kan du ta bort ett bibliotek i taget.

Kommentar

Om du anger environment.yml som den fil som ska tas bort tar du bort alla offentliga bibliotek.
Om du vill ta bort en delmängd av det befintliga offentliga biblioteket använder du uppladdningsbiblioteket i stället och laddar upp en environment.yml som endast innehåller de förväntade biblioteken. Den uppladdade environment.yml ersätter det befintliga offentliga biblioteksavsnittet helt och hållet.

Exempelbegäranden

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

Hantera mellanlagring av Spark-beräkning

Du kan använda spark-beräkningen för uppdatering mellanlagring för att hantera Spark-beräkningen.

Kontrollera den publicerade Spark-beräkningen för miljön

Innan du ändrar konfigurationerna för miljön kan du använda det get-publicerade Spark-beräknings-API:et för att kontrollera vilka Spark-beräkningskonfigurationer som för närvarande är effektiva.

Exempelbegäran

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

Exempelsvar

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

Uppdatera beräkningskonfigurationerna

Du kan uppdatera Spark-körningen, växla till en annan pool, förfina beräkningskonfigurationen och lägga till/ta bort Spark-egenskaper genom att redigera begärandetexten i det här API:et.

Du kan växla den anslutna poolen genom att ange poolnamnet och poolen. Ange poolnamnet för Starter Pool att växla poolen till standardinställningarna. Information om hur du hämtar en fullständig lista över tillgängliga anpassade pooler för arbetsytan via REST API finns i Anpassade pooler – Lista anpassade pooler för arbetsyta

Om du vill ta bort en befintlig Spark-egenskap måste du ange värdet som null med den nyckel som du vill ta bort, som du ser i följande exempel.

Exempelbegäran

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

Gör ändringarna gällande

Använd följande uppsättningar API:er för att publicera ändringarna.

Förbereda för en publicering

Miljön kan acceptera en publicering i taget. Innan du publicerar din miljö kan du verifiera miljöns status och ha en slutlig granskning av mellanlagringsändringarna. När miljön har publicerats blir alla konfigurationer i mellanlagringstillståndet effektiva.

Steg 1: Hämta metadata för miljön
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
I svarstexten kan du tydligt se miljöns tillstånd. Kontrollera att det inte finns någon pågående publicering innan du går vidare till nästa steg.

Steg 2: Hämta mellanlagringsbibliotek/Spark-beräkning för att få en slutlig granskning

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

Utlös publiceringen av miljön

De ändringar du har gjort i mellanlagringsbiblioteken och Spark-beräkningen cachelagras men kräver att publiceringen träder i kraft. Följ följande exempel för att utlösa publiceringen.

Exempelbegäran

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

Exempelsvar

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

Under publiceringen kan du även anropa följande API för att avbryta det.

Exempelbegäran

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

Dela via

Hantera miljön via offentliga API:er

Sammanfattning av tillgängliga miljö-API:er

Användningsfall för offentliga API:ar för miljön

Skapa en ny miljö

Hantera mellanlagringsbibliotek

Kontrollera de publicerade biblioteken för miljön

Ladda upp biblioteken

Ta bort biblioteken

Hantera mellanlagring av Spark-beräkning

Kontrollera den publicerade Spark-beräkningen för miljön

Uppdatera beräkningskonfigurationerna

Gör ändringarna gällande

Förbereda för en publicering

Utlös publiceringen av miljön

Feedback

Ytterligare resurser

Dela via

Hantera miljön via offentliga API:er

Sammanfattning av tillgängliga miljö-API:er

Användningsfall för offentliga API:ar för miljön

Skapa en ny miljö

Hantera mellanlagringsbibliotek

Kontrollera de publicerade biblioteken för miljön

Ladda upp biblioteken

Ta bort biblioteken

Hantera mellanlagring av Spark-beräkning

Kontrollera den publicerade Spark-beräkningen för miljön

Uppdatera beräkningskonfigurationerna

Gör ändringarna gällande

Förbereda för en publicering

Utlös publiceringen av miljön

Relaterat innehåll

Feedback

Ytterligare resurser