Dela via

OData-frågeexempel för API:t Cloud for Sustainability API (förhandsversion)

  • Artikel

Kostnadsfri provperiod

Viktigt

Några eller alla dessa funktioner ingår som en del av en förhandsversion. Innehållet och funktionerna kan komma att ändras.

Open Data Protocol (OData) är ett protokoll för dataåtkomst som bygger på kärnprotokoll som till exempel HTTP. För den används vanliga metoder som REST för webben. Du kan använda olika typer av bibliotek och verktyg när du använder OData-tjänster.

Om du behöver hjälp med att skapa dina egna implementeringar baserat på API:t Microsoft Cloud for Sustainability kan du granska vissa av dessa ofta begärda exempelfrågor.

Ändra frågeexemplen så att de fungerar i dina målmiljöer:

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

  • {instanceId}: GUID för den Cloud for Sustainability-miljö som du vill fråga, till exempel 20aec369-f1c8-4814-a89d-4d449dd7e8a1.

  • {serviceRootM365}: {serviceRoot}/m365

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

  • {enrollmentId}: Registrerings-ID, även kallat faktureringskonto-ID. Exempel: 12345678.

  • {tenantId}: Microsoft 365 tenant ID.

Kommentar

Vissa API-frågor kommer att innehålla många resultat och delas upp på flera sidor. API:t returnerar maximalt 1 000 resultat per sida. Om det finns fler resultat returnerar API:t en egenskap av typen @odata.nextLink som innehåller en URL till nästa sida med resultat.

Entitet EnrollmentEmission (för Azure-utsläpp)

Representerar utsläppsdata för ett faktureringskonto, även kallat "registrering".

Egenskap Typ Anteckningar
dateKey int32 Datum i ååååmmdd-format; dd är alltid 01.
enrollmentId sträng Kallas även "faktureringskonto-ID".
orgName sträng Samma som TP-namn eller Överordnat namn.
subscriptionId sträng Prenumerationens ID.
subscriptionName sträng Prenumerationens namn.
azureServiceName sträng Namnet på en Azure-tjänst, till exempel App Service
subService sträng Till exempel Azure Storage eller Azure Compute.
azureRegionName sträng Den Azure-region där tjänsten distribueras.
omfattning sträng Omfattning för växthusgaser, till exempel omfattning1, omfattning 2 eller omfattning 3.
scopeId int32 Omfattningens ID.
totalEmissions dubbel Totala utsläpp för posten (mtCO2e.).

Exempelfrågor för entiteten EnrollmentEmission (för Azure-utsläpp)

Frågetyp Exempel
Utsläpp efter registrering {serviceRootAzure}/Utsläpp
Välj vissa fält {serviceRootAzure}/utsläpp?$Välj=enrollmentId,totalEmissions,scopeId
Inkludera antal {serviceRootAzure}/utsläpp?$count=sant
Begränsa antal i resultat {serviceRootAzure}/utsläpp?$top=100
Sidnumrering {serviceRootAzure}/utsläpp?$skip=100&$top=50
Filtrera efter omfattning {serviceRootAzure}/utsläpp?$filter=ScopeId eq 1
Filtrera och samla {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count som Antal, totalEmissions med genomsnitt som Genomsnitt, totalEmissions med summa som Summa)
Filtrera gruppera {serviceRootAzure}/utsläpp?$apply=filter(totalEmissions gt 0.05)/groupby((ScopeId), aggregate($count som Count))'

Entiteten Microsoft365Emission (för Microsoft 365-emissioner)

Representerar Microsoft 365 datacenter-utsläpp som är associerat med följande program:

  • Exchange Online
  • SharePoint
  • OneDrive
  • Microsoft Teams
  • Word
  • Excel
  • PowerPoint
  • Outlook
Egenskap Typ Anteckningar
dateKey int32 Datum i ååååmmdd-format; dd är alltid 01.
tenantId sträng Klientorganisationens ID.
tenantName sträng Namn på klientorganisationen.
officeRegionName sträng Microsoft 365-datacenterregion.
omfattning sträng Omfattning för växthusgaser, till exempel omfattning1, omfattning 2 eller omfattning 3.
totalEmissions dubbel Totala utsläpp för posten (mtCO2e.).

Exempelfrågor för entiteten Microsoft365Emission (för Microsoft 365-emissioner)

Frågetyp Exempel
Utsläpp för innehavare {serviceRootM365}/hyresgästutsläpp
Välj vissa fält {serviceRootM365}/utsläpp?$Välj=tenantId,totalEmissions,scope
Inkludera antal {serviceRootM365}/tenantemissions?$count=true
Begränsa antal i resultat {serviceRootM365}/hyresgästutsläpp?$top=100
Sidnumrering {serviceRootM365}/hyresgästutsläpp?$skip=100&$top=50
Filtrera efter omfattning {serviceRootM365}/tenantemissions?$filter=Omfattning eq 'FILLMEIN'
Filtrera och samla {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count som Count, totalEmissions med genomsnitt som Average, totalEmissions med sum som Sum)
Filtrera gruppera {serviceRootM365}/tenantemissions?$apply=filter(totalEmissions gt 0.05)/groupby((Scope), aggregate($count as Count))'

Entitet EnrollmentUsage (för Azure-utsläpp)

Representerar en beräknad användningsfaktor för Microsoft Cloud-resurser.

Egenskap Typ Anteckningar
dateKey int32 Datum i ååååmmdd-format; dd är alltid 01.
enrollmentId sträng Kallas även "faktureringskonto-ID".
orgName sträng Samma som TP-namn eller Överordnat namn.
subscriptionId sträng Prenumerationens ID.
subscriptionName sträng Prenumerationens namn.
subService sträng Till exempel Azure Storage eller Azure Compute.
azureRegionName sträng Den Azure-region där tjänsten distribueras.
användning dubbel Total användning av posten. Har inte enheten eftersom den representerar en normaliserad användning av tjänsten i angiven region.

Mer information om Microsofts beräkningsmetodik finns i Metodik för API-beräkning för Microsoft Cloud for Sustainability.|

Exempelfrågor för EnrollmentUsage

Frågetyp Exempel Kommentar
Alla användningsdata {serviceRootAzure}/användning
Total användning per månad per prenumeration {serviceRootAzure}/usage?$apply=groupby((SubscriptionName,DateKey),aggregate(usage med summa som TotalUsage))&$orderby=SubscriptionName,DateKey

Entitet EnrollmentProjection (för Azure-utsläpp)

Representerar projekterade produkter för återstoden av kalenderåret baserat på ett glidande medelvärde för föregående fem månader. Avsedd för årliga visualiseringar.

Egenskap Typ Anteckningar
dateKey int32 Datum i ååååmmdd-format; dd är alltid 01.
enrollmentId sträng Kallas även "faktureringskonto-ID".
actualEmissions dubbel Ingår endast för tidigare datum (mtCO2e).
projectedEmissions dubbel Baserat på ett glidande medelvärde för föregående fem månader eller mindre, baserat på faktiska data för innevarande år (mtCO2e).
actualUsage dubbel Ingår endast för datum som passerats.
projectedUsage dubbel Baserat på ett glidande medelvärde för föregående fem månader eller mindre, baserat på faktiska data för innevarande år.

Exempelfrågor för entiteten EnrollmentProjection (för Azure-utsläpp)

Frågetyp Exempel Kommentar
Beräkningar efter 7-2022 {serviceRootAzure}/projektioner?$filter=dateKey gt 20220701
Alla beräkningar för år {serviceRootAzure}/Prognoser

Viktigt!

API:t Microsoft Cloud for Sustainability förhandsgranskas för närvarande och kan komma att ändras. Dina tidigare utsläppssiffror kan också komma att uppdateras i takt med att Microsoft gör förbättringar av datans precision och fullständighet.

Vanliga frågor och svar

Hur beräknar Microsoft utsläpp och användning?

Mer information om Microsofts beräkningsmetodik finns i Metodik för API-beräkning för Microsoft Cloud for Sustainability.

Vad är Rownum?

API:t använder rownum för en konsekvent sidnumrering. Värdet kan komma att ändras, varför programmet inte bör vara beroende av det.

Vad är ID-nummer för registrering?

ID för registrering avser ett ID för faktureringskonto. Hitta ditt registrerings-ID och faktureringskonto-ID i Azure-portalen.

Hur får jag en autentiseringstoken för min målmiljö?

API kräver en OAuth autentiseringstoken. Vi rekommenderar att du använder Microsoft autentiseringsbibliotek (MSAL).

API returnerar en @odata.nextLink egenskap om det finns fler resultat än vad som returneras i det aktuella svaret. Din app ska utföra ännu en GET på den här länken för att få nästa sida med resultat. Den sista sidan innehåller ingen nästa länk. Utforska det här kodexemplet om du vill ha mer information om sidnumrering med ett OData-klientbibliotek.

📄 Produktsida
🎓 Utbildning

✅ Kanal för kostnadsfri provperiod
🎥 YouTube

💻 Gemenskap
LinkedIn-ikon.LinkedIn grupp