Del via

OData-spørringseksempler for Cloud for Sustainability-API (forhåndsversjon)

  • Artikkel

Gratis prøveperiode

Viktig!

Noen av eller alle disse funksjonene er tilgjengelig som en del av en forhåndsversjon. Innholdet i og funksjonaliteten kan endres.

OData (Open Data Protocol) er en datatilgangsprotokoll som er bygd på kjerneprotokoller som HTTP. Den bruker allment aksepterte metoder som REST for Internett. Du kan bruke ulike biblioteker og verktøy til å bruke OData-tjenester.

For å hjelpe deg med å bygge dine egne implementeringer basert på Microsoft Cloud for Sustainability-API kan du se gjennom noen av disse ofte forespurte spørringene.

Endre spørringseksemplene slik at de fungerer i målmiljøene:

  • {serviceRoot}: https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}

  • {instanceId}: GUID-en for Cloud for Sustainability-miljøet du vil spørre etter, for eksempel 20aec369-f1c8-4814-a89d-4d449dd7e8a1.

  • {serviceRootM365}: {serviceRoot}/m365

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

  • {enrollmentId}: Registrerings-ID-en, også kjent som faktureringskonto-ID. Eksempel: 12345678.

  • {tenantId}: Microsoft 365 leier-ID.

Merk

Noen API-spørringer inneholder mange resultater og deles på flere sider. API-en returnerer maksimalt 1000 resultater per side. Hvis flere resultater er tilgjengelige, returnerer API-en en @odata.nextLink-egenskap som inneholder en nettadresse til den neste resultatsiden.

EnrollmentEmission-enhet (for Azure-utslipp)

Representerer utslippsdataene for en faktureringskonto, også kalt en registrering.

Egenskap Type Notater
dateKey int32 Dato i formatet ååååmmdd, der dd er alltid 01.
enrollmentId streng Kalles også faktureringskonto-ID.
orgName streng Samme som TP-navn eller øverste overordnede navn.
subscriptionId streng ID for abonnementet.
subscriptionName streng Navn på abonnementet.
azureServiceName streng Navn på en Azure-tjeneste, for eksempel App Service
subService streng For eksempel Azure Storage eller Azure Compute.
azureRegionName streng Azure-område der tjenesten er rullet ut.
område streng Klimagassområde, for eksempel område 1, område 2 eller område 3.
scopeId int32 ID for området.
totalEmissions dobbel Totalt antall utslipp for registrering (mtCO2e).

Eksempelspørringer for EnrollmentEmission-enheten (for Azure-utslipp)

Spørringstype Eksempel
Utslipp etter registrering {serviceRootAzure}/Utslipp
Velg bestemte felter {serviceRootAzure}/utslipp?$Velg=enrollmentId,totalUtslipp,scopeId
Inkluder antall {serviceRootAzure}/utslipp?$count=sann
Begrens resultatantall {serviceRootAzure}/utslipp?$top=100
Sideveksling {serviceRootAzure}/utslipp?$skip=100&$top=50
Filtrer etter område {serviceRootAzure}/utslipp?$filter=ScopeId eq 1
Filtrer og samle {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count som Count, totalEmissions med average som Average, totalEmissions med sum som Sum)
Filtrer og grupper {serviceRootAzure}/emissions?$apply=filter(totalEmissions gt 0,05)/groupby((ScopeId), aggregate($count as Count))'

Microsoft365Emission-enhet (for Microsoft 365-utslipp)

Representerer Microsoft 365-datasenterutslipp knyttet til følgende programmer:

  • Exchange Online
  • SharePoint
  • OneDrive
  • Microsoft Teams
  • Word
  • Excel
  • PowerPoint
  • Outlook
Egenskap Type Notater
dateKey int32 Dato i formatet ååååmmdd, der dd er alltid 01.
tenantId streng ID for leieren.
tenantName streng Navn på leieren.
officeRegionName streng Microsoft 365-datasenterområde.
område streng Klimagassområde, for eksempel område 1, område 2 eller område 3.
totalEmissions dobbel Totalt antall utslipp for registrering (mtCO2e).

Eksempelspørringer for Microsoft365Emission-enheten (for Microsoft 365-utslipp)

Spørringstype Eksempel
Utslipp for leier {serviceRootM365}/leietakers utslipp
Velg bestemte felter {serviceRootM365}/emissions?$Velg=tenantId,totalEmissions,scope
Inkluder antall {serviceRootM365}/tenantemissions?$count=true
Begrens resultatantall {serviceRootM365}/leietakerutslipp?$top=100
Sideveksling {serviceRootM365}/leietakerutslipp?$skip=100&$top=50
Filtrer etter område {serviceRootM365}/tenantemissions?$filter=Scope eq 'FILLMEIN'
Filtrer og samle {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count som Count, totalEmissions med average som Average, totalEmissions med sum som Sum)
Filtrer og grupper {serviceRootM365}/tenantemissions?$apply=filter(totalEmissions gt 0,05)/groupby((Scope), aggregate($count as Count))'

EnrollmentUsage-enhet (for Azure-utslipp)

Representerer en beregnet bruksfaktor for Microsoft-skyressurser.

Egenskap Type Notater
dateKey int32 Dato i formatet ååååmmdd, der dd er alltid 01.
enrollmentId streng Kalles også faktureringskonto-ID.
orgName streng Samme som TP-navn eller øverste overordnede navn.
subscriptionId streng ID for abonnementet.
subscriptionName streng Navn på abonnementet.
subService streng For eksempel Azure Storage eller Azure Compute.
azureRegionName streng Azure-område der tjenesten er rullet ut.
bruk dobbel Total bruk av oppføringen. Har ikke enheten fordi den representerer normalisert bruk av tjenesten i det angitte området.

Hvis du vil ha mer informasjon om Microsofts beregningsmetoder, kan du gå til Beregningsmetode for Microsoft Cloud for Sustainability-API.|

Eksempelspørringer for EnrollmentUsage-enheten

Spørringstype Eksempel Merk
Alle bruksdata {serviceRootAzure}/bruk
Total bruk etter måned per abonnement {serviceRootAzure}/usage?$apply=groupby((SubscriptionName,DateKey),aggregate(bruk med sum som TotalUsage))&$orderby=SubscriptionName,DateKey

EnrollmentProjection-enhet (for Azure-utslipp)

Representerer anslåtte utslipp for resten av kalenderåret, basert på et glidende gjennomsnitt for de forrige fem månedene. Beregnet for årlige visualiseringer.

Egenskap Type Notater
dateKey int32 Dato i formatet ååååmmdd, der dd er alltid 01.
enrollmentId streng Kalles også faktureringskonto-ID.
actualEmissions dobbel Bare inkludert for tidligere datoer (mtCO2e).
projectedEmissions dobbel Basert på et glidende gjennomsnitt av de forrige fem månedene eller mindre, basert på de faktiske dataene som er tilgjengelige for inneværende år (mtCO2e).
actualUsage dobbel Bare inkludert for tidligere datoer.
projectedUsage dobbel Basert på et glidende gjennomsnitt av de forrige fem månedene eller mindre, basert på de faktiske dataene som er tilgjengelige for inneværende år.

Eksempelspørringer for EnrollmentProjection-enheten (for Azure-utslipp)

Spørringstype Eksempel Merk
Projeksjoner etter 7-2022 {serviceRootAzure}/projeksjoner?$filter=dateKey gt 20220701
Alle projeksjoner for år {serviceRootAzure}/Anslag

Viktig

Microsoft Cloud for Sustainability-API-en er i forhåndsversjon for øyeblikket og kan endres. Historiske utslippstall kan også bli oppdatert etter hvert som Microsoft gjør forbedringer av datanøyaktighet og fullstendighet.

VANLIGE SPØRSMÅL

Hvordan beregner Microsoft utslipp og bruk?

Hvis du vil ha informasjon om Microsofts beregningsmetoder, kan du gå til Beregningsmetode for Microsoft Cloud for Sustainability-API.

Hva er Rownum?

API-en bruker rownum for konsekvent paginering. Verdien kan endres, så programmet bør ikke være avhengig av den.

Hva er en registrerings-ID?

En registrerings-ID henviser til en faktureringskonto-ID. Finn registrerings-ID-en og faktureringskonto-ID-en i Azure-portalen.

Hvordan henter jeg et godkjenningstoken for målmiljøet?

API-en krever et OAuth-godkjenningstoken. Vi anbefaler at du bruker Microsoft Authentication Library (MSAL).

API-en returnerer egenskapen @odata.nextLink hvis det er flere resultater enn det som returneres i gjeldende svar. Appen skal utføre en ny GET på denne nextLink for å hente den neste siden med resultater. Den siste siden inneholder ikke en nextLink. Utforsk dette kodeeksemplet hvis du vil ha mer informasjon om paginering med et OData-klientbibliotek.

📄 Produktside
🎓 Opplæring

✅ Gratis prøvekanal
🎥 YouTube

💻 Fellesskap
LinkedIn-ikon.LinkedIn gruppe