Ympäristön hallinta julkisten ohjelmointirajapintojen kautta
Microsoft Fabricin REST-ohjelmointirajapinta tarjoaa palvelupäätepisteen Fabric-kohteen (CRUD) luomiselle, lukemiselle, päivittämiselle ja poistamiselle. Tässä artikkelissa kuvataan käytettävissä olevat REST-ohjelmointirajapinnat ja niiden käyttö.
Tärkeä
- Uusi versio sisältää uudet ohjelmointirajapinnat, ohjelmointirajapinnan vanhentumiset ja ohjelmointirajapinnan vastauksen/pyyntösopimuksen muutokset. Seuraavassa osiossa olevassa taulukossa on yhteenveto kaikista ohjelmointirajapinnan muutoksista.
- Ohjelmointirajapinnat, joita poistetaan käytöstä, jatkavat tukea 30.6.2025 asti. Vastaus-/pyyntösopimuksen muutokset tulevat voimaan välittömästi, kun vapauttaminen on saatu.
Ympäristön ohjelmointirajapintojen yhteenveto
Luokka | Ohjelmointirajapinta | Kuvaus | Muistiinpano |
---|---|---|---|
Kohdetoiminto | Ympäristön luominen | Luo työtilaan uusi tyhjä ympäristö. | Ei muutosta |
Kohdetoiminto | Ympäristön luominen määritelmän avulla | Luo uusi ympäristö määrityksen avulla. | uuden ohjelmointirajapinnan |
Kohdetoiminto | Poista ympäristö | Poista aiemmin luotu ympäristö. | Ei muutosta |
Kohdetoiminto | Ympäristöluettelo | Hae työtilan ympäristöluettelo. | Ei muutosta |
Kohdetoiminto | Hae ympäristö | Hae ympäristön metatiedot. Vastaus sisältää ympäristön tilan. | Vastauksen sopimuspäivitys |
Kohdetoiminto | Ympäristön määrityksen hakeminen | Hae ympäristön määritys. | uuden ohjelmointirajapinnan |
Kohdetoiminto | Päivitä ympäristö | Päivitä ympäristön metatiedot, kuten nimi ja kuvaus. | Ei muutosta |
Kohdetoiminto | Päivitä ympäristömääritelmä | Päivitä ympäristön määritys. | uuden ohjelmointirajapinnan |
Kohdetoiminto | Ympäristön julkaiseminen | Käynnistä ympäristön julkaisu nykyisten odottavien muutosten avulla. | Vastauksen sopimuspäivitys |
Kohdetoiminto | Peruuta julkaisuympäristö | Ympäristön jatkuvan julkaisun peruuttaminen | Ei muutosta |
Teline | Luettelo valmistelukirjastoista | Hanki valmistelukirjaston täydellinen luettelo. Tämä luettelo sisältää julkaistut ja odottavat kirjastot. | Vastauksen sopimuspäivitys |
Teline | Tuo ulkoisia kirjastoja | Lataa ulkoisia kirjastoja environment.yml -tiedostona ympäristöön. Se ohittaa ympäristön olemassa olevien ulkoisten kirjastojen luettelon. | uuden ohjelmointirajapinnan |
Teline | Vie ulkoiset kirjastot | Hanki täydet ulkoiset kirjastot environment.yml tiedostona. | uuden ohjelmointirajapinnan |
Teline | Poista ulkoinen kirjasto | Poista ulkoinen kirjasto ympäristöstä. Tämä ohjelmointirajapinta hyväksyy yhden kirjaston kerrallaan | uuden ohjelmointirajapinnan |
Teline | Lataa mukautettu kirjasto palvelimeen | Lataa mukautettu paketti ympäristöön. Tämä ohjelmointirajapinta mahdollistaa yhden tiedoston lataamisen kerrallaan. Tuetut tiedostomuodot ovat .jar, .py, .whl ja .tar.gz. | uuden ohjelmointirajapinnan |
Teline | Poista mukautettu kirjasto | Poista mukautettu paketti ympäristöstä. Sijoita mukautetun paketin koko nimi ja laajennus API-pyyntöön, jotta saat sen poistettua. | uuden ohjelmointirajapinnan |
Teline | Valmistelukirjastojen lataaminen palvelimeen | Yhden mukautetun kirjaston tai yhden tai usean yleisen kirjaston lisääminen ympäristöön. | Vanhentuva |
Teline | Poista valmistelukirjastot | Poista yksi valmistelun mukautettu kirjasto tai kaikki julkinen kirjasto. | Vanhentuva |
Teline | Luettele valmistelun Spark-asetukset | Hanki valmistelulaskennan täydelliset määritykset. Valmistelumääritykset sisältävät julkaistut ja odottavat käsittelymääritykset. | Vastauksen sopimuspäivitys |
Teline | Päivitä Spark-asetukset | Ympäristön käsittelymääritysten ja Spark-ominaisuuksien päivittäminen | pyyntö/ vastaus -sopimuksen päivitys |
Julkaistu | Luetteloi julkaistut kirjastot | Hanki kirjastot, jotka julkaistaan ja jotka ovat voimassa Spark-istunnoissa. | Vastauksen sopimuspäivitys |
Julkaistu | Luettelo julkaistuista Spark-asetuksista | Hanki Spark-istunnoissa julkaistut ja käytössä olevat Spark-käsittelymääritykset ja Spark-ominaisuudet. | Vastauksen sopimuspäivitys |
Julkaistu | Vie ulkoiset kirjastot | Hanki julkaistut ulkoiset kirjastot environment.yml tiedostona. | uuden ohjelmointirajapinnan |
Lue lisätietoja olemassa olevasta ympäristön julkisista ohjelmointirajapinnoista kohteen ohjelmointirajapinoista – Ympäristö
Ympäristön julkinen ohjelmointirajapinnan päivityksen tiedot
Tässä osiossa kuvataan olemassa olevien ohjelmointirajapintojen tulevat päivitykset.
Hae ympäristö
Hae ympäristö -ohjelmointirajapinnan vastauksessa startTime-kohteesta tulee startDateTime ja endTime-arvoksi endDateTime. Ne edustavat julkaisutoiminnon alkamis- ja päättymisaikaa.
Muistiinpano
'startTime' ja 'endTime' käyttävät Date-Time -muotoa, kun taas 'startDateTime' ja 'endDateTime' ovat String, joka on UTC-muodossa ja käyttää VVVVV-MM-DDTHH:mm:ssZ-muotoa.
Liittymä
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}
Alkuperäinen mallivastaus
{ "displayName": "Environment_1", "description": "An Environment description", "type": "Environment", "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "id": "5b218778-e7a5-4d73-8187-f10824047715", "properties": { "publishDetails": { "state": "Success", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startTime": "2024-03-29T14:17:09.0697022Z", "endTime": "2024-03-29T14:48:09.0697022Z", "componentPublishInfo": { "sparkLibraries": { "state": "Success" }, "sparkSettings": { "state": "Success" } } } } }
Uusi mallivastaus
{ "displayName": "Environment_1", "description": "An Environment description", "type": "Environment", "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "id": "5b218778-e7a5-4d73-8187-f10824047715", "properties": { "publishDetails": { "state": "Success", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startDateTime": "2024-03-29T14:17:09Z", "endDateTime": "2024-03-29T14:48:09Z", "componentPublishInfo": { "sparkLibraries": { "state": "Success" }, "sparkSettings": { "state": "Success" } } } } }
Ympäristön julkaiseminen
Julkaise ympäristön ohjelmointirajapinta tukee pitkäkestoisia toimintoja julkaisusta alkaen, ja vastauksen sopimus muuttuu. Päätepiste pysyy samana pyyntöjen lähettämisessä.
Liittymä
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish
Alkuperäinen mallivastaus
{ "publishDetails": { "state": "Running", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startTime": "2024-03-29T14:17:09.0697022Z", "componentPublishInfo": { "sparkLibraries": { "state": "Running" }, "sparkSettings": { "state": "Running" } } } }
Uusi mallivastaus
Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69 x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69 Retry-After: 60
Luettelo valmistelu- ja julkaistuista kirjastoista
Nämä kaksi ohjelmointirajapintaa voivat saada täydellisen luettelon ympäristön valmistelu- ja julkaisukirjastoista. Päätepisteet pysyvät samoina pyyntöjen lähettämisessä, kun taas kirjastot palautetaan käyttäen eri rakennetta.
Liittymät
Valmistelukirjastojen hankkiminen
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries
Julkaistujen kirjastojen hankkiminen
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries
Alkuperäinen mallivastaus
{ "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" }
Uusi mallivastaus
{ "libraries": [ { "name": "samplewheel-0.18.0-py2.py3-none-any.whl", "libraryType": "Custom" }, { "name": "samplepython.py", "libraryType": "Custom" }, { "name": "samplejar.jar", "libraryType": "Custom" }, { "name": "sampleR.tar.gz", "libraryType": "Custom" }, { "name": "fuzzywuzzy", "libraryType": "External", "version": "0.0.1" }, { "name": "matplotlib", "libraryType": "External", "version": "0.0.1" } ], "continuationToken": "null", "continuationUri": "null" }
Valmistelu- tai julkaistujen Spark-asetusten luettelo
Nämä kaksi ohjelmointirajapintaa voivat saada spark-käsittelymääritykset ja ympäristön ominaisuudet. Päätepisteet pysyvät samoina pyyntöjen lähettämisessä, kun taas määritykset palautetaan käyttäen eri rakennetta. Spark-ominaisuudet muutetaan luetteloksi.
Liittymät
Valmisteluasetusten hakeminen Spark-asetuksista
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute
Hanki julkaistut Spark-asetukset
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute
Alkuperäinen mallivastaus
{ "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": { "spark.acls.enable": "false" }, "runtimeVersion": "1.2" }
Uusi mallivastaus
{ "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" }
Päivitä Spark-asetukset
Tämä ohjelmointirajapinta on tarkoitettu ympäristön Spark-käsittelyn ja -ominaisuuksien päivittämiseen. Spark-ominaisuuden sopimus pyydettäessä ja vastaus päivitetään, kun julkaisu tulee.
Alkuperäinen mallipyyntö
PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute { "instancePool": { "name": "MyWorkspacePool", "type": "Workspace" }, "driverCores": 4, "driverMemory": "56g", "executorCores": 4, "executorMemory": "56g", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": { "spark.acls.enable": "false", "spark.admin.acls": null }, "runtimeVersion": "1.2" }
Uusi mallipyyntö
PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute { "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" }
Alkuperäinen mallivastaus
{ "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": { "spark.acls.enable": "false" }, "runtimeVersion": "1.2" }
Uusi mallivastaus
{ "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" }
Ympäristön julkisten ohjelmointirajapinnaiden käyttötapaukset
Tärkeä
Uudet ohjelmointirajapinnat ja sopimusmuutokset eivät sisälly tähän osioon.
Tässä osiossa esitellään, miten voit käyttää nykyisin käytettävissä olevia ohjelmointirajapintoja erityisten tavoitteiden saavuttamiseksi. Voit korvata {WORKSPACE_ID}
{ARTIFACT_ID}
ja seuraavissa esimerkeissä sopivilla arvoilla.
Uuden ympäristön luominen
Voit luoda uuden tyhjän ympäristön käyttämällä seuraavaa ohjelmointirajapintaa.
Mallipyyntö
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments { "displayName": "Environment_1", "description": "An environment description" }
Valmistelukirjastojen hallinta
Voit käyttää valmistelukirjastojen lataus- ja poisto-ohjelmointirajapintoja ympäristön kirjasto-osan hallintaan
Tarkista ympäristön julkaistut kirjastot
Ennen kuin lisäät tai poistat kirjaston, voit käyttää julkaistujen kirjastojen ohjelmointirajapintaa tarkistaaksesi, mitkä kirjastot ovat tällä hetkellä voimassa.
Mallipyyntö
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries
Mallivastaus
{ "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" }
Kirjastojen lataaminen
Valmistelukirjaston lataamisen ohjelmointirajapinta hyväksyy yhden tiedoston kerrallaan. Tuettuja tiedostotyyppejä ovat julkisen kirjaston .whl-, .jar-, .tar.gz-, .py - ja environment.yml . Voit määrittää tiedoston moniosaisen/form-data content-type-tyypin kautta.
Muistiinpano
- Jotta julkista kirjastoa voidaan käsitellä tehokkaammin, on erittäin suositeltavaa koota kaikki odotetut kirjastot PyPI:stä ja condasta environment.yml-tiedostoon.
- Palvelimeen lataavan ohjelmointirajapinnan avulla voidaan käyttää enintään 200 Mt:n tiedostoa yhdessä pyynnössä. Tämän kokorajan ylittävää kirjastoa ei tällä hetkellä tueta julkisessa ohjelmointirajapinnassa.
Mallipyynnöt
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries
Kirjastojen poistaminen
Määrittämällä kirjaston koko tiedostonimen tyypin jälkiliitteellä voit poistaa yhden kirjaston kerrallaan.
Muistiinpano
- Jos määrität poistettavaksi tiedostoksi
environment.yml
, poistat kaikki julkiset kirjastot. - Jos haluat poistaa olemassa olevan julkisen kirjaston alijoukon, käytä sen sijaan latauskirjastoa ja lataa environment.yml , joka sisältää vain odotetut kirjastot. Ladattu environment.yml korvaa olemassa olevan julkisen kirjaston osan kokonaan.
Mallipyynnöt
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
Valmistelun Spark-käsittelyn hallinta
Voit hallita Spark-käsittelyä käyttämällä valmistelun Spark-käsittelyä.
Tarkista ympäristön julkaistu Spark-käsittely
Ennen kuin muutat ympäristön kokoonpanoja, voit käyttää julkaistua Spark-käsittely-ohjelmointirajapintaa tarkistaaksesi, mitkä Spark-käsittelymääritykset ovat tehokkaita tällä hetkellä.
Mallipyyntö
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute
Mallivastaus
{ "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" }
Käsittelymääritysten päivittäminen
Voit päivittää Spark-suorituspalvelun, vaihtaa toiseen varantoon, tarkentaa käsittelymääritystä ja lisätä tai poistaa Spark-ominaisuuksia muokkaamalla tämän ohjelmointirajapinnan pyynnön runkoa.
Voit vaihtaa liitettyä varantoa määrittämällä varannon nimen ja varannon. Määritä varannon nimi Starter Pool
varannon oletusasetuksiin vaihtamiseksi. Katso täydellinen luettelo työtilan käytettävissä olevista mukautetuista varannoista REST-ohjelmointirajapinnan mukaan artikkelista Mukautetut varannot – Luetteloi työtilan mukautetut varannot
Jos haluat poistaa aiemmin luodun Spark-ominaisuuden, sinun on määritettävä arvo samalla tavalla kuin null
poistettavalla avaimella, kuten seuraavassa esimerkissä esitetään.
Mallipyyntö
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" }
Tee muutoksista tehokkaita
Seuraavien ohjelmointirajapintojen avulla muutosten julkaiseminen.
Julkaisun valmisteleminen
Ympäristö voi hyväksyä yhden julkaisun kerrallaan. Ennen ympäristön julkaisemista voit vahvistaa ympäristön tilan ja tarkastaa valmistelun muutokset lopullisesti. Kun ympäristö on julkaistu, kaikki valmistelutilan määritykset tulevat voimaan.
Vaihe 1: ympäristön metatietojen hakeminen
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
Vastauksen leipätekstissä voit kertoa selvästi ympäristön tilan. Varmista, että meneillään ei ole julkaisua, ennen kuin siirryt seuraavaan vaiheeseen.
Vaihe 2: valmistelukirjastojen/Spark-käsittelyn viimeistelyn tarkistaminen
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
Käynnistä ympäristön julkaiseminen
Valmistelukirjastoihin ja Spark-käsittelyyn tekemäsi muutokset tallennetaan välimuistiin, mutta ne edellyttävät julkaisemista. Käynnistä julkaisu noudattamalla seuraavaa esimerkkiä.
Mallipyyntö
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish
Mallivastaus
{ "publishDetails": { "state": "Running", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startTime": "2024-03-29T14:17:09.0697022Z", "componentPublishInfo": { "sparkLibraries": { "state": "Running" }, "sparkSettings": { "state": "Running" } } } }
Julkaisun aikana voit myös kutsua seuraavan ohjelmointirajapinnan ja peruuttaa sen.
Mallipyyntö
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish