Share via


ConsumptionExtensions.GetConsumptionReservationRecommendationDetailsAsync Method

Definition

Details of a reservation recommendation for what-if analysis of reserved instances.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails
  • Operation Id: ReservationRecommendationDetails_Get
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationDetails>> GetConsumptionReservationRecommendationDetailsAsync (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationScope reservationScope, string region, Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationTerm term, Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationLookBackPeriod lookBackPeriod, string product, System.Threading.CancellationToken cancellationToken = default);
static member GetConsumptionReservationRecommendationDetailsAsync : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationScope * string * Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationTerm * Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationLookBackPeriod * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Consumption.Models.ConsumptionReservationRecommendationDetails>>
<Extension()>
Public Function GetConsumptionReservationRecommendationDetailsAsync (client As ArmClient, scope As ResourceIdentifier, reservationScope As ConsumptionReservationRecommendationScope, region As String, term As ConsumptionReservationRecommendationTerm, lookBackPeriod As ConsumptionReservationRecommendationLookBackPeriod, product As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ConsumptionReservationRecommendationDetails))

Parameters

client
ArmClient

The ArmClient instance the method will execute against.

scope
ResourceIdentifier

The scope that the resource will apply against.

reservationScope
ConsumptionReservationRecommendationScope

Scope of the reservation.

region
String

Used to select the region the recommendation should be generated for.

term
ConsumptionReservationRecommendationTerm

Specify length of reservation recommendation term.

lookBackPeriod
ConsumptionReservationRecommendationLookBackPeriod

Filter the time period on which reservation recommendation results are based.

product
String

Filter the products for which reservation recommendation results are generated. Examples: Standard_DS1_v2 (for VM), Premium_SSD_Managed_Disks_P30 (for Managed Disks).

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

client, region or product is null.

Applies to