Jaa

Cloud for Sustainability -ohjelmointirajapintojen (esiversio) OData-kyselyesimerkkejä

  • Artikkeli

Ilmainen kokeilu

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}: Cloud for Sustainability -ympäristön GUID-tunnus, johon haluat tehdä kyselyn, kuten 20aec369-f1c8-4814-a89d-4d449dd7e8a1.

  • {serviceRootM365}: {serviceRoot}/m365

  • {serviceRootAzure}: {serviceRoot}/enrollments/{enrollmentId}

  • {enrollmentId}: Rekisteröintitunnus, jota kutsutaan myös laskutustilin tunnukseksi. 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 Ylätason päänimi.
subscriptionId merkkijono Tilauksen tunnus.
subscriptionName merkkijono Tilauksen nimi.
azureServiceName string Azure-palvelun nimi, kuten Sovelluspalvelu
subService string 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}/Päästöjä
Valitse tietyt kentät {serviceRootAzure}/päästöt?$select=enrollmentId,totalEmissions,scopeId
Sisällytä määrä {serviceRootAzure}/päästöt?$count=tosi
Rajoita tulosten määrää {serviceRootAzure}/päästöt?$top=100
Sivutus {serviceRootAzure}/päästöt?$skip=100&$top=50
Suodata vaikutusalueen mukaan {serviceRootAzure}/päästöt?$filter=ScopeId eq 1
Suodata ja koosta {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count kuten Count, totalEmissions keskiarvo keskiarvona, totalEmissions summalla summana)
Suodata ja ryhmittele {serviceRootAzure}/päästöt?$apply=suodatin(yhteensäPäästöt gt 0,05)/groupby((ScopeId), aggregaatti($count kuten Count))"

Microsoft365Emission-entiteetti (Microsoft 365 -päästöt)

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 (Microsoft 365 -päästöjen) esimerkkikyselyt

Kyselyn tyyppi Esimerkki:
Vuokraajan päästöt {serviceRootM365}/vuokralaisen päästöt
Valitse tietyt kentät {serviceRootM365}/päästöt?$select=tenantId,totalEmissions,scope
Sisällytä määrä {serviceRootM365}/vuokralaispäästöt?$count=tosi
Rajoita tulosten määrää {serviceRootM365}/vuokralaisten päästöt?$top=100
Sivutus {serviceRootM365}/vuokralaispäästöt?$skip=100&$top=50
Suodata vaikutusalueen mukaan {serviceRootM365}/vuokralaispäästöt?$filter=Scope eq 'FILLMEIN'
Suodata ja koosta {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count kuten Count, totalEmissions keskiarvo keskiarvona, totalEmissions summalla summana)
Suodata ja ryhmittele {serviceRootM365}/vuokralaispäästöt?$apply=suodatin(yhteensäPäästöt gt 0,05)/groupby((laajuus), aggregaatti($count kuten määrä))"

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}/käyttö
Kuukausittainen kokonaiskäyttö tilausta kohden {serviceRootAzure}/usage?$apply=groupby((SubscriptionName,DateKey),aggregate(käyttö summalla 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}/ennusteet?$filter=dateKey gt 20220701
Koko vuoden kaikki ennusteet {serviceRootAzure}/Ennusteet

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öintitunnuksesi ja laskutustilisi tunnus Azure-portaalista.

Miten saan valtuutustunnuksen kohdeympäristölleni?

Ohjelmointirajapinta edellyttää OAuth-valtuutustunnusta. We recommend using the Microsoftin todennuskirjasto (MSAL).

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 merkkijonoa nextLink. Tässä koodiesimerkissä on lisätietoja sivutuksesta OData-asiakaskirjaston avulla.

📄 Tuotesivu
🎓 Koulutus

✅ Ilmainen kokeilukanava
🎥 YouTube

💻 Yhteisö
LinkedIn-kuvake.LinkedIn ryhmä