@azure/arm-carbonoptimization package

The basic response for different query report, all query report result will have these information

Response for available date range of carbon emission data

List of carbon emission results

Response for detailed carbon emissions

Response for Monthly Carbon Emissions Summary

Response for Overall Carbon Emissions Summary

Response for Top Items Carbon Emissions by Month

Response for Top Items by Category Type

Optional parameters for the client.

Interface representing a CarbonService operations.

Optional parameters.

Optional parameters.

Date range to be used with QueryParameter, it should be within 12 months between start and end date. In certain cases, start and end dates must be the same date.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Query Parameters for ItemDetailsReport

Query filter parameter to configure MonthlySummaryReport queries.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for and operation.

Optional parameters.

Interface representing a Operations operations.

Query filter parameter to configure OverallSummaryReport queries.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

Shared query filter parameter to configure carbon emissions data queries for all different report type defined in ReportTypeEnum.

Response for Resource detailed carbon emissions

Response for top items carbon emissions by month for resource

Response for Top Items For Resource Category

Response for Resource Group detailed carbon emissions

Response for top items carbon emissions by month for resource group

Response for Top Items For ResourceGroup

Access Decision for each Subscription

Query filter parameter to configure TopItemsMonthlySummaryReport queries.

Query filter parameter to configure TopItemsSummaryReport queries.

Enum for Access Decision
KnownAccessDecisionEnum can be used interchangeably with AccessDecisionEnum, this enum contains the known values that the service supports.

Known values supported by the service

Allowed: Access allowed
Denied: Access denied

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

Alias for CarbonEmissionDataUnion

Supported category types to be used with QueryParameter. Each type represents a different level of emissions data aggregation.
KnownCategoryTypeEnum can be used interchangeably with CategoryTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

Subscription: Emissions aggregated at the subscription level.
ResourceGroup: Emissions aggregated at the resource group level.
Location: Emissions aggregated at the ___location level.
Resource: Emissions aggregated at the resource level.
ResourceType: Emissions aggregated at the resource type level.

An interface that describes a page of results.

Supported carbon emission scopes to be used with QueryParameter, as defined by the GHG Protocol. At least one scope must be specified. The output will return a total of all specified scopes.
KnownEmissionScopeEnum can be used interchangeably with EmissionScopeEnum, this enum contains the known values that the service supports.

Known values supported by the service

Scope1: Scope1 carbon emission
Scope2: Scope2 carbon emission
Scope3: Scope3 carbon emission

Sorting is supported for columns in ItemDetailsReport. This object includes the column names that sorting is allowed for. Select one of these supported values
KnownOrderByColumnEnum can be used interchangeably with OrderByColumnEnum, this enum contains the known values that the service supports.

Known values supported by the service

ItemName: The itemName filed in ItemDetailsReport result, see CarbonEmissionItemDetailData for more information.
LatestMonthEmissions: The latestMonthEmissions filed in ItemDetailsReport result, see CarbonEmissionItemDetailData for more information.
PreviousMonthEmissions: The previousMonthEmissions filed in ItemDetailsReport result, see CarbonEmissionItemDetailData for more information.
MonthOverMonthEmissionsChangeRatio: The monthOverMonthEmissionsChangeRatio filed in ItemDetailsReport result, see CarbonEmissionItemDetailData for more information.
MonthlyEmissionsChangeValue: The monthlyEmissionsChangeValue filed in ItemDetailsReport result, see CarbonEmissionItemDetailData for more information.
ResourceGroup: The resourceGroup filed in ResourceCarbonEmissionItemDetailData result, see ResourceCarbonEmissionItemDetailData for more information.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

Alias for QueryFilterUnion

Enum for Report Type, specifying different report formats for carbon emissions data. Each report type returns different aggregations of carbon emissions across various categories, date range, emissions scope, and other parameters.
KnownReportTypeEnum can be used interchangeably with ReportTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

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.

The response data type of Carbon emission data
KnownResponseDataTypeEnum can be used interchangeably with ResponseDataTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

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

Sorting is supported for columns in ItemDetailsReport. This object define sorting direction.
KnownSortDirectionEnum can be used interchangeably with SortDirectionEnum, this enum contains the known values that the service supports.

Known values supported by the service

Desc: Descending order for query result.
Asc: Ascending order for query result.

Enum for Access Decision

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

Supported category types to be used with QueryParameter. Each type represents a different level of emissions data aggregation.

Supported carbon emission scopes to be used with QueryParameter, as defined by the GHG Protocol. At least one scope must be specified. The output will return a total of all specified scopes.

Sorting is supported for columns in ItemDetailsReport. This object includes the column names that sorting is allowed for. Select one of these supported values

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Enum for Report Type, specifying different report formats for carbon emissions data. Each report type returns different aggregations of carbon emissions across various categories, date range, emissions scope, and other parameters.

The response data type of Carbon emission data

Sorting is supported for columns in ItemDetailsReport. This object define sorting direction.

The available API versions.