Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
A Microsoft Fabric REST API szolgáltatásvégpontot biztosít egy Fabric elem létrehozási, olvasási, frissítési és törlési (CRUD) műveleteihez. Ez a cikk a rendelkezésre álló környezeti REST API-kat és azok használatát ismerteti.
A környezeti API-k migrálása a stabil GA-verzióra
Fontos
- A GA-kiadás frissítéseket tartalmaz a meglévő API-k kérési/válaszszerződésében, az API-k elavulásaiban és az új API-kban. A részleteket a következő szakaszokban találja.
- Új lekérdezési paramétert
betavezetünk be a kérelem/válasz szerződésváltozások egyszerűbb átmenete érdekében. AbetalekérdezésiTrueparaméter alapértelmezés szerint 2026. augusztus 31-ig tart, így az előzetes verziójú szerződések továbbra is elérhetők maradnak. Állítsa az értéketFalse-re, hogy elkezdje a szerződések stabil kiadási verziójának használatát. -
PreviewA lekérdezési paramétert a következő váltottabetafel: . A visszamenőleges kompatibilitás érdekében az előzetes verzió továbbra is támogatott, és ugyanúgy működik, mint a bétaverzió. - A hamarosan elavult API-k 2026. augusztus 31-ig továbbra is támogatottak lesznek, ezért kérjük, a lehető leghamarabb használja az újonnan bevezetett API-kat a helyettesítésükre.
API-k kérelem-/válaszszerződés frissítésével
| Kategória | API | Leírás | Jegyzetek | Előzetes verzió Swagger | Kiadási verzió Swagger |
|---|---|---|---|---|---|
| Tételművelet | Közzétételi környezet | A függőben lévő aktuális módosításokkal indítsa el a környezet közzétételi műveletét. | Frissítés a válaszszerződésben. | Közzétételi környezet (előzetes verzió) | Közzétételi környezet |
| Előkészítés | Tesztelési könyvtárak listázása | Szerezze be az előkészítési tár teljes listáját. Ez a lista tartalmazza a közzétett és függőben lévő kódtárakat. | Frissítés a válaszszerződésben. | Átmeneti kódtárak listázása (előzetes verzió) | Átmeneti kódtárak listázása |
| Előkészítés | Átmeneti Spark-számítás listázása | Szerezze be a teljes előkészítési számítási konfigurációt. Az előkészítési konfigurációk közé tartoznak a közzétett és függőben lévő számítási konfigurációk. | Frissítés a válaszszerződésben. | Átmeneti Spark-számítás listázása (előzetes verzió) | Átmeneti Spark-számítás listázása |
| Előkészítés | Spark-számítás frissítése | A környezet számítási konfigurációinak és Spark-tulajdonságainak frissítése. | Frissítés a kérelem- és válaszszerződésekben. | Spark-számítás frissítése (előzetes verzió) | Spark-számítás frissítése |
| Közzétett | Közzétett könyvtárak listája | Szerezze be a Spark-munkamenetekben közzétett és érvényes kódtárakat. | Frissítés a válaszszerződésben. | Közzétett kódtárak listázása (előzetes verzió) | Közzétett könyvtárak listája |
| Közzétett | Közzétett Spark-számítások listája | Szerezze be a Spark-munkamenetekben közzétett és hatályos Spark számítási konfigurációkat és Spark-tulajdonságokat. | Frissítés a válaszszerződésben. | Közzétett kódtárak listázása (előzetes verzió) | Közzétett könyvtárak listája |
A beta paraméter alapértelmezett értéke True lesz 2026. augusztus 31-ig, azaz a rendszer úgy tekinti a paramétert, mintha True lenne, ha a kérés a paraméter megadása nélkül kerül elküldésre az elavulási dátumig. Erősen javasoljuk, hogy az implementációkat mielőbb migrálja a stabil verzióra úgy, hogy kifejezetten beállítja a beta paramétert False-re.
A List staging libraries API használata példaként, amelyben frissítés történt az API-válaszban.
Amikor a kérést
betaparaméterrelTrueküldi elMinta iránti kérelem:
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=TrueMintaválasz:
{ "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" }Amikor a kérést
previewparaméterrelFalseküldi elMinta iránti kérelem:
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=FalseMintaválasz:
{ "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" }
Tervezett elavult API-k
Fontos
- A funkcióvesztetté váló API-k 2026. augusztus 31-ig továbbra is támogatottak lesznek. Ajánlott a már bevezetett új API-k használata, hogy a lehető leghamarabb lecserélje a saját megvalósításait.
| Kategória | API | Leírás | Feljegyzés |
|---|---|---|---|
| Előkészítés | Tesztkörnyezet könyvtárainak feltöltése | Adjon hozzá egy egyéni vagy egy/több nyilvános könyvtárat a környezethez. | A támogatás 2026. augusztus 31-ig tart, kérjük, az újonnan bevezetett Import external libraries/ API-k használatát alkalmazza helyette. |
| Előkészítés | Átmeneti kódtárak törlése | Töröljön egy átmeneti egyéni tárat vagy az összes nyilvános tárat. | A támogatás 2026. augusztus 31-ig tart, kérjük, az újonnan bevezetett Remove external library/ API-k használatát alkalmazza helyette. |
Az alábbiakban bemutatunk néhány példát az előkészítési kódtárak kezelésével kapcsolatos forgatókönyvekre.
Nyilvános könyvtárak hozzáadása a környezetedbe
Korábban az API-val
Upload staging librariesfeltöltheti a frissített YAML-fájlt, most pedig az API-valImport external librariesimportálhatja a frissített YAML-fájlt.Töröljön egy nyilvános könyvtárat a környezetében
Korábban az API-val
Upload staging librariesfeltöltheti a frissített YAML-fájlt, és most már az API-valRemove external libraryis eltávolíthatja.Az összes nyilvános könyvtár törlése a környezetében
Korábban az API-val
Delete staging librariestörölheti az összes nyilvános kódtárat, most pedig az API-valRemove external libraryegyenként távolíthatja el a nyilvános kódtárakat, vagyImport external librariesfeltölthet egy üres YAML-fájlt ugyanazon funkciók eléréséhez.
Új API-k
| Kategória | API | Leírás | Feljegyzés |
|---|---|---|---|
| Tételművelet | Környezet létrehozása definícióval | Hozzon létre egy új környezetet definícióval. | Új API. |
| Tételművelet | Környezetdefiníció lekérése | A környezet definíciójának lekérése. | Új API. |
| Tételművelet | Környezetdefiníció frissítése | Frissítse a környezet definícióját. | Új API. |
| Előkészítés | Külső kódtárak importálása | Külső kódtárak feltöltése environment.yml fájlként a környezetbe. Felülbírálja a környezetben meglévő külső kódtárak listáját. | Új API. |
| Előkészítés | Külső kódtárak exportálása | Kérje le a teljes külső kódtárat environment.yml fájlként. | Új API. |
| Előkészítés | Külső kódtár eltávolítása | Külső kódtár törlése egy környezetből. Ez az API egyszerre egy kódtárat fogad el. | Új API. |
| Előkészítés | Egyéni tár feltöltése | Egyéni csomag feltöltése a környezetbe. Ez az API egyszerre egy fájlfeltöltést tesz lehetővé. A támogatott fájlformátumok a következők: .jar, .py, .whl és .tar.gz. | Új API. |
| Előkészítés | Egyéni tár törlése | Egyéni csomag törlése a környezetből. Helyezze az egyéni csomag teljes nevét a kiterjesztéssel együtt az API-kérésbe, hogy eltávolítsa. | Új API. |
| Közzétett | Külső kódtárak exportálása | Kérje le a közzétett külső kódtárakat environment.yml fájlként. | Új API. |
API-k frissítés nélkül
| Kategória | API | Leírás |
|---|---|---|
| Tételművelet | Környezet létrehozása | Hozzon létre egy új üres környezetet a munkaterületen. |
| Tételművelet | Környezet lekérése | Egy környezet metaadatainak lekérése. A válasz tartalmazza a környezet állapotát. |
| Tételművelet | Környezet törlése | Meglévő környezet törlése. |
| Tételművelet | Környezetlista | A munkaterület környezeteinek listájának lekérése. |
| Tételművelet | Környezet frissítése | Frissítse a környezet metaadatait, például a nevet és a leírást. |
| Tételművelet | Közzétételi környezet megszakítása | A környezetben zajló közzétételi művelet törlése. |
A nyilvános környezet API-kkal kapcsolatos további információkért lásd: Item API-k – Környezet.
Környezeti nyilvános API-használati esetek
Fontos
Ezt a szakaszt az API-k stabil kiadási verziójával mutatjuk be.
Ez a szakasz bemutatja, hogyan használhatók az API-k a környezet kezelése során meghatározott forgatókönyvek eléréséhez. Az alábbi példákban szereplő {WORKSPACE_ID} és {ARTIFACT_ID} tulajdonságokat a megfelelő értékekre cserélheti.
Új környezet létrehozása
Új üres környezet létrehozásához használja az alábbi API-t.
Mintakérelem
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments { "displayName": "Environment_1", "description": "An environment description" }
Átmeneti kódtárak kezelése
Az API-k segítségével feltöltheti és törölheti a staging könyvtárakat a környezet könyvtári szakaszának kezeléséhez.
Ellenőrizze a környezethez tartozó közzétett könyvtárakat
Tár hozzáadása vagy törlése előtt a Közzétett kódtárak lekérése API-val ellenőrizze, hogy mely kódtárak vannak jelenleg érvényben.
Mintakérelem
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries?beta=FalseMintaválasz
{ "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" }
Nyilvános kódtárak importálása vagy egyéni tár feltöltése
A külső kódtárak importálása és az egyéni kódtár API-k feltöltése segítségével új nyilvános/egyéni kódtárakat vehet fel a környezetébe. A külső kódtárak importálási API-ja elfogadja environment.yml fájlt, míg a támogatott fájltípusok : whl, .jar, .tar.gz, .py az egyéni kódtár API feltöltéséhez.
Feljegyzés
A nyilvános kódtár hatékonyabb kezelése érdekében javasoljuk, hogy egy environment.yml fájlban írja meg a PyPI és a Conda összes várt kódtárát.
A feltöltési API egy kérelemben legfeljebb 200 MB-os fájlt tesz lehetővé. A nyilvános API-k jelenleg nem támogatják azt a tárat, amely túllépi ezt a méretkorlátot.
Mintakérések
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibrariesPOST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar
Az egyéni könyvtár törlése
A teljes kódtárfájl nevének típus utótaggal történő megadásával egyszerre egy egyéni tárat törölhet.
Feljegyzés
Ha el szeretné távolítani a meglévő nyilvános kódtárak vagy azok egy részhalmazát, importáljon egy frissített YAML-fájlt az API-val Import public libraries .
Mintakérések
DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar
Átmeneti Spark-számítás kezelése
A Spark-számítás kezeléséhez használhatja a Spark-számítás átmeneti frissítését.
Ellenőrizze a közzétett Spark-számítást a környezet számára.
A környezet konfigurációinak módosítása előtt a Közzétett Spark Compute API használatával ellenőrizze, hogy a Spark számítási konfigurációi jelenleg milyenek.
Mintakérelem
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute?beta=FalseMintaválasz
{ "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" }
A számítási konfigurációk frissítése
Frissítheti a Spark-futtatókörnyezetet, átválthat egy másik készletre, finomíthatja a számítási konfigurációt, és hozzáadhat vagy eltávolíthat Spark-tulajdonságokat az API kérelemtörzsének szerkesztésével.
A csatolt készletet a készlet nevének és azonosítójának megadásával cserélheti le. Adja meg a hozzárendelés nevét Starter Pool, hogy a pool alapértelmezett beállításokra váltson. A munkaterület elérhető egyéni készleteinek a REST API-val történő teljes listájának lekéréséhez lásd: Egyéni készletek – Munkaterület egyéni készleteinek listázása.
Ha el szeretne távolítani egy meglévő Spark-tulajdonságot, adja meg az eltávolítani kívánt kulccsal megegyező null értéket.
Mintakérelem
PATCH https://api.fabric.microsoft.com/v1/workspaces/aaaabbbb-0000-cccc-1111-dddd2222eeee/environments/bbbbcccc-1111-dddd-2222-eeee3333ffff/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" }
A módosítások hatékonyabbá tétele
A módosítások közzétételéhez használja az alábbi API-kat.
Közzétételi művelet előkészítése
A környezet egyszerre csak egy közzétételi műveletet fogadhat el. A környezet közzététele előtt ellenőrizze a környezet állapotát, és tekintse át az előkészítési módosításokat. A környezet sikeres közzététele után az átmeneti állapotban lévő összes konfiguráció érvényessé válik.
1. lépés: Kérje le a környezet metaadatait.
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/A válasz törzsben egyértelműen megadhatja a környezet állapotát. Mielőtt továbblép a következő lépésre, győződjön meg arról, hogy nincs folyamatban közzétételi művelet.
2. lépés: Kérje le az előkészítési kódtárakat/Spark-számítást, hogy végleges áttekintést kapjon.
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
A környezet közzétételi műveletének aktiválása
Az átmeneti kódtárakhoz és a Spark-számításhoz végrehajtott módosítások gyorsítótárazva vannak, de közzétételt igényelnek a hatékony használathoz. A következő példában aktiválhatja a közzétételi műveletet. A válasz a hosszú ideig futó műveletek (LRO) mintáját követi, és HTTP 202 válaszkód adható vissza.
Mintakérelem
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=FalseMintaválasz
Location: https://api.fabric.microsoft.com/v1/operations/ccccdddd-2222-eeee-3333-ffff4444aaaa x-ms-operation-id: ccccdddd-2222-eeee-3333-ffff4444aaaa Retry-After: 120
A közzétételi művelet során az alábbi API-t is meghívhatja a megszakításhoz.
Mintakérelem
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish
Kapcsolódó tartalom
Környezet létrehozása, konfigurálása és használata Fabric - Elem API-k – Környezet