Sdílet prostřednictvím

Použití rozhraní API k exportu optimalizace emisí uhlíku do dat o emisích Azure

Tento článek vám pomůže pochopit a použít nejnovější rozhraní REST API služby Carbon Service k exportu optimalizace emisí uhlíku do dat o emisích Azure. Údaje o emisích jsou k dispozici pro předchozí měsíc do 19. dne aktuálního měsíce.

Pokud chcete exportovat data o emisích pomocí rozhraní REST API, musíte vytvořit a autorizovat instanční objekt pro přístup k datům o emisích. Instanční objekt pak můžete použít k získání autorizačního tokenu a následnému exportu dat o emisích pomocí rozhraní REST API.

Vytvoření a autorizace instančního objektu

Instanční objekt je aplikace, jejíž tokeny je možné použít k ověření a udělení přístupu ke konkrétním prostředkům Azure pomocí ID Microsoft Entra. Mezi prostředky patří uživatelské aplikace, služby nebo nástroje pro automatizaci.

  1. Vytvořte aplikaci Microsoft Entra a principál služby, který může přistupovat k prostředkům.
  2. Uložte ID tenanta, nové ID klienta a hodnotu tajného klíče klienta pro vaši aplikaci pro použití v žádostech o tokeny.
  3. Aplikace musí mít přiřazenou Carbon Optimization Reader roli pro prostředky, pro které chcete exportovat údaje o emisích. Pokud chcete aplikaci použít k exportu údajů o emisích pro mnoho prostředků, můžete roli přiřadit na úrovni předplatného. Další informace najdete v tématu Přiřazení rolí Azure pomocí webu Azure Portal a přiřazení přístupu k optimalizaci emisí uhlíku v Azure.

Získání autorizačního tokenu

Na příkazovém řádku nebo pomocí klienta odešlete následující POST požadavek. Pomocí URL prostředků https://management.azure.com získejte přístupový token pro API řízení prostředků.

curl -X POST 'https://login.microsoftonline.com/<tennant ID>/oauth2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=<your apps client ID>' \
--data-urlencode 'client_secret=<your apps client secret' \
--data-urlencode 'resource=https://management.azure.com'

Text odpovědi se zobrazí takto:

{
    "token_type": "Bearer",
    "expires_in": "86399",
    "ext_expires_in": "86399",
    "expires_on": "1672826207",
    "not_before": "1672739507",
    "resource": "https://management.azure.com",
    "access_token": "eyJ0eXAiOiJKV1Qi....gpHWoRzeDdVQd2OE3dNsLIvUIxQ"
}

Použijte přístupový token z odpovědi pro použití v následujících požadavcích HTTP.

Export údajů o emisích pomocí rozhraní REST API

K exportu údajů o emisích použijte následující POST požadavek.

POST /providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01
Host: management.azure.com
Content-Type: application/json
Authorization: Bearer \<token value\>

Příklad požadavku a odpovědi

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01

{
  "reportType": "MonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  }
}

Ukázkový výstup

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    }
  ],
  "value": [
    {
      "dataType": "OverallSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05
    }
  ]
}

Tady je příklad pro "curl":

curl --location 'https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXA...2-KgVBNrsvg' \
--data '{
  "reportType": "ItemDetailsReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-05-01",
    "end": "2024-05-01"
  },
  "categoryType": "Resource",
  "orderBy": "LatestMonthEmissions",
  "sortDirection": "Desc",
  "pageSize": 100
}
'

Ukázkový výstup curl:

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permisison required"
    }
  ],
  "value": [
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName1",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName1",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName2",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName2",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName3",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName3",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName4",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName4",
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName5",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName5",
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    }
  ],
  "skipToken": "dGVzZGZhZGZzZnNkZg=="
}

Typy sestav

Optimalizace emisí uhlíku poskytuje různé typy sestav, které vám pomůžou analyzovat data o emisích. Každý typ sestavy slouží k jinému účelu a používá se pro vaše konkrétní potřeby:

Typ sestavy Popis Kdy používat
Celková Souhrnná Zpráva Poskytuje celkové emise uhlíku pro zadaný rozsah kalendářních dat a parametry dotazu a srovnávací hodnoty pro přehled vysoké úrovně. Tento typ sestavy přijímá různé hodnoty v počátečním a koncovém poli v rámci DateRange. Například začátek: 2024-03-01 a konec: 2024-06-01. Požadovaná data sestavy vysoké úrovně
Měsíční souhrnná zpráva Poskytuje údaje o emisích uhlíku po měsících pro zadané parametry dotazu. Tento typ sestavy přijímá různé hodnoty v počátečním a koncovém poli v rámci DateRange. Například začátek: 2024-03-01 a konec: 2024-06-01. Podrobnosti o zadaném měsíci
Zpráva o souhrnu nejlepších položek Poskytuje N položek s nejvyššími emisemi pro zadané filtry dotazů. Tato sestava vrací data pro jeden měsíc najednou, takže vyžaduje stejné hodnoty pro počáteční a koncová pole v rámci dateRange. Najednou se vrátí maximálně N=10 položek. Data pro nejvyšší položky podle kategorie
Měsíční souhrnná zpráva hlavních položek Poskytuje N položek s nejvyššími emisemi za měsíc pro zadaný filtr dotazu. Vrátí údaje o emisích pro prvních N položek po měsících v daném rozsahu kalendářních dat. Najednou se vrátí maximálně N=10 položek. Data pro nejvyšší položky podle kategorií a měsíců
Zpráva o podrobnostech položky Podrobný seznam položek založených na zadaném typu CategoryType (včetně: Resource, ResourceGroup, ResourceType, Location nebo Subscription) pro použití filtru dotazu. Můžete se dotazovat pouze na jeden měsíc najednou. DateRange vyžaduje stejné hodnoty pro počáteční a koncová pole. Údaje o emisích podle kategorie

Parametry rozhraní API pro export emisí

Pro každou z nich reportTypejsou definovány různé parametry dotazu. Následující části obsahují podrobné informace o parametrech dotazu pro každý reportType.

Jméno Popis
ItemDetailsQueryFilter Parametry dotazu pro ItemDetailsReport
MěsíčníSummaryReportQueryFilter Parametry dotazového filtru pro konfiguraci dotazů MonthlySummaryReport.
OverallSummaryReportQueryFilter Parametry dotazového filtru pro konfiguraci dotazů OverallSummaryReport.
TopItemsMonthlySummaryReportQueryFilter Parametry dotazového filtru pro konfiguraci dotazů TopItemsMonthlySummaryReport.
TopItemsSummaryReportQueryFilter Parametry dotazového filtru pro konfiguraci dotazů TopItemsSummaryReport.

Další informace o sestavách rozhraní REST API najdete v tématu Uhlíková služba – výpis sestav emisí uhlíku.

FiltrDotazuPodrobnostiPoložky

Tady jsou parametry dotazu pro ItemDetailsReport.

Jméno Požadovaný Typ Popis
carbonScopeList Pravdivé EmissionScopeEnum[] Seznam rozsahů emisí uhlíku. Povinné. Přijímá jednu nebo více hodnot z EmissionScopeEnum. Například Rozsah1, Rozsah2, Rozsah3 ve formě seznamu. Výstup zahrnuje celkové emise pro zadané oblasti působnosti.
typ kategorie Pravdivé CategoryTypeEnum Určuje typ kategorie pro podrobné údaje o emisích, jako jsou Resource, ResourceGroup, ResourceType, Location nebo Subscription. Viz podporované typy v souboru CategoryTypeEnum.
časové období Pravdivé DateRange Počáteční a koncové datum pro údaje o emisích uhlíku. Povinné. Pro ItemDetailsReport a TopItemsSummaryReport, pouze jeden měsíc dat je podporován najednou, takže počáteční a koncové datum by se měly shodovat v rámci DateRange. Například začátek: 2024-06-01 a konec: 2024-06-01.
řaditPodle Pravdivé OrderByColumnEnum Název sloupce pro seřazení výsledků podle. Viz podporované hodnoty v OrderByColumnEnum.
Velikost stránky Pravdivé celé číslo (int32)

minimum: 1
maximum: 5000		 Počet položek, které se mají vrátit v jednom požadavku, maximální hodnota je 5000.
typ zprávy Pravdivé řetězec:

Zpráva o podrobnostech položky		 ReportType požádal o údaje o emisích uhlíku. Povinné. Určuje, jak se data agregují a zobrazují ve výstupu, jak je vysvětleno v tématu ReportTypeEnum.
sortDirection Pravdivé SortDirectionEnum Směr řazení výsledků Viz podporované hodnoty v SortDirectionEnum.
seznam předplatného Pravdivé string[] Seznam ID předplatného, pro která se požadují údaje o emisích uhlíku. Povinné. Každé ID předplatného by mělo být ve formátu malými písmeny. Maximální délka seznamu je 100.
seznam míst string[] Seznam umístění (zobrazovaný název oblasti Azure) pro údaje o emisích uhlíku, přičemž každé umístění je zadané malými písmeny. Například: east us. Volitelný. Pomocí příkazu az account list-locations -o table můžete najít zobrazované názvy oblastí Azure.
seznamUrlSkupinyZdroju string[] Seznam adres URL skupin prostředků pro údaje o emisích uhlíku Volitelný. Každá adresa URL musí odpovídat formátu /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}a měla by obsahovat všechna malá písmena.
seznamTypůZdroje string[] Seznam typů zdrojů pro údaje o emisích uhlíku Volitelný. Každý typ prostředku by měl být zadán malými písmeny podle formátu microsoft.{service}/{resourceType}. Například: microsoft.storage/storageaccounts.
skipToken řetězec Token stránkování pro načtení další stránky dat Tento token může mít hodnotu null a je vrácen v předchozí odpovědi, jsou-li dostupné jiné datové stránky.

MěsíčníSouhrnnáZprávaDotazovacíFiltr

Tady jsou parametry filtru dotazu pro konfiguraci MonthlySummaryReport dotazů.

Jméno Požadovaný Typ Popis
carbonScopeList Pravdivé EmissionScopeEnum[] Seznam rozsahů emisí uhlíku. Povinné. Přijímá jednu nebo více hodnot z EmissionScopeEnum. Například Rozsah1, Rozsah2, Rozsah3 ve formě seznamu. Výstup zahrnuje celkové emise pro zadané oblasti působnosti.
časové období Pravdivé DateRange Počáteční a koncové datum pro údaje o emisích uhlíku. Povinné. Pro ItemDetailsReport a TopItemsSummaryReport, pouze jeden měsíc dat je podporován najednou, takže počáteční a koncové datum by se měly shodovat v rámci DateRange. Například začátek: 2024-06-01 a konec: 2024-06-01.
typ zprávy Pravdivé řetězec:

Měsíční souhrnná zpráva		 ReportType požádal o údaje o emisích uhlíku. Povinné. Určuje, jak se data agregují a zobrazují ve výstupu, jak je vysvětleno v tématu ReportTypeEnum.
seznam předplatného Pravdivé string[] Seznam ID předplatného, pro která se požadují údaje o emisích uhlíku. Povinné. Každé ID předplatného by mělo být ve formátu malými písmeny. Maximální délka seznamu je 100.
seznam míst string[] Seznam umístění (zobrazovaný název oblasti Azure) pro údaje o emisích uhlíku, přičemž každé umístění je zadané malými písmeny. Například: east us. Volitelný. Pomocí příkazu az account list-locations -o table můžete najít zobrazované názvy oblastí Azure.
seznamUrlSkupinyZdroju string[] Seznam adres URL skupin prostředků pro údaje o emisích uhlíku Volitelný. Každá adresa URL musí odpovídat formátu /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}a měla by obsahovat všechna malá písmena.
seznamTypůZdroje string[] Seznam typů zdrojů pro údaje o emisích uhlíku Volitelný. Každý typ prostředku by měl být zadán malými písmeny podle formátu microsoft.{service}/{resourceType}. Například: microsoft.storage/storageaccounts.

CelkovýSouhrnnýDotazovýFiltrZprávy

Tady jsou parametry filtru dotazu pro konfiguraci dotazů OverallSummaryReport.

Jméno Požadovaný Typ Popis
carbonScopeList Pravdivé EmissionScopeEnum[] Seznam rozsahů emisí uhlíku. Povinné. Přijímá jednu nebo více hodnot z EmissionScopeEnum. Například Rozsah1, Rozsah2, Rozsah3 ve formě seznamu. Výstup zahrnuje celkové emise pro zadané oblasti působnosti.
časové období Pravdivé DateRange Počáteční a koncové datum pro údaje o emisích uhlíku. Povinné. Pro ItemDetailsReport a TopItemsSummaryReport, pouze jeden měsíc dat je podporován najednou, takže počáteční a koncové datum by se měly shodovat v rámci DateRange. Například začátek: 2024-06-01 a konec: 2024-06-01.
typ zprávy Pravdivé řetězec:

Celková Souhrnná Zpráva		 ReportType požádal o údaje o emisích uhlíku. Povinné. Určuje, jak se data agregují a zobrazují ve výstupu, jak je vysvětleno v tématu ReportTypeEnum.
seznam předplatného Pravdivé string[] Seznam ID předplatného, pro která se požadují údaje o emisích uhlíku. Povinné. Každé ID předplatného by mělo být ve formátu malými písmeny. Maximální délka seznamu je 100.
seznam míst string[] Seznam umístění (zobrazovaný název oblasti Azure) pro údaje o emisích uhlíku, přičemž každé umístění je zadané malými písmeny. Například: east us. Volitelný. Pomocí příkazu az account list-locations -o table můžete najít zobrazované názvy oblastí Azure.
seznamUrlSkupinyZdroju string[] Seznam adres URL skupin prostředků pro údaje o emisích uhlíku Volitelný. Každá adresa URL musí odpovídat formátu /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}a měla by obsahovat všechna malá písmena.
seznamTypůZdroje string[] Seznam typů zdrojů pro údaje o emisích uhlíku Volitelný. Každý typ prostředku by měl být zadán malými písmeny podle formátu microsoft.{service}/{resourceType}. Například: microsoft.storage/storageaccounts.

Filtr dotazu pro měsíční shrnutí hlavních položek

Tady jsou parametry filtru dotazu pro konfiguraci TopItemsMonthlySummaryReport dotazů.

Jméno Požadovaný Typ Popis
carbonScopeList Pravdivé EmissionScopeEnum[] Seznam rozsahů emisí uhlíku. Povinné. Přijímá jednu nebo více hodnot z EmissionScopeEnum. Například Rozsah1, Rozsah2, Rozsah3 ve formě seznamu. Výstup zahrnuje celkové emise pro zadané oblasti působnosti.
typ kategorie Pravdivé CategoryTypeEnum Určuje typ kategorie, který má načíst položky s nejvyšším generováním, agregované podle měsíce. Viz podporované typy v souboru CategoryTypeEnum.
časové období Pravdivé DateRange Počáteční a koncové datum pro údaje o emisích uhlíku. Povinné. Pro ItemDetailsReport a TopItemsSummaryReport, pouze jeden měsíc dat je podporován najednou, takže počáteční a koncové datum by se měly shodovat v rámci DateRange. Například začátek: 2024-06-01 a konec: 2024-06-01.
typ zprávy Pravdivé řetězec:

Měsíční souhrnná zpráva hlavních položek		 ReportType požádal o údaje o emisích uhlíku. Povinné. Určuje, jak se data agregují a zobrazují ve výstupu, jak je vysvětleno v tématu ReportTypeEnum.
seznam předplatného Pravdivé string[] Seznam ID předplatného, pro která se požadují údaje o emisích uhlíku. Povinné. Každé ID předplatného by mělo být ve formátu malými písmeny. Maximální délka seznamu je 100.
nejlepší položky Pravdivé celé číslo (int32)

minimum: 1
maximálně: 10		 Počet hlavních položek, které se mají vrátit na základě emisí. Musí být mezi 1 a 10.
seznam míst string[] Seznam umístění (zobrazovaný název oblasti Azure) pro údaje o emisích uhlíku, přičemž každé umístění je zadané malými písmeny. Například: east us. Volitelný. Pomocí příkazu az account list-locations -o table můžete najít zobrazované názvy oblastí Azure.
seznamUrlSkupinyZdroju string[] Seznam adres URL skupin prostředků pro údaje o emisích uhlíku Volitelný. Každá adresa URL musí odpovídat formátu /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}a měla by obsahovat všechna malá písmena.
seznamTypůZdroje string[] Seznam typů zdrojů pro údaje o emisích uhlíku Volitelný. Každý typ prostředku by měl být zadán malými písmeny podle formátu microsoft.{service}/{resourceType}. Například: microsoft.storage/storageaccounts.

Souhrnný přehled hlavních položek: Filtr dotazu

Tady jsou parametry filtru dotazu pro konfiguraci TopItemsSummaryReport queries.

Jméno Požadovaný Typ Popis
carbonScopeList Pravdivé EmissionScopeEnum[] Seznam rozsahů emisí uhlíku. Povinné. Přijímá jednu nebo více hodnot z EmissionScopeEnum. Například Rozsah1, Rozsah2, Rozsah3 ve formě seznamu. Výstup zahrnuje celkové emise pro zadané oblasti působnosti.
typ kategorie Pravdivé CategoryTypeEnum Určuje typ kategorie, pro který se mají načíst položky s nejvyšším generováním. Viz podporované hodnoty definované v CategoryTypeEnum.
časové období Pravdivé DateRange Počáteční a koncové datum pro údaje o emisích uhlíku. Povinné. Pro ItemDetailsReport a TopItemsSummaryReport, pouze jeden měsíc dat je podporován najednou, takže počáteční a koncové datum by se měly shodovat v rámci DateRange. Například začátek: 2024-06-01 a konec: 2024-06-01.
typ zprávy Pravdivé řetězec:

Zpráva o souhrnu nejlepších položek		 ReportType požádal o údaje o emisích uhlíku. Povinné. Určuje, jak se data agregují a zobrazují ve výstupu, jak je vysvětleno v tématu ReportTypeEnum.
seznam předplatného Pravdivé string[] Seznam ID předplatného, pro která se požadují údaje o emisích uhlíku. Povinné. Každé ID předplatného by mělo být ve formátu malými písmeny. Maximální délka seznamu je 100.
nejlepší položky Pravdivé celé číslo (int32)

minimum: 1
maximálně: 10		 Počet hlavních položek, které se mají vrátit na základě emisí. Tato hodnota musí být mezi 1 a 10.
seznam míst string[] Seznam umístění (zobrazovaný název oblasti Azure) pro údaje o emisích uhlíku, přičemž každé umístění je zadané malými písmeny. Například: east us. Volitelný. Pomocí příkazu az account list-locations -o table můžete najít zobrazované názvy oblastí Azure.
seznamUrlSkupinyZdroju string[] Seznam adres URL skupin prostředků pro údaje o emisích uhlíku Volitelný. Každá adresa URL musí odpovídat formátu /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}a měla by obsahovat všechna malá písmena.
seznamTypůZdroje string[] Seznam typů zdrojů pro údaje o emisích uhlíku Volitelný. Každý typ prostředku by měl být zadán malými písmeny podle formátu microsoft.{service}/{resourceType}. Například: microsoft.storage/storageaccounts.

Ukázkové sestavy

Následující části zobrazují příkladové požadavky a odpovědi na ně pro každý typ sestavy.

Všechny sestavy obsahují subscriptionAccessDecisionList odpověď. Pole zobrazuje rozhodnutí o přístupu pro každé vstupní předplatné.

Celková Souhrnná Zpráva

Sestava zobrazuje celkové emise pro všechny oblasti předplatného a časový rozsah specifikovaný ve vstupu. Sestavu použijte, když potřebujete data sestavy vysoké úrovně.

Ukázkový požadavek

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01

{
  "reportType": "MonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  }
}

Ukázková odpověď

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    }
  ],
  "value": [
    {
      "dataType": "OverallSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05
    }
  ]
}

Měsíční souhrnná zpráva

Sestava zobrazuje emise pro všechna předplatná a rozsahy emisí pro měsíc zadaný v rozsahu kalendářních dat. Sestavu použijte v případě, že potřebujete podrobnosti o zadaném měsíci.

Ukázkový požadavek

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01

{
  "reportType": "MonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  }
}

Ukázková odpověď

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    }
  ],
  "value": [
    {
      "dataType": "MonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "date": "2024-05-01",
      "carbonIntensity": 22
    },
    {
      "dataType": "MonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "date": "2024-04-01",
      "carbonIntensity": 22
    },
    {
      "dataType": "MonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "date": "2024-03-01",
      "carbonIntensity": 22
    }
  ]
}

Zpráva o souhrnu nejlepších položek

Sestava ukazuje emise nejvyšších položek X agregovaných napříč předplatnými, emisemi, rozsahem, kategorií a zadaným rozsahem kalendářních dat rozděleným podle kategorie. Sestavu použijte, když potřebujete data pro nejvyšší položky podle kategorie.

Ukázkový požadavek

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01

{
  "reportType": "TopItemsSummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-05-01",
    "end": "2024-05-01"
  },
  "categoryType": "Location",
  "topItems": 5
}

Ukázková odpověď

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permission required"
    }
  ],
  "value": [
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 2",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 3",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us 2",
      "categoryType": "Location"
    }
  ]
}

Měsíční souhrnná zpráva hlavních položek

Sestava zobrazuje emise nejvyšších položek X agregovaných napříč předplatnými, emisemi, rozsahy a kategoriemi pro každý měsíc zadaný v rozsahu kalendářních dat. Emise se rozdělí podle kategorie. Nejlepších X položek je založeno na emisích za poslední měsíc. Sestavu použijte, když potřebujete data pro nejvyšší položky podle kategorií a měsíců.

Ukázkový požadavek

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01

{
  "reportType": "TopItemsMonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  },
  "categoryType": "Location",
  "topItems": 2
}

Ukázková odpověď

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permission required"
    }
  ],
  "value": [
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location",
      "date": "2024-05-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location",
      "date": "2024-04-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location",
      "date": "2024-03-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location",
      "date": "2024-05-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location",
      "date": "2024-04-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location",
      "date": "2024-03-01"
    }
  ]
}

Zpráva o podrobnostech položky

Sestava zobrazuje emise agregované napříč vybranými rozsahy a ID předplatných pro daný rozsah kalendářních dat a rozdělené podle zadané kategorie. Sestavu použijte v případě, že potřebujete údaje o emisích podle kategorií a abyste získali data na úrovni skupiny prostředků a jednotlivých prostředků.

Ukázkový požadavek

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01

{
  "reportType": "ItemDetailsReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-05-01",
    "end": "2024-05-01"
  },
  "categoryType": "Location",
  "orderBy": "LatestMonthEmissions",
  "sortDirection": "Desc",
  "pageSize": 100
}

Ukázková odpověď

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permission required"
    }
  ],
  "value": [
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 2",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 3",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us 2",
      "categoryType": "Location"
    }
  ]
}

Související obsah

  • Last updated on