Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
EA customers who were previously using the Enterprise Reporting consumption.azure.com API to obtain reserved instance usage summaries need to migrate to a parity Azure Resource Manager API. The following instructions help you migrate and discuss any contract differences between the old API and the new API.
Note
All Azure Enterprise Reporting APIs are retired. You should Migrate to Microsoft Cost Management APIs as soon as possible.
Before calling the API, you need to configure a Service Principal with the correct permission. You use the service principal to call the API. For more information, see Assign permissions to Cost Management APIs.
Use the following request URIs to call the new Reservation Summaries API.
Call the API with the following scopes:
- Enrollment:
providers/Microsoft.Billing/billingAccounts/{billingAccountId}
https://management.chinacloudapi.cn/{scope}/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2023-05-01
Get Reservation Summary Monthly
https://management.chinacloudapi.cn/{scope}/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2023-05-01
Old response:
[
{
"reservationOrderId": "00000000-0000-0000-0000-000000000000",
"reservationId": "00000000-0000-0000-0000-000000000000",
"skuName": "Standard_F1s",
"reservedHours": 24,
"usageDate": "2018-05-01T00:00:00",
"usedHours": 23,
"minUtilizationPercentage": 0,
"avgUtilizationPercentage": 95.83,
"maxUtilizationPercentage": 100
}
]
New response:
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
"name": "reservationSummaries_Id1",
"type": "Microsoft.Consumption/reservationSummaries",
"tags": null,
"properties": {
"reservationOrderId": "00000000-0000-0000-0000-000000000000",
"reservationId": "00000000-0000-0000-0000-000000000000",
"skuName": "Standard_B1s",
"reservedHours": 720,
"usageDate": "2018-09-01T00:00:00-07:00",
"usedHours": 0,
"minUtilizationPercentage": 0,
"avgUtilizationPercentage": 0,
"maxUtilizationPercentage": 0
}
}
]
}
- Read the Migrate from EA Reporting to ARM APIs overview article.