Share via


ArmCarbonOptimizationModelFactory.ResourceCarbonEmissionTopItemMonthlySummary Method

Definition

Initializes a new instance of ResourceCarbonEmissionTopItemMonthlySummary.

public static Azure.ResourceManager.CarbonOptimization.Models.ResourceCarbonEmissionTopItemMonthlySummary ResourceCarbonEmissionTopItemMonthlySummary(double latestMonthEmissions = 0, double previousMonthEmissions = 0, double? monthOverMonthEmissionsChangeRatio = default, double? monthlyEmissionsChangeValue = default, string itemName = default, Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionCategoryType categoryType = default, string date = default, string subscriptionId = default, string resourceGroup = default, Azure.Core.ResourceIdentifier resourceId = default);
static member ResourceCarbonEmissionTopItemMonthlySummary : double * double * Nullable<double> * Nullable<double> * string * Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionCategoryType * string * string * string * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.CarbonOptimization.Models.ResourceCarbonEmissionTopItemMonthlySummary
Public Shared Function ResourceCarbonEmissionTopItemMonthlySummary (Optional latestMonthEmissions As Double = 0, Optional previousMonthEmissions As Double = 0, Optional monthOverMonthEmissionsChangeRatio As Nullable(Of Double) = Nothing, Optional monthlyEmissionsChangeValue As Nullable(Of Double) = Nothing, Optional itemName As String = Nothing, Optional categoryType As CarbonEmissionCategoryType = Nothing, Optional date As String = Nothing, Optional subscriptionId As String = Nothing, Optional resourceGroup As String = Nothing, Optional resourceId As ResourceIdentifier = Nothing) As ResourceCarbonEmissionTopItemMonthlySummary

Parameters

latestMonthEmissions
Double

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).

previousMonthEmissions
Double

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.

monthOverMonthEmissionsChangeRatio
Nullable<Double>

The percentage change in carbon emissions between the current and previous DateRange. This is calculated as: (latestMonthEmissions - previousMonthEmissions) / previousMonthEmissions.

monthlyEmissionsChangeValue
Nullable<Double>

The change in carbon emissions between the current and previous period, calculated as: latestMonthEmissions - previousMonthEmissions.

itemName
String

The resource name of resource for Resource Category.

categoryType
CarbonEmissionCategoryType

Resource Item category.

date
String

Monthly date string, format is yyyy-MM-dd.

subscriptionId
String

Subscription Id.

resourceGroup
String

Resource Group.

resourceId
ResourceIdentifier

The fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

Returns

A new ResourceCarbonEmissionTopItemMonthlySummary instance for mocking.

Applies to