Cloud for Sustainability -ohjelmointirajapintojen (esiversio) OData-kyselyesimerkkejä
Microsoft Cloud for Sustainability
Tärkeää
Tämä toiminto on osittain tai kokonaisuudessaan käytettävissä esiversion osana. Sisältö ja toiminnot voivat muuttua.
OData (Open Data Protocol) on perusprotokollien, kuten HTTP:n, tietojen käyttöprotokolla. Se käyttää verkossa yleisesti hyväksyttyjä menetelmiä, kuten REST-menetelmää. Voit käyttää erilaisia kirjastoja ja työkaluja OData-palveluiden käytössä.
Jotta voit rakentaa omia toteutuksiasi Microsoft Cloud for Sustainability -ohjelmointirajapinnan pohjalta, voit tarkastella joitain näistä usein kysytyistä esimerkkikyselyistä.
Muokkaa kyselynäytteitä, jotta ne toimivat kohdeympäristöissäsi:
{serviceRoot}:
https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}{instanceId}: GUID Cloud for Sustainability -ympäristölle, johon haluat kohdistaa kyselyn, esimerkiksi 20aec369-f1c8-4814-a89d-4d449dd7e8a1.
{serviceRootM365}:
{serviceRoot}/m365{serviceRootAzure}:
{serviceRoot}/enrollments/{enrollmentId}{enrollmentId}: Rekisteröintitunnus eli laskutustilin tunnus. Esimerkki: 12345678.
{tenantId}: Microsoft 365 -vuokraajan tunnus.
Muistiinpano
Jotkin ohjelmointirajapinnan kyselyt sisältävät monia tuloksia, ja ne jaetaan useille sivuille. Ohjelmointirajapinta palauttaa enintään 1 000 tulosta sivua kohden. Jos tuloksia on saatavilla enemmän, ohjelmointirajapinta palauttaa @odata.nextLink-ominaisuuden, joka sisältää seuraavan tulossivun URL-osoitteen.
EnrollmentEmission-entiteetti (Azuren päästöille)
Edustaa laskutustilin eli rekisteröinnin päästötietoja.
| Ominaisuus | Tyyppi | Huomautuksia |
|---|---|---|
| dateKey | int32 | Päivämäärä muodossa vvvvkkpp; pp on aina 01. |
| enrollmentId | merkkijono | Kutsutaan myös laskutustilin tunnukseksi. |
| orgName | merkkijono | Sama kuin TP-nimi tai ylimmän tason nimi. |
| subscriptionId | merkkijono | Tilauksen tunnus. |
| subscriptionName | merkkijono | Tilauksen nimi. |
| azureServiceName | merkkijono | Azure-palvelun nimi, esimerkiksi "sovelluspalvelu". |
| subService | merkkijono | Esimerkiksi Azure-tallennus tai Azure-käsittely. |
| azureRegionName | merkkijono | Azure-alue, jossa palvelu on otettu käyttöön. |
| laajuus | merkkijono | Kasvihuonekaasutaso, esim. taso 1, taso 2 tai taso 3. |
| scopeId | int32 | Tason tunnus. |
| totalEmissions | liukuluku | Tietueen päästöt yhteensä (mtCO2e). |
EnrollmentEmission-entiteetin näytekyselyt (Azuren päästöille)
| Kyselyn tyyppi | Esimerkki: |
|---|---|
| Päästöt rekisteröinnin mukaan | {serviceRootAzure}/emissions |
| Valitse tietyt kentät | {serviceRootAzure}/emissions?$select=enrollmentId,totalEmissions,scopeId |
| Sisällytä määrä | {serviceRootAzure}/emissions?$count=true |
| Rajoita tulosten määrää | {serviceRootAzure}/emissions?$top=100 |
| Sivutus | {serviceRootAzure}/emissions?$skip=100&$top=50 |
| Suodata vaikutusalueen mukaan | {serviceRootAzure}/emissions?$filter=ScopeId eq 1 |
| Suodata ja koosta | {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count määränä, totalEmissions-keskiarvo keskiarvona, totalEmissions-summa summana) |
| Suodata ja ryhmittele | {serviceRootAzure}/emissions?$apply=filter(totalEmissions gt 0.05)/groupby((ScopeId), aggregate($count määränä))` |
Microsoft365Emission-entiteetti (M365:n päästöille)
Edustaa seuraaviin sovelluksiin liittyviä Microsoft 365 -palvelinkeskuksen päästöjä:
- Exchange Online
- SharePoint
- OneDrive
- Microsoft Teams
- Word
- Excel
- PowerPoint
- Outlook
| Ominaisuus | Tyyppi | Huomautuksia |
|---|---|---|
| dateKey | int32 | Päivämäärä muodossa vvvvkkpp; pp on aina 01. |
| tenantId | merkkijono | Vuokraajan tunnus. |
| tenantName | merkkijono | Vuokraajan nimi. |
| officeRegionName | merkkijono | Microsoft 365 -palvelinkeskusalue. |
| laajuus | merkkijono | Kasvihuonekaasutaso, esim. taso 1, taso 2 tai taso 3. |
| totalEmissions | liukuluku | Tietueen päästöt yhteensä (mtCO2e). |
Microsoft365Emission-entiteetin näytekyselyt (M365:n päästöille)
| Kyselyn tyyppi | Esimerkki: |
|---|---|
| Vuokraajan päästöt | {serviceRootM365}/tenantemissions |
| Valitse tietyt kentät | {serviceRootM365}/emissions?$select=tenantId,totalEmissions,scope |
| Sisällytä määrä | {serviceRootM365}/tenantemissions?$count=true |
| Rajoita tulosten määrää | {serviceRootM365}/tenantemissions?$top=100 |
| Sivutus | {serviceRootM365}/tenantemissions?$skip=100&$top=50 |
| Suodata vaikutusalueen mukaan | {serviceRootM365}/tenantemissions?$filter=Scope eq 'FILLMEIN' |
| Suodata ja koosta | {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count as Count, totalEmissions with average as Average, totalEmissions with sum as Sum) |
| Suodata ja ryhmittele | {serviceRootM365}/tenantemissions?$apply=filter(totalEmissions gt 0.05)/groupby((Scope), aggregate($count as Count))` |
EnrollmentUsage-entiteetti (Azuren päästöille)
Edustaa Microsoftin pilviresurssien laskettua käyttökerrointa.
| Ominaisuus | Tyyppi | Huomautuksia |
|---|---|---|
| dateKey | int32 | Päivämäärä muodossa vvvvkkpp; pp on aina 01. |
| enrollmentId | merkkijono | Kutsutaan myös laskutustilin tunnukseksi. |
| orgName | merkkijono | Sama kuin TP-nimi tai ylimmän tason nimi. |
| subscriptionId | merkkijono | Tilauksen tunnus. |
| subscriptionName | merkkijono | Tilauksen nimi. |
| subService | merkkijono | Esimerkiksi Azure-tallennus tai Azure-käsittely. |
| azureRegionName | merkkijono | Azure-alue, jossa palvelu on otettu käyttöön. |
| käyttöä | liukuluku | Tietueen kokonaiskäyttö. Yksikköä ei ole, koska se edustaa palvelun normalisoitua käyttöä määritetyllä alueella. |
Lisätietoja Microsoftin laskentatavasta: Microsoft Cloud for Sustainability -ohjelmointirajapinnan laskentatapa.|
EnrollmentUsage-entiteetin näytekyselyt
| Kyselyn tyyppi | Esimerkki: | Muistiinpano |
|---|---|---|
| Kaikki käyttötiedot | {serviceRootAzure}/usage | |
| Kuukausittainen kokonaiskäyttö tilausta kohden | {serviceRootAzure}/usage?$apply=groupby((SubscriptionName,DateKey),aggregate(usage with sum as TotalUsage))&$orderby=SubscriptionName,DateKey |
EnrollmentProjection-entiteetti (Azuren päästöille)
Edustaa kalenterivuoden jäljellä olevan osan ennustettuja päästöjä viiden viime kuukauden keskiarvon perusteella. Tarkoitettu vuotuisille visualisoinnille.
| Ominaisuus | Tyyppi | Huomautuksia |
|---|---|---|
| dateKey | int32 | Päivämäärä muodossa vvvvkkpp; pp on aina 01. |
| enrollmentId | merkkijono | Kutsutaan myös laskutustilin tunnukseksi. |
| actualEmissions | liukuluku | Sisältyy vain menneisiin päivämääriin (mtCO2e). |
| projectedEmissions | liukuluku | Perustuu liukuvaan keskiarvoon enintään viiden edellisen kuukauden ajalta kuluvan vuoden toteutuneiden tietojen (mtCO2e) perusteella. |
| actualUsage | liukuluku | Kuuluu vain menneille päivämäärille. |
| projectedUsage | liukuluku | Perustuu liukuvaan keskiarvoon enintään viiden edellisen kuukauden ajalta kuluvan vuoden toteutuneiden tietojen perusteella. |
EnrollmentProjection-entiteetin näytekyselyt (Azuren päästöille)
| Kyselyn tyyppi | Esimerkki: | Muistiinpano |
|---|---|---|
| Ennusteet 7-2022 jälkeen | {serviceRootAzure}/projections?$filter=dateKey gt 20220701 | |
| Koko vuoden kaikki ennusteet | {serviceRootAzure}/projections |
Tärkeä
Microsoft Cloud for Sustainability -ohjelmointirajapinta on tällä hetkellä esiversio, ja se voi muuttua. Päästöjen historiatiedot saatetaan myös päivittää sitä mukaa, kun Microsoft tekee parannuksia tietojen tarkkuuteen ja täydellisyyteen.
Usein kysytyt kysymykset
Miten Microsoft laskee päästöt ja käytön?
Tietoja Microsoftin laskentatavasta: Microsoft Cloud for Sustainability -ohjelmointirajapinnan laskentatapa.
Mikä on Rownum?
Ohjelmointirajapinta käyttää kohdetta rownum yhtenäistä sivutusta varten. Arvo voi muuttua, joten sovelluksessa ei tulisi olla siihen riippuvuutta.
Mikä on rekisteröintitunnus?
Rekisteröintitunnuksella tarkoitetaan laskutustilin tunnusta. Etsi rekisteröintitunnus ja laskutustilin tunnus Azure-portaalista.
Miten saan valtuutustunnuksen kohdeympäristölleni?
Ohjelmointirajapinta vaatii OAuth-valtuutustunnuksen. We recommend using the Microsoftin todennuskirjasto (MSAL).
Voitko antaa lisätietoja nextLinkin käytöstä sivutuksessa?
Ohjelmointirajapinta palauttaa @odata.nextLink -ominaisuuden, jos tuloksia on enemmän kuin nykyisessä vastauksessa. Jotta saat seuraavan tulossivun, sovelluksesi pitäisi suorittaa toinen GET-toiminto tälle nextLinkille. Viimeisellä sivulla ei ole nextLinkiä.
Tässä koodiesimerkissä on lisätietoja sivutuksesta OData-asiakaskirjaston avulla.
