Udostępnij za pośrednictwem

Zarządzanie środowiskiem za pomocą publicznych interfejsów API

  • Artykuł

Interfejs API REST usługi Microsoft Fabric udostępnia punkt końcowy usługi dla operacji tworzenia, odczytu, aktualizowania i usuwania (CRUD) elementu sieci szkieletowej. W tym artykule opisano dostępne interfejsy API REST środowiska i ich użycie.

Ważne

Ta funkcja jest dostępna w wersji zapoznawczej.

Podsumowanie dostępnych interfejsów API środowiska

Interfejs API opis Kategoria
Tworzenie środowiska Utwórz nowe środowisko w obszarze roboczym. Ogólne
Uzyskiwanie środowiska Pobieranie metadanych środowiska. Odpowiedź zawiera stan środowiska. Ogólne
Aktualizowanie środowiska Zaktualizuj metadane środowiska, takie jak nazwa i opis. Ogólne
Usuwanie środowiska Usuń istniejące środowisko. Ogólne
Wyświetlanie listy środowisk w obszarze roboczym Pobierz listę środowiska w obszarze roboczym. Ogólne
Publikowanie środowiska Wyzwól publikowanie środowiska z bieżącymi oczekującymi zmianami. Ogólne
Anulowanie publikowania Anulowanie trwającego publikowania środowiska Ogólne
Pobieranie opublikowanych obliczeń platformy Spark Uzyskaj efektywne konfiguracje obliczeń platformy Spark. Obliczenia platformy Spark
Uzyskiwanie przejściowych zasobów obliczeniowych platformy Spark Uzyskaj pełne przejściowe konfiguracje obliczeniowe. Konfiguracje przejściowe obejmują opublikowane i oczekujące konfiguracje obliczeniowe. Obliczenia platformy Spark
Pobieranie opublikowanych bibliotek Pobierz listę bibliotek obowiązującą. Biblioteki
Pobieranie bibliotek przejściowych Pobierz pełną listę bibliotek przejściowych. Ta lista zawiera opublikowane i oczekujące biblioteki. Biblioteki
Przekazywanie bibliotek przejściowych Dodawanie jednej biblioteki niestandardowej lub jednej/wielu bibliotek publicznych w środowisku. Biblioteki
Usuwanie bibliotek przejściowych Usuń jedną tymczasową bibliotekę niestandardową lub całą bibliotekę publiczną. Biblioteki

Dowiedz się więcej na temat publicznych interfejsów API środowiska w interfejsach API elementów — środowisko

Przypadki użycia publicznego interfejsu API środowiska

W tej sekcji przedstawiono kilka typowych scenariuszy pracy ze środowiskiem. Możesz zastąpić wartości i {WORKSPACE_ID} {ARTIFACT_ID} w poniższych przykładach odpowiednimi wartościami.

Utwórz nowe środowisko

Nowe puste środowisko można utworzyć przy użyciu następującego interfejsu API.

  • Przykładowe żądanie

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

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

Zarządzanie bibliotekami przejściowymi

Interfejsy API przekazywania/usuwania bibliotek przejściowych umożliwiają zarządzanie sekcją biblioteki w środowisku

Sprawdzanie opublikowanych bibliotek dla środowiska

Przed dodaniem/usunięciem biblioteki możesz użyć interfejsu API pobierania bibliotek opublikowanych, aby sprawdzić, które biblioteki są obecnie skuteczne.

  • Przykładowe żądanie

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

  • Przykładowa odpowiedź

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

Przekazywanie bibliotek

Interfejs API do przekazywania biblioteki przejściowej akceptuje jeden plik jednocześnie. Obsługiwane typy plików to .whl, .jar, .tar.gz, .py i environment.yml dla biblioteki publicznej. Plik można określić za pomocą typu zawartości multipart/form-data.

Uwaga

  • Aby wydajniej manipulować biblioteką publiczną, zdecydowanie zaleca się tworzenie wszystkich oczekiwanych bibliotek z PyPI i conda w pliku environment.yml.
  • Interfejs API przekazywania umożliwia maksymalnie 200 MB pliku w jednym żądaniu, biblioteka, która przekracza ten limit rozmiaru, nie jest obecnie obsługiwana w publicznym interfejsie API.

  • Przykładowe żądania

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

Usuwanie bibliotek

Określając pełną nazwę pliku biblioteki z sufiksem typu, można jednocześnie usunąć jedną bibliotekę.

Uwaga

  • Jeśli określisz environment.yml plik do usunięcia, usuwasz wszystkie biblioteki publiczne.
  • Jeśli chcesz usunąć podzbiór istniejącej biblioteki publicznej, użyj zamiast tego biblioteki przekazywania i przekaż environment.yml , która zawiera tylko oczekiwane biblioteki. Przekazana environment.yml całkowicie zastępuje istniejącą sekcję biblioteki publicznej.

  • Przykładowe żądania

    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

Zarządzanie przejściowymi obliczeniami platformy Spark

Aby zarządzać obliczeniami platformy Spark na platformie Spark, możesz użyć przejściowego środowiska obliczeniowego platformy Spark.

Sprawdzanie opublikowanych obliczeń platformy Spark dla środowiska

Przed zmianą konfiguracji środowiska możesz użyć opublikowanego interfejsu API obliczeniowego platformy Spark, aby sprawdzić, jakie konfiguracje obliczeniowe platformy Spark są obecnie skuteczne.

  • Przykładowe żądanie

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

  • Przykładowa odpowiedź

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

Aktualizowanie konfiguracji obliczeniowych

Możesz zaktualizować środowisko uruchomieniowe platformy Spark, przełączyć się do innej puli, uściślić konfigurację obliczeniową i dodać/usunąć właściwości platformy Spark, edytując treść żądania tego interfejsu API.

Dołączoną pulę można przełączyć, określając nazwę puli i pulę. Określ nazwę puli, Starter Pool aby przełączyć pulę na ustawienia domyślne. Aby uzyskać pełną listę dostępnych pul niestandardowych obszaru roboczego według interfejsu API REST, zobacz Niestandardowe pule — wyświetlanie listy pul niestandardowych obszaru roboczego

Jeśli chcesz usunąć istniejącą właściwość platformy Spark, musisz określić wartość tak jak null w przypadku klucza, który chcesz usunąć, jak pokazano w poniższym przykładzie.

  • Przykładowe żądanie

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

Wprowadzanie zmian w życie

Aby opublikować zmiany, użyj następujących zestawów interfejsów API.

Przygotowanie do opublikowania

Środowisko może akceptować jedną publikację naraz. Przed opublikowaniem środowiska możesz zweryfikować stan środowiska i przeprowadzić ostateczną recenzję zmian przejściowych. Po pomyślnym opublikowaniu środowiska wszystkie konfiguracje w stanie przejściowym staną się skuteczne.

  • Krok 1. Pobieranie metadanych środowiska

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

    W treści odpowiedzi można wyraźnie określić stan środowiska. Przed przejściem do następnego kroku upewnij się, że nie ma trwającego publikowania.

  • Krok 2. Pobranie bibliotek przejściowych/zasobów obliczeniowych platformy Spark w celu uzyskania ostatecznego przeglądu

    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

Wyzwalanie publikowania środowiska

Zmiany wprowadzone w bibliotekach przejściowych i obliczeniach platformy Spark są buforowane, ale wymagają, aby publikowanie stało się skuteczne. Postępuj zgodnie z poniższym przykładem, aby wyzwolić publikowanie.

  • Przykładowe żądanie

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

  • Przykładowa odpowiedź

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

Podczas publikowania możesz również wywołać następujący interfejs API, aby go anulować.

  • Przykładowe żądanie

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

Powiązana zawartość