Sdílet prostřednictvím

Příklady dotazů OData rozhraní API Cloud for Sustainability (Preview)

  • Článek

Bezplatná zkušební verze

Důležité

Některé nebo všechny tyto funkce jsou k dispozici jako součást vydání verze Preview. Obsah a funkce se mohou změnit.

Open Data Protocol (OData) je protokol pro přístup k datům postavený na základních protokolech, jako je HTTP. Využívá běžně přijímané metodiky, jako je REST pro web. Ke konzumaci služeb OData lze používat různé druhy knihoven a nástrojů.

Jako pomůcku při vytváření vlastních implementací založených na rozhraní API Microsoft Cloud for Sustainability si můžete prohlédnout některé z těchto často požadovaných příkladů dotazů.

Ukázky dotazů si upravte, aby fungovaly v cílových prostředích:

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

  • {instanceId}: GUID prostředí Cloud for Sustainability, na které se chcete dotazovat, jako např 20aec369-f1c8-4814-a89d-4d449dd7e8a1.

  • {serviceRootM365}: {serviceRoot}/m365

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

  • {enrollmentId}: ID registrace, známé také jako ID fakturačního účtu. Příklad: 12345678.

  • {tenantId}: Microsoft 365 ID nájemce.

Poznámka:

Některé dotazy API budou obsahovat mnoho výsledků a budou rozděleny na více stránek. Rozhraní API vrací maximálně 1000 výsledků na stránku. Pokud je k dispozici více výsledků, rozhraní API vrátí vlastnost @odata.nextLink obsahující adresu URL na další stránku výsledků.

Entita EnrollmentEmission (pro emise Azure)

Představuje údaje o emisích pro fakturační účet, nazývaný také prováděcí smlouva.

Vlastnost Type Notes
dateKey int32 Datum ve formátu rrrrmmdd, dd je vždy 01.
enrollmentId řetězec Také označované jako ID fakturačního účtu.
orgName řetězec Stejné jako Název TP nebo Název nejvyšší nadřazené položky.
subscriptionId řetězec ID odběru.
subscriptionName řetězec Název odběru.
azureServiceName string Název služby Azure, například App Service
subService string Například Azure Storage nebo Azure Compute.
azureRegionName řetězec Oblast Azure, kde je služba nasazena.
rozsah řetězec Oblast skleníkových plynů, například oblast 1, oblast 2 nebo oblast 3.
scopeId int32 ID oblasti.
totalEmissions číslo s dvojitou přesností Celkové emise pro záznam (mtCO2e).

Vzorové dotazy pro entitu EnrollmentEmission (pro emise Azure)

Typ dotazu Příklad
Emise podle registrace {serviceRootAzure}/emise
Vybrat určitá pole {serviceRootAzure}/emise?$select=enrollmentId,totalEmissions,scopeId
Zahrnout počet {serviceRootAzure}/emise?$count=true
Omezit počet výsledků {serviceRootAzure}/emise?$top=100
Stránkování {serviceRootAzure}/emise?$skip=100&$top=50
Filtrovat podle oblasti {serviceRootAzure}/emise?$filter=ScopeId eq 1
Filtrovat a agregovat {serviceRootAzure}/emise?$apply=filter(ScopeId eq 1)/aggregate($count as Count, totalEmissions with average as Average, totalEmissions with sum assum)
Filtrovat a seskupit {serviceRootAzure}/emise?$apply=filter(totalEmissions gt 0,05)/groupby((ScopeId), agregát($count as Count))`

Entita Microsoft365Emission (pro emise Microsoft 365)

Představuje emise datového centra Microsoft 365 spojené s následujícími aplikacemi:

  • Exchange Online
  • SharePoint
  • OneDrive
  • Microsoft Teams
  • Word
  • Aplikace Excel
  • PowerPoint
  • Outlook
Vlastnost Type Notes
dateKey int32 Datum ve formátu rrrrmmdd, dd je vždy 01.
tenantId řetězec ID tenanta.
tenantName řetězec Název tenanta.
officeRegionName řetězec Oblast datového centra Microsoft 365.
rozsah řetězec Oblast skleníkových plynů, například oblast 1, oblast 2 nebo oblast 3.
totalEmissions číslo s dvojitou přesností Celkové emise pro záznam (mtCO2e).

Vzorové dotazy pro entitu Microsoft365Emission (pro emise Microsoft 365)

Typ dotazu Příklad
Emise pro tenanta {serviceRootM365}/provize nájemníků
Vybrat určitá pole {serviceRootM365}/emise?$select=tenantId,totalEmissions,scope
Zahrnout počet {serviceRootM365}/tenantemissions?$count=true
Omezit počet výsledků {serviceRootM365}/pronájem nájemců?$top=100
Stránkování {serviceRootM365}/tenantemissions?$skip=100&$top=50
Filtrovat podle oblasti {serviceRootM365}/tenantemissions?$filter=Rozsah eq 'FILLMEIN'
Filtrovat a agregovat {serviceRootserviceRootM365Azure}/tenantemissions?$apply=filter(scope eq 'FILLMEIN')/aggregate($count as Count, totalEmissions with average as Average, totalEmissions with sum as Sum)
Filtrovat a seskupit {serviceRootM365}/tenantemissions?$apply=filter(totalEmissions gt 0,05)/groupby((Rozsah), souhrn ($count as Count))`

Entita EnrollmentUsage (pro emise Azure)

Představuje vypočítaný faktor využití prostředků Microsoft Cloud.

Vlastnost Type Notes
dateKey int32 Datum ve formátu rrrrmmdd, dd je vždy 01.
enrollmentId řetězec Také označované jako ID fakturačního účtu.
orgName řetězec Stejné jako Název TP nebo Název nejvyšší nadřazené položky.
subscriptionId řetězec ID odběru.
subscriptionName řetězec Název odběru.
subService řetězec Například Azure Storage nebo Azure Compute.
azureRegionName řetězec Oblast Azure, kde je služba nasazena.
využití číslo s dvojitou přesností Celkové využití záznamu. Nemá jednotku, protože představuje normalizované použití služby v zadané oblasti.

Další informace o metodologii výpočtu společnosti Microsoft naleznete v části Metodika výpočtu rozhraní API Microsoft Cloud for Sustainability.|

Vzorové dotazy pro entitu EnrollmentUsage

Typ dotazu Příklad Poznámka:
Všechna data o využívání {serviceRootAzure}/používání
Celkové využití podle měsíce na předplatné {serviceRootAzure}/usage?$apply=groupby((Název předplatného,DateKey),aggregate(použití se součtem jako TotalUsage))&$orderby=Název předplatného,DateKey

Entita EnrollmentProjection (pro emise Azure)

Představuje předpokládané emise pro zbytek kalendářního roku na základě klouzavého průměru za předchozích pět měsíců. Určeno pro anualizované vizualizace.

Vlastnost Type Notes
dateKey int32 Datum ve formátu rrrrmmdd, dd je vždy 01.
enrollmentId řetězec Také označované jako ID fakturačního účtu.
actualEmissions číslo s dvojitou přesností Zahrnuto pouze pro minulá data (mtCO2e).
projectedEmissions číslo s dvojitou přesností Na základě klouzavého průměru za předchozích pět měsíců nebo méně na základě skutečných údajů dostupných pro běžný rok (mtCO2e).
actualUsage číslo s dvojitou přesností Zahrnuto pouze pro minulá data.
projectedUsage číslo s dvojitou přesností Na základě klouzavého průměru za předchozích pět měsíců nebo méně na základě skutečných údajů dostupných pro běžný rok.

Vzorové dotazy pro entitu EnrollmentProjection (pro emise Azure)

Typ dotazu Příklad Poznámka:
Projekce po 7-2022 {serviceRootAzure}/projekce?$filter=dateKey gt 20220701
Všechny projekce za rok {serviceRootAzure}/projekce

Důležité

Rozhraní Microsoft Cloud for Sustainability API je aktuálně ve verzi Preview a může se změnit. Vaše historické údaje o emisích mohou být také aktualizovány, protože společnost Microsoft vylepšuje přesnost a úplnost dat.

Často kladené dotazy

Jak společnost Microsoft vypočítává emise a spotřebu?

Informace o metodologii výpočtu společnosti Microsoft naleznete v části Metodika výpočtu rozhraní API Microsoft Cloud for Sustainability.

Co to je Rownum?

Rozhraní API používá rownum pro konzistentní stránkování. Hodnota se může změnit, takže vaše aplikace by na ní neměla být závislá.

Co je to ID prováděcí smlouvy?

ID prováděcí smlouvy odkazuje na ID fakturačního účtu. Najděte své přihlašovací ID a ID fakturačního účtu na portálu Azure.

Jak získám autorizační token pro mé cílové prostředí?

Rozhraní API vyžaduje autorizační token OAuth. Doporučujeme použití Microsoft Authentication Library (MSAL).

Rozhraní API vrátí vlastnost @odata.nextLink, pokud existuje více výsledků, než je vráceno v aktuální odpovědi. Vaše aplikace by měla provést další GET na tomto nextLink, aby se dostala na další stránku výsledků. Poslední stránka neobsahuje nextLink. Prozkoumejte tuto ukázku kódu, kde najdete další údaje o stránkování pomocí klientské knihovny OData.

📄 Stránka produktu
🎓 Výcvik

✅ Bezplatná zkušební verze
🎥 YouTube kanál

💻 Společenství
Ikona LinkedIn. LinkedIn skupina