Microsoft.Carbon (stable:2025-04-01)

2025/04/15 • 3 new methods

CarbonService_QueryCarbonEmissionReports (new)
Description :  API for Carbon Emissions Reports
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Carbon/carbonEmissionReports
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
queryParameters:
{
Description: Query parameters ,
Required: True ,
}
{
reportType:
{
Description: The ReportType requested for carbon emissions data. Required. Specifies how data is aggregated and displayed in the output, as explained in the ReportTypeEnum. ,
Enum:
{
OverallSummaryReport: Overall summary report provides total carbon emissions for the specified date range and query parameters, as well as comparative values for a high-level overview. This report type can accept different values in the start and end fields within DateRange (e.g., start: 2024-03-01 and end: 2024-06-01). ,
MonthlySummaryReport: MonthlySummaryReport provides carbon emissions data by month for the specified query parameters. This report type can accept different values in the start and end fields within DateRange (e.g., start: 2024-03-01 and end: 2024-06-01). ,
TopItemsSummaryReport: TopItemsSummaryReport provides the N highest-emitting items for the specified query filters. This report returns data for a single month at a time, so it requires the same values for the start and end fields within DateRange. A maximum of N=10 items can be returned at a time. ,
TopItemsMonthlySummaryReport: TopItemsMonthlyReport provides the N highest-emitting items by month for the specified query filter. Returns emissions data for the top N items by month within the given date range. A maximum of N=10 items can be returned at a time. ,
ItemDetailsReport: ItemDetailsReport provides a granular list of items based on the specified CategoryType (e.g., Resource, ResourceGroup, ResourceType, Location, or Subscription) for the query filter. This report can be queried for only one month at a time, requiring the same values in the start and end fields within DateRange. ,
}
,
Required: True ,
}
enum ,
dateRange:
{
Description: The start and end dates for carbon emissions data. Required. For ItemDetailsReport and TopItemsSummaryReport, only one month of data is supported at a time, so start and end dates should be equal within DateRange (e.g., start: 2024-06-01 and end: 2024-06-01). ,
Required: True ,
}
{
start:
{
Description: Start date parameter in yyyy-MM-01 format. Only the first day of each month is accepted. ,
Format: date ,
Required: True ,
}
string ,
end:
{
Description: End date parameter in yyyy-MM-01 format. Only the first day of each month is accepted. ,
Format: date ,
Required: True ,
}
string ,
}
,
subscriptionList:
{
Description: List of subscription IDs for which carbon emissions data is requested. Required. Each subscription ID should be in lowercase format. The max length of list is 100. ,
Required: True ,
}
[
string ,
]
,
resourceGroupUrlList:
{
Description: List of resource group URLs for carbon emissions data. Optional. Each URL must follow the format '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}', and should be in all lowercase. ,
Required: False ,
}
[
string ,
]
,
resourceTypeList:
{
Description: List of resource types for carbon emissions data. Optional. Each resource type should be specified in lowercase, following the format 'microsoft.{service}/{resourceType}', e.g., 'microsoft.storage/storageaccounts'. ,
Required: False ,
}
[
string ,
]
,
locationList:
{
Description: List of locations(Azure Region Display Name) for carbon emissions data, with each location specified in lowercase (e.g., 'east us'). Optional. You can use the command 'az account list-locations -o table' to find Azure Region Display Names. ,
Required: False ,
}
[
string ,
]
,
carbonScopeList:
{
Description: List of carbon emission scopes. Required. Accepts one or more values from EmissionScopeEnum (e.g., Scope1, Scope2, Scope3) in list form. The output will include the total emissions for the specified scopes. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The CarbonEmissionData items on this page ,
Required: True ,
}
[
{
dataType:
{
Description: The data type of the query result, indicating the format of the returned response. ,
Enum:
{
OverallSummaryData: The response data type for OverallSummaryReport ,
MonthlySummaryData: The response data type for MonthlySummaryReport ,
TopItemsSummaryData: The response data type for TopItemsSummaryReport ,
ResourceTopItemsSummaryData: The response data type for Resource's TopItemsSummaryReport ,
ResourceGroupTopItemsSummaryData: The response data type for ResourceGroup's TopItemsSummaryReport ,
TopItemsMonthlySummaryData: The response data type for TopItemsMonthlySummaryReport ,
ResourceTopItemsMonthlySummaryData: The response data type for Resource's TopItemsMonthlySummaryReport ,
ResourceGroupTopItemsMonthlySummaryData: The response data type for ResourceGroup's TopItemsMonthlySummaryReport ,
ItemDetailsData: The response data type for ItemDetailsReport ,
ResourceItemDetailsData: The response data type for Resource's ItemDetailsReport ,
ResourceGroupItemDetailsData: The response data type for ResourceGroup's ItemDetailsReport ,
}
,
Required: True ,
}
enum ,
latestMonthEmissions:
{
Description: Total carbon emissions for the specified query parameters, measured in kgCO2E. This value represents total emissions over the specified date range (e.g., March-June). ,
Format: double ,
Required: True ,
}
number ,
previousMonthEmissions:
{
Description: Total carbon emissions for the previous month’s date range, which is the same period as the specified date range but shifted left by one month (e.g., if the specified range is March - June, the previous month’s range will be Feb - May). The value is measured in kgCO2E. ,
Format: double ,
Required: True ,
}
number ,
monthOverMonthEmissionsChangeRatio:
{
Description: The percentage change in carbon emissions between the current and previous DateRange. This is calculated as: (latestMonthEmissions - previousMonthEmissions) / previousMonthEmissions. ,
Format: double ,
Required: False ,
}
number ,
monthlyEmissionsChangeValue:
{
Description: The change in carbon emissions between the current and previous period, calculated as: latestMonthEmissions - previousMonthEmissions. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
skipToken:
{
Description: The pagination token to fetch next page data, it's null or empty if it doesn't have next page data ,
Required: False ,
}
string ,
subscriptionAccessDecisionList:
{
Description: The access decision list for each input subscription ,
Required: False ,
}
[
{
subscriptionId:
{
Description: Id of Subscription ,
Required: True ,
}
string ,
decision:
{
Description: Access decision to subscription ,
Enum:
{
Allowed: Access allowed ,
Denied: Access denied ,
}
,
Required: True ,
}
enum ,
denialReason:
{
Description: The reason why access request got denied ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Carbon/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CarbonService_QueryCarbonEmissionDataAvailableDateRange (new)
Description :  API for query carbon emission data available date range
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Carbon/queryCarbonEmissionDataAvailableDateRange
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
startDate:
{
Description: Start date parameter, format is yyyy-MM-dd ,
Required: True ,
}
string ,
endDate:
{
Description: End date parameter, format is yyyy-MM-dd ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}