Správa prostredia prostredníctvom verejných rozhraní API

Rozhranie Microsoft Fabric REST API poskytuje koncový bod služby na vytváranie, čítanie, aktualizáciu a odstraňovanie operácií položky služby Fabric. Tento článok popisuje dostupné rozhrania REST API prostredia a ich používanie.

Migrácia rozhraní API prostredia na stabilnú verziu GA

Dôležité

Vydanie GA obsahuje aktualizácie v zmluve o požiadavke a odpovedi existujúcich rozhraní API, zastarané rozhrania API a nové rozhrania API. Podrobnosti nájdete v nasledujúcich častiach.
Zavádza sa nový parameter beta dotazu na uľahčenie prechodu zmien zmlúv o požiadavke/odpovedi. Parameter beta dotazu je predvolene nastavený True do 31. marca 2026, takže zmluvy Preview sú stále k dispozícii. Nastavte hodnotu na False , aby ste mohli začať používať stabilnú verziu vydania zmlúv.
PreviewParameter dotazu bol nahradený .beta Pre spätnú kompatibilitu je náhľad stále podporovaný a správa sa rovnako ako beta.
to-bezastarané rozhrania API budú naďalej podporované do 31. marca 2026, použite novo zavedené rozhrania API na ich nahradenie čo najskôr.

API s aktualizáciou zmluvy o požiadavke/odpovedi

Kategória	API	Popis	Poznámky	Ukážka verzie swagger	Vydanie verzie swagger
Operácia položky	Publikovanie prostredia	Spustite operáciu publikovania prostredia s aktuálnymi čakajúcimi zmenami.	Aktualizácia v zmluve o odpovedi.	Publikačné prostredie (Preview)	Publikačné prostredie
Inscenácia	Zoznam fázových knižníc	Získajte úplný zoznam knižníc na pracovnej obrazovke. Tento zoznam obsahuje publikované a čakajúce knižnice.	Aktualizácia v zmluve o odpovedi.	Zoznam pracovných knižníc (ukážka)	Zoznam pracovných knižníc
Inscenácia	Príprava zoznamu výpočtových prostriedkov Spark	Získajte úplné fázové výpočtové konfigurácie. Fázové konfigurácie zahŕňajú publikované a čakajúce výpočtové konfigurácie.	Aktualizácia v zmluve o odpovedi.	Príprava zoznamu výpočtových prostriedkov Spark (ukážka)	Príprava zoznamu výpočtových prostriedkov Spark
Inscenácia	Aktualizácia výpočtových prostriedkov Spark	Aktualizujte konfigurácie výpočtov a vlastnosti Sparku pre prostredie.	Aktualizácia zmlúv o požiadavkách a odpovediach.	Aktualizácia výpočtových prostriedkov Spark (ukážka)	Aktualizácia výpočtových prostriedkov Spark
Publikované	Zoznam publikovaných knižníc	Získajte knižnice, ktoré sú publikované a účinné v reláciách Spark.	Aktualizácia v zmluve o odpovedi.	Zoznam publikovaných knižníc (ukážka)	Zoznam publikovaných knižníc
Publikované	Zoznam publikovaných výpočtov Spark	Získajte konfigurácie výpočtovej služby Spark a vlastnosti Spark, ktoré sú publikované a účinné v reláciách Spark.	Aktualizácia v zmluve o odpovedi.	Zoznam publikovaných knižníc (ukážka)	Zoznam publikovaných knižníc

Predvolené beta nastavenie parametra je True do 31. marca 2026, t. j. systém považuje parameter za True odosielajúci požiadavku bez zadania tohto parametra až do dátumu zastarania. Dôrazne odporúčame migrovať implementácie na stabilnú verziu explicitným nastavením parametra beta na čo False najskôr.

Ako príklad použijeme List staging libraries API, ktoré má aktualizáciu v odpovedi API.

Pri odoslaní požiadavky s parametrom beta ako True

Vzorová žiadosť:

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

Príklad odpovede:

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

Pri odoslaní požiadavky s parametrom preview ako False

Vzorová žiadosť:

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

Príklad odpovede:

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

Zastarané rozhrania API

Dôležité

Zastarané rozhrania API to-bebudú naďalej podporované do 31. marca 2026. Dôrazne odporúčame použiť novo zavedené API na nahradenie implementácií čo najskôr.

Kategória	API	Popis	Poznámka
Inscenácia	Nahrávanie pracovných knižníc	Pridajte do prostredia jednu vlastnú knižnicu alebo jednu/viacero verejných knižníc.	Podpora do 31. marca 2026, na výmenu použite novo zavedené `Import external libraries`/`Upload custom library` API.
Inscenácia	Odstránenie pracovných knižníc	Odstráňte jednu vlastnú knižnicu alebo všetky verejné knižnice.	Podpora do 31. marca 2026, na výmenu použite novo zavedené `Remove external library`/`Delete custom library` API.

Nižšie uvádzame niekoľko príkladov pokrývajúcich scenáre pri správe prípravných knižníc.

Pridanie verejných knižníc do prostredia

Predtým ste mohli pomocou Upload staging libraries rozhrania API nahrať aktualizovaný súbor YAML a teraz môžete použiť Import external libraries API na import aktualizovaného súboru YAML.
Odstránenie jednej verejnej knižnice vo vašom prostredí

Predtým ste mohli použiť Upload staging libraries API na nahranie aktualizovaného súboru YAML a teraz ho môžete odstrániť pomocou Remove external library rozhrania API.
Odstránenie všetkých verejných knižníc vo vašom prostredí

Predtým ste mohli použiť Delete staging libraries API na odstránenie všetkých verejných knižníc a teraz môžete použiť Remove external library API na odstránenie verejných knižníc jednu po druhej alebo použiť Import external libraries na nahranie prázdneho súboru YAML, aby ste dosiahli rovnaké funkcie.

Nové rozhrania API

Kategória	API	Popis	Poznámka
Operácia položky	Vytvorenie prostredia s definíciou	Vytvorte nové prostredie s definíciou.	Nové API.
Operácia položky	Získanie definície prostredia	Získajte definíciu prostredia.	Nové API.
Operácia položky	Definícia prostredia aktualizácie	Aktualizujte definíciu prostredia.	Nové API.
Inscenácia	Import externých knižníc	Nahrajte externé knižnice ako environment.yml súbor do prostredia. Prepíše zoznam existujúcich externých knižníc v prostredí.	Nové API.
Inscenácia	Export externých knižníc	Získajte úplné externé knižnice ako súbor environment.yml .	Nové API.
Inscenácia	Odstránenie externej knižnice	Odstránenie externej knižnice z prostredia. Toto API akceptuje jednu knižnicu naraz.	Nové API.
Inscenácia	Nahrať vlastnú knižnicu	Nahrajte vlastný balík v prostredí. Toto rozhranie API umožňuje nahrávanie jedného súboru po jednom. Podporované formáty súborov sú .jar, .py, .whl a .tar.gz.	Nové API.
Inscenácia	Odstránenie vlastnej knižnice	Odstránenie vlastného balíka z prostredia. Vložte vlastný balík s celým názvom s rozšírením do požiadavky rozhrania API, aby ste ho odstránili.	Nové API.
Publikované	Export externých knižníc	Získajte publikované externé knižnice ako súbor environment.yml .	Nové API.

API bez aktualizácie

Kategória	API	Popis
Operácia položky	Vytvorenie prostredia	Vytvorte v pracovnom priestore nové prázdne prostredie.
Operácia položky	Získajte prostredie	Získajte metaúdaje prostredia. Odpoveď obsahuje stav prostredia.
Operácia položky	Odstrániť prostredie	Odstrániť existujúce prostredie.
Operácia položky	Prostredie zoznamu	Získajte zoznam prostredí v pracovnom priestore.
Operácia položky	Aktualizácia prostredia	Aktualizujte metaúdaje prostredia, ako sú napríklad názov a popis.
Operácia položky	Zrušiť publikačné prostredie	Zrušte prebiehajúcu operáciu publikovania prostredia.

Ďalšie informácie o verejných rozhraniach API prostredia nájdete v téme Rozhrania API položiek – Prostredie.

Prípady použitia verejného rozhrania API prostredia

Dôležité

Táto časť je demonštrovaná so stabilnou verziou vydania API.

Táto časť ukazuje, ako používať rozhrania API na dosiahnutie konkrétnych scenárov pri správe prostredia. Vlastnosti {WORKSPACE_ID} a {ARTIFACT_ID} v nasledujúcich príkladoch môžete nahradiť príslušnými hodnotami.

Vytvorenie nového prostredia

Ak chcete vytvoriť nové prázdne prostredie, použite nasledujúce rozhranie API.

Vzorová požiadavka

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

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

Spravovanie fázových knižníc

Na správu sekcie knižnice v prostredí môžete použiť rozhrania API nahrávania a odstraňovania prípravných knižníc.

Kontrola publikovaných knižníc pre prostredie

Pred pridaním alebo odstránením knižnice skontrolujte, ktoré knižnice sú momentálne účinné, pomocou rozhrania API na získanie publikovaných knižníc.

Vzorová požiadavka

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

Vzorová odpoveď

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

Import verejných knižníc alebo nahratie vlastnej knižnice

Na pridanie nových verejných/vlastných knižníc do prostredia môžete použiť rozhrania API Import externých knižníc a Nahrať vlastné knižnice . Rozhranie API importu externých knižníc akceptuje environment.yml súbor, zatiaľ čo podporované typy súborov sú .whl, .jar, .tar.gz.py pre nahratie vlastného rozhrania API knižnice.

Poznámka

Ak chcete efektívnejšie manipulovať s verejnou knižnicou, odporúčame vám zostaviť všetky očakávané knižnice z PyPI a Conda do environment.yml súboru.

Rozhranie API na nahrávanie umožňuje až 200 MB súbor v jednej požiadavke. Knižnica, ktorá prekračuje tento limit veľkosti, nie je momentálne podporovaná vo verejných rozhraniach API.

Vzorové požiadavky

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

Odstránenie vlastnej knižnice

Zadaním úplného názvu súboru knižnice s príponou typu môžete naraz odstrániť jednu vlastnú knižnicu.

Poznámka

Ak chcete odstrániť podmnožinu existujúcich verejných knižníc alebo ich všetky, importujte aktualizovaný súbor YAML prostredníctvom Import public libraries rozhrania API.

Vzorové požiadavky

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

Správa pracovnej verzie Spark compute

Ak chcete spravovať výpočet Spark, môžete použiť aktualizovať fázu spark compute.

Skontrolujte publikované výpočty služby Spark pre prostredie

Pred zmenou konfigurácií prostredia použite rozhranie API na získanie publikovaného výpočtového rozhrania Spark a skontrolujte, ktoré konfigurácie výpočtov Spark sú momentálne účinné.

Vzorová požiadavka

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

Vzorová odpoveď

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

Aktualizácia konfigurácií výpočtových

Modul runtime Spark, prepnúť do iného fondu, spresniť konfiguráciu výpočtov a pridať alebo odstrániť vlastnosti Spark prostredníctvom úpravy tela požiadavky tohto rozhrania API.

Pripojený fond môžete prepnúť zadaním názvu fondu a fondu. Zadajte názov fondu, ktorý Starter Pool sa má prepnúť z fondu na predvolené nastavenia. Ak chcete získať úplný zoznam dostupných vlastných fondov pracovného priestoru pomocou rozhrania REST API, pozrite si tému Vlastné fondy – zoznam vlastných fondov pracovného priestoru.

Ak chcete odstrániť existujúcu vlastnosť Spark, zadajte hodnotu ako null pri kľúči, ktorý chcete odstrániť.

Vzorová požiadavka

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

Efektívnenie zmien

Na publikovanie zmien použite nasledujúce množiny rozhraní API.

Príprava na operáciu publikovania

Prostredie môže akceptovať jednu operáciu publikovania naraz. Pred publikovaním prostredia overte stav prostredia a vykonajte záverečnú kontrolu pracovných zmien. Po úspešnom publikovaní prostredia sa všetky konfigurácie v pracovnom stave stanú účinnými.

1. krok: Získajte metadáta prostredia.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
V tele odpovede môžete jasne zistiť stav prostredia. Pred prechodom na ďalší krok sa uistite, že neprebieha žiadna operácia publikovania.

2. krok: Získajte prípravné knižnice/výpočty Spark, aby ste mali záverečnú kontrolu.

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

Spustenie operácie publikovania prostredia

Zmeny, ktoré ste vykonali pre pracovné knižnice a výpočty Sparku, sa ukladajú do vyrovnávacej pamäte, ale na to, aby sa prejavili, vyžadujú publikovanie. Na spustenie operácie publikovania použite nasledujúci príklad. Odpoveď sa uvádza po vzore dlhotrvajúcich operácií (LRO) a môže sa vrátiť kód odpovede HTTP 202.

Vzorová požiadavka

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

Vzorová odpoveď

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

Počas operácie publikovania môžete tiež zavolať nasledujúce rozhranie API a zrušiť ho.

Vzorová požiadavka

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

Pripomienky

Bola táto stránka užitočná?

Last updated on 2025-10-09

Zdieľať cez

Správa prostredia prostredníctvom verejných rozhraní API

Migrácia rozhraní API prostredia na stabilnú verziu GA

API s aktualizáciou zmluvy o požiadavke/odpovedi

Zastarané rozhrania API

Nové rozhrania API

API bez aktualizácie

Prípady použitia verejného rozhrania API prostredia

Vytvorenie nového prostredia

Spravovanie fázových knižníc

Kontrola publikovaných knižníc pre prostredie

Import verejných knižníc alebo nahratie vlastnej knižnice

Odstránenie vlastnej knižnice

Správa pracovnej verzie Spark compute

Skontrolujte publikované výpočty služby Spark pre prostredie

Aktualizácia konfigurácií výpočtových

Efektívnenie zmien

Príprava na operáciu publikovania

Spustenie operácie publikovania prostredia

Súvisiaci obsah

Pripomienky

Ďalšie zdroje informácií