Udostępnij przez


Eksportowanie optymalizacji emisji dwutlenku węgla na platformie Azure przy użyciu interfejsu API

Ten artykuł ułatwia zrozumienie i użycie najnowszego interfejsu API REST usługi Carbon Service do eksportowania optymalizacji emisji dwutlenku węgla na platformie Azure. Dane dotyczące emisji za poprzedni miesiąc są dostępne do dnia 19 bieżącego miesiąca.

Aby wyeksportować dane emisji przy użyciu interfejsu API REST, należy utworzyć i autoryzować jednostkę usługi w celu uzyskania dostępu do danych emisji. Następnie możesz użyć zasady dostępu usługi, aby uzyskać token autoryzacji i wyeksportować dane emisji, korzystając z interfejsu API REST.

Tworzenie i autoryzacja jednostki usługi

Jednostka usługi to aplikacja, której tokeny mogą służyć do uwierzytelniania i udzielania dostępu do określonych zasobów platformy Azure przy użyciu identyfikatora Entra firmy Microsoft. Zasoby obejmują aplikacje użytkownika, usługi lub narzędzia automatyzacji.

  1. Utwórz aplikację Microsoft Entra i jednostkę usługi , która może uzyskiwać dostęp do zasobów.
  2. Zapisz identyfikator dzierżawcy, nowy identyfikator klienta i wartość tajnego kodu klienta dla swojej aplikacji do użycia w żądaniach tokenów.
  3. Aplikacja musi mieć przypisaną rolę Carbon Optimization Reader dla zasobów, dla których chcesz wyeksportować dane emisji. Jeśli chcesz użyć aplikacji do eksportowania danych emisji dla wielu zasobów, możesz przypisać rolę na poziomie subskrypcji. Aby uzyskać więcej informacji, zobacz Przypisywanie ról platformy Azure przy użyciu witryny Azure Portal i Przypisywanie dostępu do optymalizacji emisji dwutlenku węgla na platformie Azure.

Uzyskiwanie tokenu autoryzacji

Wyślij następujące POST żądanie w wierszu polecenia lub przy użyciu klienta. Użyj adresu URL https://management.azure.com zasobu, aby uzyskać token dostępu dla interfejsu API zarządzania zasobami.

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'

Treść odpowiedzi jest wyświetlana w następujący sposób:

{
    "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"
}

Użyj tokenu dostępu z odpowiedzi do użycia w następujących żądaniach HTTP.

Eksportowanie danych emisji przy użyciu interfejsu API REST

Użyj następującego POST żądania, aby wyeksportować dane emisji.

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

Przykładowe żądanie i odpowiedź

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"
  }
}

Przykładowe dane wyjściowe

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

Oto przykład 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
}
'

Przykładowe dane wyjściowe 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 raportów

Optymalizacja emisji dwutlenku węgla udostępnia różne typy raportów, które ułatwiają analizowanie danych emisji. Każdy typ raportu ma inny cel i jest używany do określonych potrzeb:

Typ raportu Opis Kiedy należy używać
OgólnyRaportPodsumowujący Zawiera łączną emisję dwutlenku węgla dla określonego zakresu dat i parametrów zapytania oraz wartości porównawcze dla ogólnego przeglądu. Ten typ raportu akceptuje różne wartości w polach początkowych i końcowych w polu DateRange. Na przykład początek: 2024-03-01 i koniec: 2024-06-01. Wymagane dane raportu wysokiego poziomu
MiesięczneSprawozdaniePodsumowujące Dostarcza dane emisji dwutlenku węgla według miesięcy dla określonych parametrów zapytania. Ten typ raportu akceptuje różne wartości w polach początkowych i końcowych w polu DateRange. Na przykład początek: 2024-03-01 i koniec: 2024-06-01. Szczegóły określonego miesiąca
Raport zbiorczy o najważniejszych przedmiotach Udostępnia N elementów o najwyższej emisji dla określonych filtrów wyszukiwania. Ten raport zwraca dane dla jednego miesiąca w danym momencie, dlatego wymaga tych samych wartości dla pól początkowych i końcowych w elemecie DateRange. Maksymalna liczba elementów N=10 jest zwracana jednocześnie. Dane dla najważniejszych elementów według kategorii
Raport Miesięczne Podsumowanie Najlepszych Pozycji Zapewnia N najwyżej emitujących elementów w miesiącu dla wybranego filtru zapytania. Zwraca dane emisji dla pierwszych N elementów według miesięcy w danym zakresie dat. Maksymalna liczba elementów N=10 jest zwracana jednocześnie. Dane dotyczące najważniejszych elementów według kategorii i miesiąca
RaportSzczegółówPrzedmiotu Szczegółowa lista elementów na podstawie określonego typu kategorii (w tym: Resource, ResourceGroup, ResourceType, Location lub Subscription) dla filtru zapytania. Zapytanie można wykonać tylko przez jeden miesiąc naraz. Element DateRange wymaga tych samych wartości dla pól początkowych i końcowych. Dane emisji według kategorii

Parametry interfejsu API eksportu emisji

Dla każdego reportTypeelementu definiowane są różne parametry zapytania. Poniższe sekcje zawierają szczegółowe informacje o parametrach zapytania dla każdego reportTypeelementu .

Nazwa Opis
ItemDetailsQueryFilter Parametry zapytania dla ItemDetailsReport
MonthlySummaryReportQueryFilter Parametry filtru zapytania do konfigurowania MonthlySummaryReport zapytań.
OverallSummaryReportQueryFilter Parametry filtru zapytania do konfigurowania OverallSummaryReport zapytań.
NajważniejszeElementyMiesięcznePodsumowanieRaportuFiltrZapytania Parametry filtru zapytania do konfigurowania TopItemsMonthlySummaryReport zapytań.
TopItemsSummaryReportQueryFilter Parametry filtru zapytania do konfigurowania TopItemsSummaryReport zapytań.

Aby uzyskać więcej informacji na temat raportów interfejsu API REST, zobacz Carbon Service — Lista raportów emisji dwutlenku węgla.

FiltrSzczegółówElementuZapytania

Poniżej przedstawiono parametry zapytania dla elementu ItemDetailsReport.

Nazwa Wymagane Typ Opis
carbonScopeList Prawda EmissionScopeEnum[] Lista zakresów emisji dwutlenku węgla. To jest wymagane. Akceptuje jedną lub więcej wartości z EmissionScopeEnum. Na przykład Zakres1, Zakres2, Zakres3 w formie listy. Dane wyjściowe obejmują łączną emisję dla określonych zakresów.
typKategorii Prawda CategoryTypeEnum Określa typ kategorii dla szczegółowych danych emisji, takich jak Resource, ResourceGroup, ResourceType, Location lub Subscription. Zobacz obsługiwane typy w pliku CategoryTypeEnum.
zakres dat Prawda DateRange Daty rozpoczęcia i zakończenia danych dotyczących emisji dwutlenku węgla. To jest wymagane. W przypadku ItemDetailsReport i TopItemsSummaryReport obsługiwany jest tylko jeden miesiąc danych jednocześnie, dlatego daty rozpoczęcia i zakończenia powinny być takie same w ramach DateRange. Na przykład początek: 2024-06-01 i koniec: 2024-06-01.
sortuj według Prawda OrderByColumnEnum Nazwa kolumny w celu uporządkowania wyników według. Zobacz obsługiwane wartości w OrderByColumnEnum.
Rozmiar strony Prawda liczba całkowita (int32)

minimum: 1
maksimum: 5000
Liczba elementów, które mają być zwracane w jednym żądaniu, maksymalna wartość to 5000.
typRaportu Prawda struna:

RaportSzczegółówPrzedmiotu
Parametr ReportType zażądał danych dotyczących emisji dwutlenku węgla. To jest wymagane. Określa sposób agregowania i wyświetlania danych wyjściowych zgodnie z opisem w pliku ReportTypeEnum.
kierunek sortowania Prawda SortDirectionEnum Kierunek sortowania wyników. Zobacz obsługiwane wartości w SortDirectionEnum.
lista subskrypcji Prawda ciąg znakowy[] Lista identyfikatorów subskrypcji, dla których są wymagane dane dotyczące emisji dwutlenku węgla. To jest wymagane. Każdy identyfikator subskrypcji powinien mieć małe litery. Maksymalna długość listy to 100.
lista lokalizacji ciąg znakowy[] Lista lokalizacji (nazwa wyświetlana regionu platformy Azure) dla danych emisji dwutlenku węgla z każdą lokalizacją określoną małymi literami. Na przykład east us. Opcjonalny. Możesz użyć polecenia az account list-locations -o table , aby znaleźć nazwy wyświetlane regionów platformy Azure.
listaAdresówUrlGrupyZasobów ciąg znakowy[] Lista adresów URL grup zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy adres URL musi być zgodny z formatem /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}i powinien znajdować się we wszystkich małych literach.
ListaTypówZasobów ciąg znakowy[] Lista typów zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy typ zasobu powinien być określony w małych literach, zgodnie z formatem microsoft.{service}/{resourceType}. Na przykład microsoft.storage/storageaccounts.
pomińToken ciąg Token stronicowania na potrzeby pobierania następnej strony danych. Ten token może przyjmować wartość null i jeśli są dostępne inne strony danych, jest zwracany w poprzedniej odpowiedzi.

Filtr miesięcznego zapytania o raport podsumowujący

Poniżej przedstawiono parametry filtru zapytania do konfigurowania MonthlySummaryReport zapytań.

Nazwa Wymagane Typ Opis
carbonScopeList Prawda EmissionScopeEnum[] Lista zakresów emisji dwutlenku węgla. To jest wymagane. Akceptuje jedną lub więcej wartości z EmissionScopeEnum. Na przykład Zakres1, Zakres2, Zakres3 w formie listy. Dane wyjściowe obejmują łączną emisję dla określonych zakresów.
zakres dat Prawda DateRange Daty rozpoczęcia i zakończenia danych dotyczących emisji dwutlenku węgla. To jest wymagane. W przypadku ItemDetailsReport i TopItemsSummaryReport obsługiwany jest tylko jeden miesiąc danych jednocześnie, dlatego daty rozpoczęcia i zakończenia powinny być takie same w ramach DateRange. Na przykład początek: 2024-06-01 i koniec: 2024-06-01.
typRaportu Prawda struna:

MiesięczneSprawozdaniePodsumowujące
Parametr ReportType zażądał danych dotyczących emisji dwutlenku węgla. To jest wymagane. Określa sposób agregowania i wyświetlania danych wyjściowych zgodnie z opisem w pliku ReportTypeEnum.
lista subskrypcji Prawda ciąg znakowy[] Lista identyfikatorów subskrypcji, dla których są wymagane dane dotyczące emisji dwutlenku węgla. To jest wymagane. Każdy identyfikator subskrypcji powinien mieć małe litery. Maksymalna długość listy to 100.
lista lokalizacji ciąg znakowy[] Lista lokalizacji (nazwa wyświetlana regionu platformy Azure) dla danych emisji dwutlenku węgla z każdą lokalizacją określoną małymi literami. Na przykład east us. Opcjonalny. Możesz użyć polecenia az account list-locations -o table , aby znaleźć nazwy wyświetlane regionów platformy Azure.
listaAdresówUrlGrupyZasobów ciąg znakowy[] Lista adresów URL grup zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy adres URL musi być zgodny z formatem /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}i powinien znajdować się we wszystkich małych literach.
ListaTypówZasobów ciąg znakowy[] Lista typów zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy typ zasobu powinien być określony w małych literach, zgodnie z formatem microsoft.{service}/{resourceType}. Na przykład microsoft.storage/storageaccounts.

FiltrZapytaniaOgólnegoRaportuPodsumowania

Poniżej przedstawiono parametry filtru zapytania do konfigurowania zapytań OverallSummaryReport.

Nazwa Wymagane Typ Opis
carbonScopeList Prawda EmissionScopeEnum[] Lista zakresów emisji dwutlenku węgla. To jest wymagane. Akceptuje jedną lub więcej wartości z EmissionScopeEnum. Na przykład Zakres1, Zakres2, Zakres3 w formie listy. Dane wyjściowe obejmują łączną emisję dla określonych zakresów.
zakres dat Prawda DateRange Daty rozpoczęcia i zakończenia danych dotyczących emisji dwutlenku węgla. To jest wymagane. W przypadku ItemDetailsReport i TopItemsSummaryReport obsługiwany jest tylko jeden miesiąc danych jednocześnie, dlatego daty rozpoczęcia i zakończenia powinny być takie same w ramach DateRange. Na przykład początek: 2024-06-01 i koniec: 2024-06-01.
typRaportu Prawda struna:

OgólnyRaportPodsumowujący
Parametr ReportType zażądał danych dotyczących emisji dwutlenku węgla. To jest wymagane. Określa sposób agregowania i wyświetlania danych wyjściowych zgodnie z opisem w pliku ReportTypeEnum.
lista subskrypcji Prawda ciąg znakowy[] Lista identyfikatorów subskrypcji, dla których są wymagane dane dotyczące emisji dwutlenku węgla. To jest wymagane. Każdy identyfikator subskrypcji powinien mieć małe litery. Maksymalna długość listy to 100.
lista lokalizacji ciąg znakowy[] Lista lokalizacji (nazwa wyświetlana regionu platformy Azure) dla danych emisji dwutlenku węgla z każdą lokalizacją określoną małymi literami. Na przykład east us. Opcjonalny. Możesz użyć polecenia az account list-locations -o table , aby znaleźć nazwy wyświetlane regionów platformy Azure.
listaAdresówUrlGrupyZasobów ciąg znakowy[] Lista adresów URL grup zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy adres URL musi być zgodny z formatem /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}i powinien znajdować się we wszystkich małych literach.
ListaTypówZasobów ciąg znakowy[] Lista typów zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy typ zasobu powinien być określony w małych literach, zgodnie z formatem microsoft.{service}/{resourceType}. Na przykład microsoft.storage/storageaccounts.

FiltrZapytaniaPodsumowanieMiesięczneNajlepszychElementów

Poniżej przedstawiono parametry filtru zapytania do konfigurowania TopItemsMonthlySummaryReport zapytań.

Nazwa Wymagane Typ Opis
carbonScopeList Prawda EmissionScopeEnum[] Lista zakresów emisji dwutlenku węgla. To jest wymagane. Akceptuje jedną lub więcej wartości z EmissionScopeEnum. Na przykład Zakres1, Zakres2, Zakres3 w formie listy. Dane wyjściowe obejmują łączną emisję dla określonych zakresów.
typKategorii Prawda CategoryTypeEnum Określa typ kategorii, aby pobrać elementy emitujące najwięcej, agregowane według miesiąca. Zobacz obsługiwane typy w pliku CategoryTypeEnum.
zakres dat Prawda DateRange Daty rozpoczęcia i zakończenia danych dotyczących emisji dwutlenku węgla. To jest wymagane. W przypadku ItemDetailsReport i TopItemsSummaryReport obsługiwany jest tylko jeden miesiąc danych jednocześnie, dlatego daty rozpoczęcia i zakończenia powinny być takie same w ramach DateRange. Na przykład początek: 2024-06-01 i koniec: 2024-06-01.
typRaportu Prawda struna:

Raport Miesięczne Podsumowanie Najlepszych Pozycji
Parametr ReportType zażądał danych dotyczących emisji dwutlenku węgla. To jest wymagane. Określa sposób agregowania i wyświetlania danych wyjściowych zgodnie z opisem w pliku ReportTypeEnum.
lista subskrypcji Prawda ciąg znakowy[] Lista identyfikatorów subskrypcji, dla których są wymagane dane dotyczące emisji dwutlenku węgla. To jest wymagane. Każdy identyfikator subskrypcji powinien mieć małe litery. Maksymalna długość listy to 100.
najlepsze elementy Prawda liczba całkowita (int32)

minimum: 1
maksimum: 10
Liczba najważniejszych elementów, które należy zwrócić, na podstawie emisji. Musi należeć do zakresu od 1 do 10.
lista lokalizacji ciąg znakowy[] Lista lokalizacji (nazwa wyświetlana regionu platformy Azure) dla danych emisji dwutlenku węgla z każdą lokalizacją określoną małymi literami. Na przykład east us. Opcjonalny. Możesz użyć polecenia az account list-locations -o table , aby znaleźć nazwy wyświetlane regionów platformy Azure.
listaAdresówUrlGrupyZasobów ciąg znakowy[] Lista adresów URL grup zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy adres URL musi być zgodny z formatem /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}i powinien znajdować się we wszystkich małych literach.
ListaTypówZasobów ciąg znakowy[] Lista typów zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy typ zasobu powinien być określony w małych literach, zgodnie z formatem microsoft.{service}/{resourceType}. Na przykład microsoft.storage/storageaccounts.

FiltrZapytaniaRaportuPodsumowaniaNajważniejszychElementów

Oto parametry filtru zapytania do skonfigurowania TopItemsSummaryReport queries.

Nazwa Wymagane Typ Opis
carbonScopeList Prawda EmissionScopeEnum[] Lista zakresów emisji dwutlenku węgla. To jest wymagane. Akceptuje jedną lub więcej wartości z EmissionScopeEnum. Na przykład Zakres1, Zakres2, Zakres3 w formie listy. Dane wyjściowe obejmują łączną emisję dla określonych zakresów.
typKategorii Prawda CategoryTypeEnum Określa typ kategorii, dla którego mają być pobierane elementy emitujące najwyżej. Zobacz obsługiwane wartości zdefiniowane w pliku CategoryTypeEnum.
zakres dat Prawda DateRange Daty rozpoczęcia i zakończenia danych dotyczących emisji dwutlenku węgla. To jest wymagane. W przypadku ItemDetailsReport i TopItemsSummaryReport obsługiwany jest tylko jeden miesiąc danych jednocześnie, dlatego daty rozpoczęcia i zakończenia powinny być takie same w ramach DateRange. Na przykład początek: 2024-06-01 i koniec: 2024-06-01.
typRaportu Prawda struna:

Raport zbiorczy o najważniejszych przedmiotach
Parametr ReportType zażądał danych dotyczących emisji dwutlenku węgla. To jest wymagane. Określa sposób agregowania i wyświetlania danych wyjściowych zgodnie z opisem w pliku ReportTypeEnum.
lista subskrypcji Prawda ciąg znakowy[] Lista identyfikatorów subskrypcji, dla których są wymagane dane dotyczące emisji dwutlenku węgla. To jest wymagane. Każdy identyfikator subskrypcji powinien mieć małe litery. Maksymalna długość listy to 100.
najlepsze elementy Prawda liczba całkowita (int32)

minimum: 1
maksimum: 10
Liczba najważniejszych elementów, które należy zwrócić, na podstawie emisji. Ta wartość musi należeć do zakresu od 1 do 10.
lista lokalizacji ciąg znakowy[] Lista lokalizacji (nazwa wyświetlana regionu platformy Azure) dla danych emisji dwutlenku węgla z każdą lokalizacją określoną małymi literami. Na przykład east us. Opcjonalny. Możesz użyć polecenia az account list-locations -o table , aby znaleźć nazwy wyświetlane regionów platformy Azure.
listaAdresówUrlGrupyZasobów ciąg znakowy[] Lista adresów URL grup zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy adres URL musi być zgodny z formatem /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}i powinien znajdować się we wszystkich małych literach.
ListaTypówZasobów ciąg znakowy[] Lista typów zasobów dla danych dotyczących emisji dwutlenku węgla. Opcjonalny. Każdy typ zasobu powinien być określony w małych literach, zgodnie z formatem microsoft.{service}/{resourceType}. Na przykład microsoft.storage/storageaccounts.

Przykładowe raporty

W poniższych sekcjach przedstawiono przykładowe żądania i odpowiedzi dla każdego typu raportu.

Wszystkie raporty zawierają odpowiedź subscriptionAccessDecisionList. Pole zawiera decyzję dotyczącą dostępu dla każdej subskrypcji wejściowej.

OgólnyRaportPodsumowujący

Raport przedstawia łączną emisję dla wszystkich zakresów subskrypcji i zakresu dat określonych w danych wejściowych. Użyj raportu, gdy potrzebujesz danych raportu wysokiego poziomu.

Przykładowe żądanie

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"
  }
}

Przykładowa odpowiedź

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

MiesięczneSprawozdaniePodsumowujące

Raport przedstawia emisje dla wszystkich subskrypcji i zakresów emisji dla miesiąca określonego w zakresie dat. Jeśli potrzebujesz szczegółów dla określonego miesiąca, użyj raportu.

Przykładowe żądanie

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"
  }
}

Przykładowa odpowiedź

{
  "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
    }
  ]
}

Raport zbiorczy o najważniejszych przedmiotach

Raport przedstawia emisje najważniejszych elementów X zagregowanych w ramach subskrypcji, emisji, zakresu, kategorii i określonego zakresu dat z podziałem na kategorie. Użyj raportu, gdy potrzebujesz danych dla najważniejszych elementów według kategorii.

Przykładowe żądanie

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
}

Przykładowa odpowiedź

{
  "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"
    }
  ]
}

Raport Miesięczne Podsumowanie Najlepszych Pozycji

Raport przedstawia emisje najważniejszych elementów X zagregowanych w ramach subskrypcji, emisji, zakresów i kategorii dla każdego miesiąca określonego w zakresie dat. Emisje są podzielone według kategorii. Pierwsze elementy X opierają się na emisjach z ubiegłego miesiąca. Użyj raportu, gdy potrzebujesz danych dla najważniejszych elementów według kategorii i miesiąca.

Przykładowe żądanie

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
}

Przykładowa odpowiedź

{
  "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"
    }
  ]
}

RaportSzczegółówPrzedmiotu

Raport przedstawia emisje zagregowane w wybranych zakresach i identyfikatorach subskrypcji dla danego zakresu dat i podzielone na określoną kategorię. Użyj raportu, gdy potrzebujesz danych emisji według kategorii i, aby uzyskać dane na poziomie grupy zasobów i zasobów.

Przykładowe żądanie

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
}

Przykładowa odpowiedź

{
  "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"
    }
  ]
}