Reserved instance purchase recommendation APIs for enterprise customers

  • Article

Note

On May 1st, 2024, Azure Enterprise Reporting APIs will be retired. Any remaining Enterprise Reporting APIs will stop responding to requests. Customers need to transition to using Microsoft Cost Management APIs before then. To learn more, see Migrate from Azure Enterprise Reporting to Microsoft Cost Management APIs overview.

The Reserved Instance recommendations API looks at Customer's 7, 30 or 60 days virtual machine usage and offers Single and Shared Purchase recommendations.

Request for shared reserved instance recommendations

See the Overview of Reporting APIs for Enterprise customers article to learn about common required header properties.

Method Request URI
GET https://consumption.azure.com/v2/enrollments/{enrollmentNumber}/SharedReservationRecommendations?lookBackPeriod=7

Shared recommendations response

[{
    "lookBackPeriod": "Last7Days",
    "meterId": "2e3c2132-1398-43d2-ad45-1d77f6574933",
    "skuName": "Standard_DS1_v2",
    "term": "P1Y",
    "region": "westus",
    "costWithNoRI": 186.27634908960002,
    "recommendedQuantity": 9,
    "totalCostWithRI": 143.12931642978083,
    "netSavings": 43.147032659819189,
    "firstUsageDate": "2018-02-19T00:00:00"
}
]

Response property definitions

Property Name Type Description
lookBackPeriod string String representing number of past usage days. It can either last7days, last30days or last60days
meterId string The Meter ID of the resource that should be purchased
skuName string This is the Azure Resource Manager SKU that needs to be purchased
term string P1Y for 1 year and P3Y for 3 years
region string Region where Reserved instance should be purchased
costWithNoRI string Total current cost
recommendedQuantity decimal Total Reserved Instance Quantity that should be purchased
totalCostWithRI decimal Total Cost if Recommended Quantity was purchased
netSavings decimal Net Savings within 7, 30 or 60 days
firstUsageDate decimal First time the Recommended VM was run.

Request for single reserved instance recommendations

See the Overview of Reporting APIs for Enterprise customers article to learn about common required header properties.

Method Request URI
GET https://consumption.azure.com/v2/enrollments/{enrollmentNumber}/SingleReservationRecommendations?lookBackPeriod=7

Single recommendation response

[{
    "subscriptionId": "d143f4db-5a12-46b9-ba15-9bff298b8f45",
    "lookBackPeriod": "Last7Days",
    "meterId": "2e3c2132-1398-43d2-ad45-1d77f6574933",
    "skuName": "Standard_DS1_v2",
    "term": "P1Y",
    "region": "westus",
    "costWithNoRI": 186.27634908960002,
    "recommendedQuantity": 9,
    "totalCostWithRI": 143.12931642978083,
    "netSavings": 43.147032659819189,
    "firstUsageDate": "2018-02-19T00:00:00"
}
]

Response property definitions

Property Name Type Description
subscriptionId string SubscriptionId for which Reserved Instance should be purchased
lookBackPeriod string String representing number of past usage days. It can have last7days, last30days, or last60days
meterId string The Meter ID of the resource that should be purchased
skuName string This is the Azure Resource Manager SKU that needs to be purchased
term string P1Y for 1 year and P3Y for 3 years
region string Region where Reserved instance should be purchased
costWithNoRI string Total current cost
recommendedQuantity decimal Total Reserved Instance Quantity that should be purchased
totalCostWithRI decimal Total Cost if Recommended Quantity was purchased
netSavings decimal Net Savings within 7, 30 or 60 days
firstUsageDate decimal First time the Recommended VM was run.

See also