Microsoft.Consumption (stable:2021-05-01)

2025/07/23 • 1 updated methods

ReservationRecommendationDetails_Get (updated)
Description :  Details of a reservation recommendation for what-if analysis of reserved instances.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ReservationRecommendationDetails_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "resource": [
              {
                "#name": "onDemandRate",
                "Description": {
                  "new": "On-demand rate of the resource. Most resources use hourly rates, except for BlockBlob, ManagedDisk, Backup, and Azure Files, which use monthly rates. Only hardware rates are included; software rates are excluded.  Note: there could be new resources that use hourly rates in the future.",
                  "old": "On demand rate of the resource."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2021-05-01. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope associated with reservation recommendation details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope ,
Required: True ,
}
string ,
scope:
{
Description: Scope of the reservation. ,
Required: True ,
}
string ,
region:
{
Description: Used to select the region the recommendation should be generated for. ,
Required: True ,
}
string ,
term:
{
Description: Specify length of reservation recommendation term. ,
Required: True ,
}
string ,
lookBackPeriod:
{
Description: Filter the time period on which reservation recommendation results are based. ,
Required: True ,
}
string ,
product:
{
Description: Filter the products for which reservation recommendation results are generated. Examples: Standard_DS1_v2 (for VM), Premium_SSD_Managed_Disks_P30 (for Managed Disks) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource Location. ,
Required: False ,
}
string ,
sku:
{
Description: Resource sku ,
Required: False ,
}
string ,
etag:
{
Description: Resource etag. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the reservation recommendation. ,
Required: False ,
}
{
currency:
{
Description: An ISO 4217 currency code identifier for the costs and savings ,
Required: False ,
}
string ,
resource:
{
Description: Resource specific properties. ,
Required: False ,
}
{
appliedScopes:
{
Description: List of subscriptions for which the reservation is applied. ,
Required: False ,
}
[
string ,
]
,
onDemandRate:
{
Description: On-demand rate of the resource. Most resources use hourly rates, except for BlockBlob, ManagedDisk, Backup, and Azure Files, which use monthly rates. Only hardware rates are included; software rates are excluded. Note: there could be new resources that use hourly rates in the future. ,
Required: False ,
}
number ,
product:
{
Description: Azure product ex: Standard_E8s_v3 etc. ,
Required: False ,
}
string ,
region:
{
Description: Azure resource region ex:EastUS, WestUS etc. ,
Required: False ,
}
string ,
reservationRate:
{
Description: Reservation rate of the resource. ,
Required: False ,
}
number ,
resourceType:
{
Description: The azure resource type. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource Group. ,
Required: False ,
}
string ,
savings:
{
Description: Savings information for the recommendation. ,
Required: False ,
}
{
calculatedSavings:
{
Description: List of calculated savings. ,
Required: False ,
}
[
{
onDemandCost:
{
Description: The cost without reservation. ,
Required: False ,
}
number ,
overageCost:
{
Description: The difference between total reservation cost and reservation cost. ,
Required: False ,
}
number ,
quantity:
{
Description: The quantity for calculated savings. ,
Required: False ,
}
number ,
reservationCost:
{
Description: The exact cost of the estimated usage using reservation. ,
Required: False ,
}
number ,
totalReservationCost:
{
Description: The cost of the suggested quantity. ,
Required: False ,
}
number ,
reservedUnitCount:
{
Description: The number of reserved units used to calculate savings. Always 1 for virtual machines. ,
Required: False ,
}
number ,
savings:
{
Description: The amount saved by purchasing the recommended quantity of reservation. ,
Required: False ,
}
number ,
}
,
]
,
lookBackPeriod:
{
Description: Number of days of usage to look back used for computing the recommendation. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedQuantity:
{
Description: Number of recommended units of the resource. ,
Required: False ,
}
number ,
reservationOrderTerm:
{
Description: Term period of the reservation, ex: P1Y or P3Y. ,
Required: False ,
}
string ,
savingsType:
{
Description: Type of savings, ex: instance. ,
Required: False ,
}
string ,
unitOfMeasure:
{
Description: Measurement unit ex: hour etc. ,
Required: False ,
}
string ,
}
,
scope:
{
Description: Scope of the reservation, ex: Single or Shared. ,
Required: False ,
}
string ,
usage:
{
Description: Historical usage details used to calculate the estimated savings. ,
Required: False ,
}
{
firstConsumptionDate:
{
Description: The first usage date used for looking back for computing the recommendation. ,
Required: False ,
}
string ,
lastConsumptionDate:
{
Description: The last usage date used for looking back for computing the recommendation. ,
Required: False ,
}
string ,
lookBackUnitType:
{
Description: What the usage data values represent ex: virtual machine instance. ,
Required: False ,
}
string ,
usageData:
{
Description: The breakdown of historical resource usage. The values are in the order of usage between the firstConsumptionDate and the lastConsumptionDate. ,
Required: False ,
}
[
number ,
]
,
usageGrain:
{
Description: The grain of the values represented in the usage data ex: hourly. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}