ArmCostManagementModelFactory.SavingsPlanUtilizationSummary Method

Definition

Namespace:

Azure.ResourceManager.CostManagement.Models

Assembly:

Azure.ResourceManager.CostManagement.dll

Package:

Azure.ResourceManager.CostManagement v1.0.1

Source:

ArmCostManagementModelFactory.cs

Initializes a new instance of SavingsPlanUtilizationSummary.

public static Azure.ResourceManager.CostManagement.Models.SavingsPlanUtilizationSummary SavingsPlanUtilizationSummary (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, string armSkuName = default, string benefitId = default, string benefitOrderId = default, Azure.ResourceManager.CostManagement.Models.BillingAccountBenefitKind? benefitType = default, DateTimeOffset? usageOn = default, decimal? avgUtilizationPercentage = default, decimal? minUtilizationPercentage = default, decimal? maxUtilizationPercentage = default);

static member SavingsPlanUtilizationSummary : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * string * string * string * Nullable<Azure.ResourceManager.CostManagement.Models.BillingAccountBenefitKind> * Nullable<DateTimeOffset> * Nullable<decimal> * Nullable<decimal> * Nullable<decimal> -> Azure.ResourceManager.CostManagement.Models.SavingsPlanUtilizationSummary

Public Shared Function SavingsPlanUtilizationSummary (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional armSkuName As String = Nothing, Optional benefitId As String = Nothing, Optional benefitOrderId As String = Nothing, Optional benefitType As Nullable(Of BillingAccountBenefitKind) = Nothing, Optional usageOn As Nullable(Of DateTimeOffset) = Nothing, Optional avgUtilizationPercentage As Nullable(Of Decimal) = Nothing, Optional minUtilizationPercentage As Nullable(Of Decimal) = Nothing, Optional maxUtilizationPercentage As Nullable(Of Decimal) = Nothing) As SavingsPlanUtilizationSummary

Parameters

id

ResourceIdentifier

The id.

name

String

The name.

resourceType

ResourceType

The resourceType.

systemData

SystemData

The systemData.

armSkuName

String

ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.

benefitId

String

The benefit ID is the identifier of the benefit.

benefitOrderId

String

The benefit order ID is the identifier for a benefit purchase.

benefitType

Nullable<BillingAccountBenefitKind>

The benefit type. Supported values: 'SavingsPlan'.

usageOn

Nullable<DateTimeOffset>

Date corresponding to the utilization summary record. If the grain of data is monthly, value for this field will be first day of the month.

avgUtilizationPercentage

Nullable<Decimal>

This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.

minUtilizationPercentage

Nullable<Decimal>

This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.

maxUtilizationPercentage

Nullable<Decimal>

This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.

Returns

SavingsPlanUtilizationSummary

A new SavingsPlanUtilizationSummary instance for mocking.