CostManagementExtensions.GetBenefitUtilizationSummariesBySavingsPlanId Method

Definition

Lists the savings plan utilization summaries for daily or monthly grain.

  • Request Path: /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
  • Operation Id: BenefitUtilizationSummaries_ListBySavingsPlanId
public static Azure.Pageable<Azure.ResourceManager.CostManagement.Models.BenefitUtilizationSummary> GetBenefitUtilizationSummariesBySavingsPlanId (this Azure.ResourceManager.Resources.TenantResource tenantResource, string savingsPlanOrderId, string savingsPlanId, string filter = default, Azure.ResourceManager.CostManagement.Models.GrainContent? grainParameter = default, System.Threading.CancellationToken cancellationToken = default);
static member GetBenefitUtilizationSummariesBySavingsPlanId : Azure.ResourceManager.Resources.TenantResource * string * string * string * Nullable<Azure.ResourceManager.CostManagement.Models.GrainContent> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CostManagement.Models.BenefitUtilizationSummary>
<Extension()>
Public Function GetBenefitUtilizationSummariesBySavingsPlanId (tenantResource As TenantResource, savingsPlanOrderId As String, savingsPlanId As String, Optional filter As String = Nothing, Optional grainParameter As Nullable(Of GrainContent) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of BenefitUtilizationSummary)

Parameters

tenantResource
TenantResource

The TenantResource instance the method will execute against.

savingsPlanOrderId
String

Savings plan order ID.

savingsPlanId
String

Savings plan ID.

filter
String

Supports filtering by properties/usageDate.

grainParameter
Nullable<GrainContent>

Grain.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of BenefitUtilizationSummary that may take multiple service requests to iterate over.

Exceptions

savingsPlanOrderId or savingsPlanId is an empty string, and was expected to be non-empty.

tenantResource, savingsPlanOrderId or savingsPlanId is null.

Applies to