OData-frågeexempel för API:t Cloud for Sustainability API (förhandsversion)
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 ställa en fråga till, till exempel 20aec369-f1c8-4814-a89d-4d449dd7e8a1.
{serviceRootM365}:
{serviceRoot}/m365{serviceRootAzure}:
{serviceRoot}/enrollments/{enrollmentId}{enrollmentId}: ID för registrering, även kallat "faktureringskonto-ID". Exempel: 12345678.
{tenantId}: Microsoft 365 klientorganisations-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".
| Property | Type | Anteckningar |
|---|---|---|
| dateKey | int32 | Datum i ååååmmdd-format; dd är alltid 01. |
| enrollmentId | string | Kallas även "faktureringskonto-ID". |
| orgName | string | |
| subscriptionId | string | |
| subscriptionName | string | |
| azureServiceName | string | |
| subService | string | Till exempel Azure Storage eller Azure Compute. |
| azureRegionName | string | |
| omfattning | string | |
| scopeId | int32 | |
| totalEmissions | dubbel |
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}/emissions?$select=enrollmentId,totalEmissions,scopeId |
| Inkludera antal | {serviceRootAzure}/emissions?$count=true |
| Begränsa antal i resultat | {serviceRootAzure}/emissions?$top=100 |
| Sidnumrering | {serviceRootAzure}/emissions?$skip=100&$top=50 |
| Filtrera efter omfattning | {serviceRootAzure}/emissions?$filter=ScopeId eq 1 |
| Filtrera och samla | {serviceRootAzure}/emissions?$apply=filter(ScopeId eq 1)/aggregate($count as Count, totalEmissions with average as Average, totalEmissions with sum as Sum) |
| Filtrera gruppera | {serviceRootAzure}/emissions?$apply=filter(totalEmissions gt 0.05)/groupby((ScopeId), aggregate($count as Count))` |
Microsoft365Emission-entitet (för M365-utsläpp)
Representerar Microsoft 365 datacenter-utsläpp som är associerat med följande program:
- Exchange Online
- SharePoint
- OneDrive
- Microsoft Teams
- Word
- Excel
- PowerPoint
- Outlook
| Property | Type | Anteckningar |
|---|---|---|
| dateKey | int32 | Datum i ååååmmdd-format; dd är alltid 01. |
| tenantId | string | |
| tenantName | string | |
| officeRegionName | string | Microsoft 365 datacenter region |
| omfattning | string | en av Scope1, Scope2, Scope3 |
| totalEmissions | dubbel |
Exempelfrågor för entiteten Microsoft365Emission (för M365-utsläpp)
| Frågetyp | Exempel |
|---|---|
| Utsläpp för innehavare | {serviceRootM365}/tenantemissions |
| Välj vissa fält | {serviceRootM365}/emissions?$select=tenantId,totalEmissions,scope |
| Inkludera antal | {serviceRootM365}/tenantemissions?$count=true |
| Begränsa antal i resultat | {serviceRootM365}/tenantemissions?$top=100 |
| Sidnumrering | {serviceRootM365}/tenantemissions?$skip=100&$top=50 |
| Filtrera efter omfattning | {serviceRootM365}/tenantemissions?$filter=Scope eq 'FILLMEIN' |
| Filtrera och samla | {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count as Count, totalEmissions with average as Average, totalEmissions with sum as 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.
| Property | Type | Anteckningar |
|---|---|---|
| dateKey | int32 | Datum i ååååmmdd-format; dd är alltid 01. |
| enrollmentId | string | Kallas även "faktureringskonto-ID". |
| orgName | string | |
| subscriptionId | string | |
| subscriptionName | string | |
| subService | string | Till exempel Azure Storage eller Azure Compute. |
| azureRegionName | string | |
| användning | dubbel | 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),samling(användning 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.
| Property | Type | Anteckningar |
|---|---|---|
| dateKey | int32 | Datum i ååååmmdd-format; dd är alltid 01. |
| enrollmentId | string | Kallas även "faktureringskonto-ID". |
| actualEmissions | dubbel | Ingår endast för datum som passerats. |
| projectedEmissions | dubbel | Baserat på ett glidande genomsnitt för de föregående fem månaderna. |
| actualUsage | dubbel | Ingår endast för datum som passerats. |
| projectedUsage | dubbel | Baserat på ett glidande genomsnitt för de föregående fem månaderna. |
Exempelfrågor för entiteten EnrollmentProjection (för Azure-utsläpp)
| Frågetyp | Exempel | Kommentar |
|---|---|---|
| Beräkningar efter 7-2022 | {serviceRootAzure}/projections?$filter=dateKey gt 20220701 | |
| Alla beräkningar för år | {serviceRootAzure}/beräkningar |
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. Du hittar ID:n för registrering och faktureringskonto 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).
Kan du ge mer information om hur du använder nextLink för sidnumrering?
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 kodexempelet om du vill ha mer information om sidnumrering med ett OData-klientbibliotek.
Se även
API-översikt för Cloud for SustainabilityMicrosoft Cloud for Sustainability Beräkningsmetodik för APIMicrosoft Cloud for Sustainability API