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ö.

Siirrä ympäristön ohjelmointirajapinnat vakaaseen GA-versioon

Tärkeä

GA-versio sisältää päivityksiä olemassa olevien ohjelmointirajapintojen pyyntö-vastaussopimukseen, ohjelmointirajapintojen vanhentumiseen ja uusiin ohjelmointirajapintoihin. Löydät lisätietoja seuraavista osioista.
Uusi kyselyparametri beta otetaan käyttöön helpottamaan pyyntö/vastaus-sopimuksen muutosten siirtymistä. Kyselyparametrin beta oletusarvo on True31. maaliskuuta 2026 asti, joten esikatselusopimukset ovat edelleen käytettävissä. Aseta arvoksi False aloittaaksesi sopimusten vakaan julkaisuversion käytön.
Previewkyselyparametri on korvattu .beta Taaksepäin yhteensopivuuden vuoksi esikatselu on edelleen tuettu ja käyttäytyy samalla tavalla kuin beta.
to-bevanhentuneita ohjelmointirajapintoja tuetaan 31. maaliskuuta 2026 asti, käytä äskettäin käyttöön otettuja ohjelmointirajapintoja korvaamaan ne mahdollisimman pian.

API:t, joissa on pyyntö/vastaus-sopimuksen päivitys

Luokka	API	Kuvaus	Muistiinpanot	Esikatseluversion swagger	Julkaisuversion swagger
Kohdetoiminto	Ympäristön julkaiseminen	Käynnistä ympäristön julkaisutoiminto nykyisillä odottavilla muutoksilla.	Päivitä vastaussopimuksessa.	Julkaisuympäristö (esiversio)	Julkaise ympäristö
Teline	Luettelo valmistelukirjastoista	Hanki valmistelukirjaston täydellinen luettelo. Tämä luettelo sisältää julkaistut ja odottavat kirjastot.	Päivitä vastaussopimuksessa.	Luettelon valmistelukirjastot (esikatselu)	Luettelo valmistelukirjastoista
Teline	Luettelon valmistelu Spark-laskenta	Hanki valmistelulaskennan täydelliset määritykset. Valmistelumääritykset sisältävät julkaistut ja odottavat käsittelymääritykset.	Päivitä vastaussopimuksessa.	Luettelon valmistelu Spark-laskenta (esiversio)	Luettelon valmistelu Spark-laskenta
Teline	Päivitä Spark-laskenta	Päivitä ympäristön laskentamääritykset ja Spark-ominaisuudet.	Päivitys pyyntö- ja vastaussopimuksissa.	Päivitä Spark-laskenta (esikatselu)	Päivitä Spark-laskenta
Julkaistu	Luetteloi julkaistut kirjastot	Hanki kirjastot, jotka julkaistaan ja jotka ovat voimassa Spark-istunnoissa.	Päivitä vastaussopimuksessa.	Julkaistujen kirjastojen luettelo (esikatselu)	Luetteloi julkaistut kirjastot
Julkaistu	Julkaistujen Spark-laskennan luettelo	Hanki Spark-istunnoissa julkaistut ja käytössä olevat Spark-käsittelymääritykset ja Spark-ominaisuudet.	Päivitä vastaussopimuksessa.	Julkaistujen kirjastojen luettelo (esikatselu)	Luetteloi julkaistut kirjastot

Parametrin beta oletusarvo on True31. maaliskuuta 2026 asti, eli järjestelmä pitää parametria ikään kuin True pyyntöä lähetettäisiin määrittämättä tätä parametria vanhentumispäivään asti. Suosittelemme, että siirrät toteutukset vakaaseen versioon asettamalla parametriksi betaFalse eksplisiittisesti mahdollisimman pian.

Käyttämällä List staging libraries esimerkkinä ohjelmointirajapintaa, jonka API-vastauksessa on päivitys.

Kun lähetät pyynnön, jonka parametri beta on True

Näyte pyyntö:

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

Esimerkki vastauksesta:

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

Kun lähetät pyynnön, jonka parametri preview on False

Näyte pyyntö:

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

Esimerkki vastauksesta:

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

Vanhentuneet ohjelmointirajapinnat

Tärkeä

to-bevanhentuneita ohjelmointirajapintoja tuetaan edelleen 31. maaliskuuta 2026 asti. Suosittelemme käyttämään äskettäin käyttöön otettuja ohjelmointirajapintoja korvaamaan toteutuksesi mahdollisimman pian.

Luokka	API	Kuvaus	Muistiinpano
Teline	Valmistelukirjastojen lataaminen	Lisää ympäristöön yksi mukautettu kirjasto tai yksi/useampi julkinen kirjasto.	Tuki 31. maaliskuuta 2026 asti, käytä äskettäin käyttöön otettuja `Import external libraries`/`Upload custom library` ohjelmointirajapintoja korvaamiseen.
Teline	Poista valmistelukirjastot	Poista yksi mukautettu kirjasto tai kaikki julkiset kirjastot.	Tuki 31. maaliskuuta 2026 asti, käytä äskettäin käyttöön otettuja `Remove external library`/`Delete custom library` ohjelmointirajapintoja korvaamiseen.

Alla on muutamia esimerkkejä, jotka kattavat valmistelukirjastojen hallinnan skenaariot.

Julkisten kirjastojen lisääminen ympäristöön

Aiemmin voit ladata päivitetyn YAML-tiedoston ohjelmointirajapinnan avulla Upload staging libraries , ja nyt voit tuoda päivitetyn YAML-tiedoston ohjelmointirajapinnan avulla Import external libraries .
Poista yksi julkinen kirjasto ympäristöstäsi

Aiemmin voit ladata päivitetyn YAML-tiedoston ohjelmointirajapinnan avulla Upload staging libraries , ja nyt voit poistaa sen ohjelmointirajapinnan avulla Remove external library .
Poista kaikki ympäristösi julkiset kirjastot

Aiemmin voit poistaa kaikki julkiset kirjastot API:n avulla Delete staging libraries , ja nyt voit poistaa julkiset kirjastot yksitellen API:n avulla Remove external library tai ladata Import external libraries tyhjän YAML-tiedoston samojen toimintojen saavuttamiseksi.

Uudet ohjelmointirajapinnat

Luokka	API	Kuvaus	Muistiinpano
Kohdetoiminto	Luo ympäristö määritellyllä tavalla	Luo uusi ympäristö määrityksellä.	Uusi API.
Kohdetoiminto	Hae ympäristön määritys	Hae ympäristön määritys.	Uusi API.
Kohdetoiminto	Päivitä ympäristön määritys	Päivitä ympäristön määritys.	Uusi API.
Teline	Ulkoisten kirjastojen tuominen	Lataa ulkoiset kirjastot environment.yml tiedostona ympäristöön. Se ohittaa ympäristön olemassa olevien ulkoisten kirjastojen luettelon.	Uusi API.
Teline	Ulkoisten kirjastojen vieminen	Hanki kaikki ulkoiset kirjastot environment.yml tiedostona.	Uusi API.
Teline	Poista ulkoinen kirjasto	Poista ulkoinen kirjasto ympäristöstä. Tämä ohjelmointirajapinta hyväksyy yhden kirjaston kerrallaan.	Uusi API.
Teline	Lataa mukautettu kirjasto	Lataa mukautettu paketti ympäristöön. Tämä ohjelmointirajapinta mahdollistaa yhden tiedoston lataamisen kerrallaan. Tuetut tiedostomuodot ovat .jar, .py, .whl ja .tar.gz.	Uusi API.
Teline	Mukautetun kirjaston poistaminen	Poista mukautettu paketti ympäristöstä. Sijoita mukautetun paketin koko nimi ja laajennus API-pyyntöön, jotta saat sen poistettua.	Uusi API.
Julkaistu	Ulkoisten kirjastojen vieminen	Hanki julkaistut ulkoiset kirjastot environment.yml tiedostona.	Uusi API.

API:t ilman päivitystä

Luokka	API	Kuvaus
Kohdetoiminto	Luo ympäristö	Luo työtilaan uusi tyhjä ympäristö.
Kohdetoiminto	Hanki ympäristö	Hae ympäristön metatiedot. Vastaus sisältää ympäristön tilan.
Kohdetoiminto	Poista ympäristö	Poista aiemmin luotu ympäristö.
Kohdetoiminto	Listaa ympäristö	Hae luettelo työtilan ympäristöistä.
Kohdetoiminto	Päivitä ympäristö	Päivitä ympäristön metatiedot, kuten nimi ja kuvaus.
Kohdetoiminto	Julkaisuympäristön peruuttaminen	Peruuta ympäristön käynnissä oleva julkaisutoiminto.

Lisätietoja ympäristön julkisista ohjelmointirajapinnoista on kohdassa Nimikkeen ohjelmointirajapinnat – ympäristö.

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

Tärkeä

Tämä osio on esitelty ohjelmointirajapintojen vakaalla julkaisuversiolla.

Tässä osassa näytetään, miten ohjelmointirajapintoja käytetään tiettyjen skenaarioiden saavuttamiseen ympäristön hallinnassa. Voit korvata seuraavien esimerkkien {WORKSPACE_ID} ja-ominaisuudet {ARTIFACT_ID} asianmukaisilla arvoilla.

Uuden ympäristön luominen

Jos haluat luoda uuden tyhjän ympäristön, käytä 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ää lataus- ja poistokirjastojen ohjelmointirajapintoja ympäristön kirjasto-osan hallintaan.

Tarkista ympäristön julkaistut kirjastot

Ennen kuin lisäät tai poistat kirjaston, tarkista Hae julkaistut kirjastot -ohjelmointirajapinnan avulla, mitkä kirjastot ovat tällä hetkellä voimassa.

Mallipyyntö

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

Mallivastaus

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

Tuo julkisia kirjastoja tai lataa mukautettu kirjasto

Voit lisätä ympäristöösi uusia julkisia/mukautettuja kirjastoja Tuo ulkoisia kirjastoja - ja Lataa mukautettujen kirjastojen ohjelmointirajapintoja -toiminnoilla. Ulkoisten kirjastojen tuonti-ohjelmointirajapinta hyväksyy environment.yml tiedoston, kun taas tuetut tiedostotyypit ovat .whl, .jar, .tar.gz.py mukautetun kirjaston ohjelmointirajapinnan lataamiseen.

Muistiinpano

Jotta voit käsitellä julkista kirjastoa tehokkaammin, suosittelemme, että luot kaikki odotetut kirjastot PyPI:stä ja Condasta environment.yml tiedostoon.

Latausrajapinta sallii jopa 200 Mt:n tiedoston yhdellä pyynnöllä. Tämän kokorajoituksen ylittävää kirjastoa ei tällä hetkellä tueta julkisissa ohjelmointirajapinnoissa.

Mallipyynnöt

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

Poista mukautettu kirjasto

Kun määrität kirjastotiedoston koko nimen tyyppipäätteellä, voit poistaa yhden mukautetun kirjaston kerrallaan.

Muistiinpano

Jos haluat poistaa osan olemassa olevista julkisista kirjastoista tai kaikista niistä, tuo päivitetty YAML-tiedosto API:n kautta Import public libraries .

Mallipyynnöt

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

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 määrityksiä, tarkista, mitkä Spark-laskentamääritykset ovat tällä hetkellä voimassa Hae julkaistu Spark Compute -ohjelmointirajapinnan avulla.

Mallipyyntö

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

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

Käsittelymääritysten päivittäminen

Voit päivittää Spark-suorituksen, vaihtaa toiseen pooliin, tarkentaa laskentamäärityksiä 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. Jos haluat saada täydellisen luettelon työtilan käytettävissä olevista mukautetuista varannoista REST-ohjelmointirajapinnan avulla, katso Mukautetut poolit – Työtilan mukautettujen poolien luettelo.

Jos haluat poistaa aiemmin luodun Spark-ominaisuuden, määritä arvo samalla tavalla kuin null poistettavan avaimen kohdalla.

Mallipyyntö

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

Tee muutoksista tehokkaita

Julkaise muutokset seuraavien ohjelmointirajapintojen avulla.

Julkaisutoiminnon valmistelu

Ympäristö voi hyväksyä yhden julkaisutoiminnon kerrallaan. Ennen kuin julkaiset ympäristön, tarkista ympäristön tila ja tarkista valmistelumuutokset lopullisesti. Kun ympäristö on julkaistu onnistuneesti, kaikki valmistelutilassa olevat määritykset tulevat voimaan.

Vaihe 1: Hae ympäristön metatiedot.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
Vastausrungossa voit kertoa selkeästi ympäristön tilan. Varmista, että mikään julkaisutoiminto ei ole käynnissä, ennen kuin siirryt seuraavaan vaiheeseen.

Vaihe 2: Hanki valmistelukirjastot/Spark-laskenta saadaksesi lopullisen tarkistuksen.

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

Käynnistä ympäristön julkaisutoiminto

Valmistelukirjastoihin ja Spark-laskentaan tekemäsi muutokset tallennetaan välimuistiin, mutta ne edellyttävät julkaisemista, jotta ne tulevat voimaan. Käynnistä julkaisutoiminto seuraavan esimerkin avulla. Vastaus on seuraavat pitkäkestoisten toimintojen (LRO) mallia, ja HTTP-vastauskoodi 202 voidaan palauttaa.

Mallipyyntö

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

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: 120

Julkaisutoiminnon aikana voit myös kutsua seuraavaa ohjelmointirajapintaa peruuttaaksesi sen.

Mallipyyntö

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

Palaute

Onko tästä sivusta apua?

Last updated on 2025-10-09

Jaa

Ympäristön hallinta julkisten ohjelmointirajapintojen kautta

Siirrä ympäristön ohjelmointirajapinnat vakaaseen GA-versioon

API:t, joissa on pyyntö/vastaus-sopimuksen päivitys

Vanhentuneet ohjelmointirajapinnat

Uudet ohjelmointirajapinnat

API:t ilman päivitystä

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

Uuden ympäristön luominen

Valmistelukirjastojen hallinta

Tarkista ympäristön julkaistut kirjastot

Tuo julkisia kirjastoja tai lataa mukautettu kirjasto

Poista mukautettu kirjasto

Valmistelun Spark-käsittelyn hallinta

Tarkista ympäristön julkaistu Spark-käsittely

Käsittelymääritysten päivittäminen

Tee muutoksista tehokkaita

Julkaisutoiminnon valmistelu

Käynnistä ympäristön julkaisutoiminto

Liittyvä sisältö

Palaute

Lisäresursseja