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

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.

Przenieś interfejsy API środowiska do stabilnej wersji GA

Ważne

Wersja ogólnie dostępna zawiera aktualizacje w umowie żądania/odpowiedzi istniejących interfejsów API, wycofywania interfejsów API i nowych interfejsów API. Szczegółowe informacje można znaleźć w poniższych sekcjach.
Wprowadzono nowy parametr beta zapytania, aby ułatwić proces wdrożenia zmian kontraktu żądań/odpowiedzi. Parametr beta zapytania jest domyślnie ustawiony na True do 31 marca 2026 r., dzięki czemu kontrakty wersji zapoznawczej pozostają dostępne. Ustaw wartość na False, aby rozpocząć korzystanie ze stabilnej wersji kontraktów.
Preview parametr zapytania został zastąpiony na beta. W przypadku zgodności z poprzednimi wersjami wersja zapoznawcza jest nadal obsługiwana i działa tak samo jak wersja beta.
Interfejsy API przeznaczone do wycofania będą nadal obsługiwane do 31 marca 2026 r., prosimy o użycie nowo wprowadzonych API, aby zastąpić je tak szybko, jak to możliwe.

API z aktualizacją kontraktów żądań/odpowiedzi

Kategoria	API	opis	Notatki	Wersja zapoznawcza programu Swagger	Wersja wydania programu Swagger
Działanie elementu	Publikowanie środowiska	Uruchom operację publikowania środowiska z oczekującymi zmianami.	Aktualizacja kontraktu dotyczącego odpowiedzi.	Środowisko publikowania (wersja zapoznawcza)	Środowisko publikacji
Staging	Lista bibliotek stagingowych	Pobierz pełną listę bibliotek przejściowych. Ta lista zawiera opublikowane i oczekujące biblioteki.	Aktualizacja kontraktu dotyczącego odpowiedzi.	Lista bibliotek stagingowych (wersja zapoznawcza)	Wyświetlanie listy bibliotek przejściowych
Staging	Lista tymczasowych zasobów obliczeniowych Spark	Uzyskaj pełne przejściowe konfiguracje obliczeniowe. Konfiguracje przejściowe obejmują opublikowane i oczekujące konfiguracje obliczeniowe.	Aktualizacja kontraktu dotyczącego odpowiedzi.	Lista obliczeń etapowych Spark (wersja zapoznawcza)	Lista zasobów obliczeniowych Spark w fazie przygotowania
Staging	Aktualizowanie obliczeń platformy Spark	Zaktualizuj konfiguracje obliczeniowe i właściwości platformy Spark dla środowiska.	Aktualizacja w kontraktach żądań i odpowiedzi.	Aktualizowanie obliczeń platformy Spark (wersja zapoznawcza)	Aktualizowanie obliczeń platformy Spark
Opublikowany	Lista opublikowanych bibliotek	Pobierz biblioteki, które są dostępne i działające w sesjach Spark.	Aktualizacja kontraktu dotyczącego odpowiedzi.	Wyświetlanie listy opublikowanych bibliotek (wersja zapoznawcza)	Lista opublikowanych bibliotek
Opublikowany	Lista opublikowanych obliczeń platformy Spark	Uzyskaj konfiguracje obliczeń platformy Spark i właściwości platformy Spark, które są publikowane i skuteczne w sesjach platformy Spark.	Aktualizacja kontraktu dotyczącego odpowiedzi.	Wyświetlanie listy opublikowanych bibliotek (wersja zapoznawcza)	Lista opublikowanych bibliotek

Do beta parametr domyślnie przyjmuje wartość True aż do 31 marca 2026 r., czyli system traktuje parametr jako True, jeśli żądanie jest wysyłane bez określenia tego parametru do dnia jego wycofania. Zdecydowanie zalecamy przeprowadzenie migracji implementacji do stabilnej wersji przez jawne ustawienie parametru beta tak False szybko, jak to możliwe.

Przykład użycia List staging libraries API, który zawiera aktualizację w odpowiedzi.

Podczas wysyłania żądania z parametrem beta jako True

Przykładowe żądanie:

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

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": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

Podczas wysyłania żądania z parametrem preview jako False

Przykładowe żądanie:

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

Przykładowa odpowiedź:

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

Interfejsy API planowane do wycofania

Ważne

Przestarzałe interfejsy API będą nadal obsługiwane do 31 marca 2026 r. Zdecydowanie zalecamy używanie nowo wprowadzonych interfejsów API w celu jak najszybszego zastąpienia implementacji.

Kategoria	API	opis	Uwaga
Staging	Przekazywanie bibliotek przygotowawczych	Dodaj jedną bibliotekę niestandardową lub jedną/wiele bibliotek publicznych w środowisku.	Pomoc techniczna do 31 marca 2026. Proszę użyć nowo wprowadzonych `Import external libraries`/`Upload custom library` interfejsów API w celu zastąpienia.
Staging	Usuwanie bibliotek przejściowych	Usuń jedną tymczasową bibliotekę niestandardową lub wszystkie biblioteki publiczne.	Pomoc techniczna do 31 marca 2026. Proszę użyć nowo wprowadzonych `Remove external library`/`Delete custom library` interfejsów API w celu zastąpienia.

Poniżej przedstawiono kilka przykładów obejmujących scenariusze zarządzania bibliotekami przejściowymi.

Dodaj biblioteki publiczne w swoim środowisku

Wcześniej możesz użyć interfejsu Upload staging libraries API do przekazania zaktualizowanego pliku YAML, a teraz możesz użyć Import external libraries interfejsu API do zaimportowania zaktualizowanego kodu YAML.
Usuwanie jednej biblioteki publicznej w środowisku

Wcześniej możesz użyć Upload staging libraries interfejsu API do przekazania zaktualizowanego pliku YAML, a teraz możesz go usunąć za pomocą Remove external library interfejsu API.
Usuń całą bibliotekę publiczną w swoim środowisku

Wcześniej można użyć Delete staging libraries interfejsu API do usunięcia wszystkich bibliotek publicznych, a teraz możesz użyć Remove external library interfejsu API, aby usunąć biblioteki publiczne po jednym lub użyć Import external libraries do przekazania pustego pliku YAML w celu osiągnięcia tych samych funkcji.

Nowe interfejsy API

Kategoria	API	opis	Uwaga
Działanie elementu	Tworzenie środowiska z definicją	Utwórz nowe środowisko z definicją.	Nowy interfejs API.
Działanie elementu	Pobieranie definicji środowiska	Pobierz definicję środowiska.	Nowy interfejs API.
Działanie elementu	Aktualizowanie definicji środowiska	Zaktualizuj definicję środowiska.	Nowy interfejs API.
Staging	Importowanie bibliotek zewnętrznych	Przekaż biblioteki zewnętrzne jako plik environment.yml do środowiska. Zastępuje listę istniejących bibliotek zewnętrznych w środowisku.	Nowy interfejs API.
Staging	Eksportowanie bibliotek zewnętrznych	Pobierz pełne biblioteki zewnętrzne jako plik environment.yml .	Nowy interfejs API.
Staging	Usuwanie biblioteki zewnętrznej	Usuń bibliotekę zewnętrzną ze środowiska. Ten interfejs API akceptuje jedną bibliotekę jednocześnie.	Nowy interfejs API.
Staging	Przesyłanie biblioteki niestandardowej	Załaduj pakiet niestandardowy do środowiska. Ten interfejs API umożliwia jednoczesne przekazywanie jednego pliku. Obsługiwane formaty plików to .jar, .py, .whl i .tar.gz.	Nowy interfejs API.
Staging	Usuń bibliotekę niestandardową	Usuń pakiet niestandardowy ze środowiska. Umieść pełną nazwę pakietu niestandardowego z rozszerzeniem w żądaniu interfejsu API, aby go usunąć.	Nowy interfejs API.
Opublikowany	Eksportowanie bibliotek zewnętrznych	Pobierz opublikowane biblioteki zewnętrzne jako plik environment.yml .	Nowy interfejs API.

Interfejsy API bez aktualizacji

Kategoria	API	opis
Działanie elementu	Tworzenie środowiska	Utwórz nowe puste środowisko w obszarze roboczym.
Działanie elementu	Pobierz środowisko	Pobieranie metadanych środowiska. Odpowiedź zawiera stan środowiska.
Działanie elementu	Usuń środowisko	Usuń istniejące środowisko.
Działanie elementu	Konfiguracja listy	Pobierz listę środowisk w obszarze roboczym.
Działanie elementu	Aktualizowanie środowiska	Zaktualizuj metadane środowiska, takie jak nazwa i opis.
Działanie elementu	Anulowanie środowiska publikowania	Anuluj bieżącą operację publikowania środowiska.

Aby dowiedzieć się więcej na temat publicznych interfejsów API środowiska, zobacz Interfejsy API elementów — środowisko.

Przypadki użycia publicznego interfejsu API środowiska

Ważne

W tej sekcji przedstawiono API w stabilnej wersji.

W tej sekcji pokazano, jak używać interfejsów API do osiągnięcia określonych scenariuszy podczas zarządzania środowiskiem. Możesz zastąpić właściwości {WORKSPACE_ID} i {ARTIFACT_ID} w poniższych przykładach odpowiednimi wartościami.

Utwórz nowe środowisko

Aby utworzyć nowe puste środowisko, użyj 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 do przesyłania i usuwania biblioteki staging umożliwiają zarządzanie działem bibliotecznym w środowisku.

Sprawdzanie opublikowanych bibliotek dla środowiska

Przed dodaniem lub usunięciem biblioteki użyj interfejsu API Pobierz opublikowane biblioteki, 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?beta=False

Przykładowa odpowiedź

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

Importowanie bibliotek publicznych lub przekazywanie biblioteki niestandardowej

Do dodawania nowych bibliotek publicznych i niestandardowych do środowiska można użyć interfejsów API Importowanie bibliotek zewnętrznych oraz Przekazywanie biblioteki niestandardowej. Interfejs API importowania bibliotek zewnętrznych akceptuje plik environment.yml , podczas gdy obsługiwane typy plików to .whl, .jar, .tar.gz, .py do przekazywania interfejsu API biblioteki niestandardowej.

Uwaga

Aby wydajniej manipulować biblioteką publiczną, zalecamy utworzenie wszystkich oczekiwanych bibliotek z PyPI i Conda w pliku environment.yml .

Interfejs API przesyłania umożliwia przesłanie pliku o rozmiarze do 200 MB w jednym żądaniu. Biblioteka, która przekracza ten limit rozmiaru, nie jest obecnie obsługiwana w publicznych interfejsach API.

Przykładowe żądania

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

Usuwanie biblioteki niestandardowej

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

Uwaga

Jeśli chcesz usunąć podzbiór istniejących bibliotek publicznych lub wszystkich z nich, zaimportuj zaktualizowany plik YAML za pośrednictwem Import public libraries interfejsu API.

Przykładowe żądania

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

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 użyj interfejsu API pobierania opublikowanych obliczeń 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?beta=False

Przykładowa odpowiedź

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

Aktualizowanie konfiguracji obliczeniowych

Możesz zaktualizować środowisko uruchomieniowe platformy Spark, przełączyć się do innej puli, uściślić konfigurację obliczeniową i dodać lub 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 niestandardowych pul obszaru roboczego według interfejsu API REST, zobacz Niestandardowe pule — lista pul niestandardowych obszaru roboczego.

Jeśli chcesz usunąć istniejącą właściwość platformy Spark, określ wartość tak, jak null w przypadku klucza, który chcesz usunąć.

Przykładowe żądanie

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

Wprowadzanie zmian w życie

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

Przygotowywanie do operacji publikowania

Środowisko może akceptować jedną operację publikowania naraz. Przed opublikowaniem środowiska zweryfikuj stan środowiska i dokonaj ostatecznego przeglądu 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 trwa żadna operacja publikowania.

Krok 2. Pobierz biblioteki przejściowe/zasoby obliczeniowe platformy Spark, aby zapoznać się z ostateczną recenzją.

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

Wyzwól operację publikowania środowiska

Zmiany wprowadzone w bibliotekach przejściowych i obliczeniach platformy Spark są buforowane, ale wymagają opublikowania, aby stały się skuteczne. Użyj następnego przykładu, aby wyzwolić operację publikowania. Odpowiedź jest następująca: wzorzec długotrwałych operacji (LRO), a kod odpowiedzi HTTP 202 może zostać zwrócony.

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Podczas operacji 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

Sprzężenie zwrotne

Czy ta strona była pomocna?

Last updated on 2025-11-21

Udostępnij przez

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

Przenieś interfejsy API środowiska do stabilnej wersji GA

API z aktualizacją kontraktów żądań/odpowiedzi

Interfejsy API planowane do wycofania

Nowe interfejsy API

Interfejsy API bez aktualizacji

Przypadki użycia publicznego interfejsu API środowiska

Utwórz nowe środowisko

Zarządzanie bibliotekami przejściowymi

Sprawdzanie opublikowanych bibliotek dla środowiska

Importowanie bibliotek publicznych lub przekazywanie biblioteki niestandardowej

Usuwanie biblioteki niestandardowej

Zarządzanie przejściowymi obliczeniami platformy Spark

Sprawdzanie opublikowanych obliczeń platformy Spark dla środowiska

Aktualizowanie konfiguracji obliczeniowych

Wprowadzanie zmian w życie

Przygotowywanie do operacji publikowania

Wyzwól operację publikowania środowiska

Powiązana zawartość

Sprzężenie zwrotne

Dodatkowe źródła