Del via

Eksempler på OData-forespørgsler til Cloud for Sustainability-API (forhåndsversion)

  • Artikel

Gratis prøveversion

Vigtige oplysninger

Nogle eller alle af disse funktioner, der er angivet i dette emne, er tilgængelige som del af en forhåndsversion. Indholdet og funktionerne kan ændres.

OData (Open Data Protocol) er en dataadgangsprotokol, der er baseret på kerneprotokoller som HTTP. Der bruges almindeligt accepterede metoder, f.eks. REST til internettet. Du kan bruge forskellige biblioteker og værktøjer til at forbruge OData-tjenester.

For at få hjælp til at oprette dine egne implementeringer baseret på Microsoft Cloud for Sustainability-API'er kan du gennemse nogle ofte anmodede eksempler på forespørgsler.

Rediger forespørgselseksemplerne, så de fungerer i dine destinationsmiljøer:

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

  • {instanceId}: Det GUID for det Cloud for Sustainability-miljø, du vil forespørge på, f.eks. 20aec369-f1c8-4814-a89d-4d449dd7e8a1.

  • {serviceRootM365}: {serviceRoot}/m365

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

  • {enrollmentId}: Tilmeldings-id'et, også kendt som faktureringskonto-id. Eksempel: 12345678.

  • {tenantId}: Microsoft 365 lejer-id.

Bemærk

Nogle API-forespørgsler indeholder mange resultater og opdeles over flere sider. API'en returnerer højst 1000 resultater pr. side. Hvis der er flere tilgængelige resultater, returnerer API'en en @odata.nextLink-egenskab, som indeholder en URL-adresse til næste side med resultater.

EnrollmentEmission-objekt (til Azure-udledninger)

Repræsenterer udledningsdataene for en faktureringskonto, også kaldet en tilmelding.

Egenskab Skriv Bemærkninger
dateKey int32 Dato i yyyymmdd-format, dd er altid 01.
enrollmentId streng Også kaldet faktureringskonto-id.
orgName streng Det samme som TP-navn eller Overordnet navn.
subscriptionId streng Id'et for abonnementet.
subscriptionName streng Navn på abonnementet.
azureServiceName streng Navnet på en Azure-tjeneste, f.eks. Apptjeneste
subService streng Det kan f.eks. være Azure Storage eller Azure Compute.
azureRegionName streng Azure-området, hvor tjenesten er implementeret.
omfang streng Drivhusgasomfang,f.eks. omfang 1, omfang 2 eller omfang 3.
scopeId int32 Id for omfanget.
totalEmissions dobbelt Samlet værdi for posten (mtCO2e).

Eksempelforespørgsler for objektet EnrollmentEmission (til Azure-udledninger)

Forespørgselstype Eksempel
Udledninger efter tilmelding {serviceRootAzure}/Emissioner
Vælg visse felter {serviceRootAzure}/emissions?$select=enrollmentId,totalEmissions,scopeId
Medtag antal {serviceRootAzure}/emissioner?$count=sand
Begræns resultatantal {serviceRootAzure}/emissioner?$top=100
Sideopdeling {serviceRootAzure}/emissioner?$skip=100&$top=50
Filtrer efter omfang {serviceRootAzure}/emissioner?$filter=ScopeId eq 1
Filtrer og aggreger {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count som Count, totalEmissions med average som Average, totalEmissions med sum som Sum)
Filtrer og gruppér {serviceRootAzure}/emissions?$apply=filter(totalEmissions gt 0,05)/groupby((ScopeId), aggregate($count as Count))"

Microsoft365Emission-objekt (til Microsoft 365-udledninger)

Repræsenterer Microsoft 365-datacenterudledninger, der er knyttet til følgende programmer:

  • Exchange Online
  • SharePoint
  • OneDrive
  • Microsoft Teams
  • Word
  • Excel
  • PowerPoint
  • Outlook
Egenskab Type Bemærkninger
dateKey int32 Dato i yyyymmdd-format, dd er altid 01.
tenantId streng Id for lejeren.
tenantName streng Navnet på lejeren.
officeRegionName streng Microsoft 365-datacenterområde.
omfang streng Drivhusgasomfang,f.eks. omfang 1, omfang 2 eller omfang 3.
totalEmissions dobbelt Samlet værdi for posten (mtCO2e).

Eksempelforespørgsler for Microsoft365Emission-objektet (til Microsoft 365-udledninger)

Forespørgselstype Eksempel
Udledninger til lejer {serviceRootM365}/lejeremissioner
Vælg visse felter {serviceRootM365}/emissioner?$select=tenantId;totalEmissioner;omfang
Medtag antal {serviceRootM365}/tenantemissions?$count=sand
Begræns resultatantal {serviceRootM365}/lejeremissioner?$top=100
Sideopdeling {serviceRootM365}/lejeremissioner?$skip=100&$top=50
Filtrer efter omfang {serviceRootM365}/tenantemissions?$filter=Scope eq 'FILLMEIN'
Filtrer og aggreger {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count som Count, totalEmissions med average som Average, totalEmissions med sum som Sum)
Filtrer og gruppér {serviceRootM365}/tenantemissions?$apply=filter(totalEmissions gt 0,05)/groupby((Scope), aggregate($count as Count))«

EnrollmentUsage-objekt (til Azure-udledninger)

Repræsenterer en beregnet brugsfaktor for Microsoft-cloudressourcer.

Egenskab Skriv Bemærkninger
dateKey int32 Dato i yyyymmdd-format, dd er altid 01.
enrollmentId streng Også kaldet faktureringskonto-id.
orgName streng Det samme som TP-navn eller Overordnet navn.
subscriptionId streng Id'et for abonnementet.
subscriptionName streng Navn på abonnementet.
subService streng Det kan f.eks. være Azure Storage eller Azure Compute.
azureRegionName streng Azure-området, hvor tjenesten er implementeret.
forbrug dobbelt Samlet brug af posten. Har ikke enheden, da den repræsenterer en normal brug af servicen i det angivne område.

Du kan finde flere oplysninger om Microsofts beregningsmetode ved at gå til Microsoft Cloud for Sustainability-API-beregningsmetoden.|

Eksempelforespørgsler for objektet EnrollmentUsage

Forespørgselstype Eksempel Bemærk
Alle brugsdata {serviceRootAzure}/brug
Samlet brug pr. måned pr. abonnement {serviceRootAzure}/usage?$apply=groupby((SubscriptionName,DateKey),aggregate(usage with sum as TotalUsage))&$orderby=SubscriptionName,DateKey

EnrollmentProjection-objekt (til Azure-udledninger)

Repræsenterer beregnede udledninger for resten af kalenderåret baseret på et glidende gennemsnit af de foregående fem måneder. Beregnet til årlige visualiseringer.

Egenskab Type Bemærkninger
dateKey int32 Dato i yyyymmdd-format, dd er altid 01.
enrollmentId streng Også kaldet faktureringskonto-id.
actualEmissions dobbelt Kun medtaget i forbindelse med tidligere datoer (mtCO2e).
projectedEmissions dobbelt Baseret på en glidende gennemsnit over de foregående fem måneder eller mindre på baggrund af de faktiske data, der er tilgængelige for det indeværende år (mtCO2e).
actualUsage dobbelt Kun medtaget for tidligere datoer.
projectedUsage dobbelt Baseret på en glidende gennemsnit over de foregående fem måneder eller mindre på baggrund af de faktiske data, der er tilgængelige for det indeværende år.

Eksempelforespørgsler for objektet EnrollmentProjection (til Azure-udledninger)

Forespørgselstype Eksempel Bemærk
Projektioner efter 7-2022 {serviceRootAzure}/projektioner?$filter=dateKey gt 20220701
Alle projektioner for år {serviceRootAzure}/Fremskrivninger

Vigtigt

Microsoft Cloud for Sustainability-API'en findes i øjeblikket som forhåndsversion og kan blive ændret. Dine historiske udledningstal opdateres muligvis også, efterhånden som Microsoft foretager forbedringer af dataenes præcision og fuldstændighed.

OFTE STILLEDE SPØRGSMÅL

Hvordan beregner Microsoft udledninger og brug?

Du kan finde oplysninger om Microsofts beregningsmetode ved at gå til Microsoft Cloud for Sustainability-API-beregningsmetoden.

Hvad erRownum?

API'en bruger rownum til at sikre ensartet sideinddeling. Værdien kan blive ændret, så dit program bør ikke have afhængighed til den.

Hvad er et tilmeldings-id?

Et tilmeldings-id henviser til et faktureringskonto-id. Find dit tilmeldings-id og faktureringskonto-id på Azure-portalen.

Hvordan anskaffer jeg et autorisationstoken til mit destinationsmiljø?

API'en kræver et OAuth-godkendelsestoken. Vi anbefaler, at du bruger Godkendelsesbibliotek til Microsoft (MSAL).

API'en returnerer en @odata.nextLink-egenskab, hvis der er flere resultater end dem, der returneres i det aktuelle svar. Din app skal udføre en anden GET på denne nextLink for at få den næste side med resultater. Den sidste side indeholder ikke et nextLink. Undersøg dette kodeeksempel for at få flere oplysninger om sideinddeling med et OData-klientbibliotek.

📄 Produktside
🎓 Uddannelse

✅ Gratis prøvekanal
🎥 YouTube

💻 Fællesskab
LinkedIn-ikon.LinkedIn gruppe