Jaa

Ympäristön hallinta julkisten ohjelmointirajapintojen kautta

  • Artikkeli

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ä

Tämä ominaisuus on esikatselutilassa.

Yhteenveto käytettävissä olevista ympäristön ohjelmointirajapinnoista

Ohjelmointirajapinta Kuvaus Luokka
Ympäristön luominen Luo uusi ympäristö työtilassa. Yleiset
Hae ympäristö Hae ympäristön metatiedot. Vastaus sisältää ympäristön tilan. Yleiset
Päivitä ympäristö Päivitä ympäristön metatiedot, kuten nimi ja kuvaus. Yleiset
Poista ympäristö Poista aiemmin luotu ympäristö. Yleiset
Ympäristön luettelo työtilassa Hae työtilan ympäristöluettelo. Yleiset
Ympäristön julkaiseminen Käynnistä ympäristön julkaisu nykyisten odottavien muutosten avulla. Yleiset
Julkaise peruuttaminen Ympäristön jatkuvan julkaisun peruuttaminen Yleiset
Julkaise spark-käsittely Hanki tehokkaita Spark-käsittelymäärityksiä. Spark-käsittely
Valmistelun Spark-käsittely Hanki valmistelulaskennan täydelliset määritykset. Valmistelumääritykset sisältävät julkaistut ja odottavat käsittelymääritykset. Spark-käsittely
Julkaistujen kirjastojen hankkiminen Hanki kirjastoluettelo, joka on käytössä. Kirjastot
Valmistelukirjastojen hankkiminen Hanki valmistelukirjaston täydellinen luettelo. Tämä luettelo sisältää julkaistut ja odottavat kirjastot. Kirjastot
Valmistelukirjastojen lataaminen palvelimeen Yhden mukautetun kirjaston tai yhden tai usean yleisen kirjaston lisääminen ympäristöön. Kirjastot
Poista valmistelukirjastot Poista yksi valmistelun mukautettu kirjasto tai kaikki julkinen kirjasto. Kirjastot

Lue lisätietoja ympäristön julkisista ohjelmointirajapinnoista kohteen ohjelmointirajapinoista – ympäristö

Ympäristön julkisten ohjelmointirajapinnaiden käyttötapaukset

Tässä osiossa käydään läpi useita yleisiä käyttötilanteita, jotka liittyvät ympäristöön. 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 laatia kaikki odotetut kirjastot PyPI:stä ja condasta environment.yml-tiedostoon.
  • 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 environment.yml poistettavaksi tiedostoksi, 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ä julkaisemista ei ole käynnissä, 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

Liittyvä sisältö