1

I am looking to get the real-time current amount spent by a given resource (not the whole subscription or a resource group) during the current period on MS Azure through Azure's REST API (e.g.: We have spent X$ so far this month on this resource). I have dug around the Billing API and general REST API documentation (and also their node.js SDK), but I can't find anything that seems to do that.

Has anyone ever done something similar? Any help will be greatly appreciated.

CedricLaberge
  • 592
  • 2
  • 7
  • 22

3 Answers3

6

Please note to this doc: Azure consumption API overview , here shows that you can use Usage Details API with filter to get what you want:

  • Filtering - Trim your API result set down to a smaller set of usage detail records using the following filters:
    • Usage end / usage start
    • Resource Group
    • Resource Name

Here is the format of this API:

GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/usageDetails?$expand={$expand}&$filter={$filter}&$skiptoken={$skiptoken}&$top={$top}&$apply={$apply}&api-version=2019-01-01

For {scope}, except can use '/subscriptions/{subscriptionId}/' for subscription scope, it can also use '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and etc. For more details, reference this doc.

Use $filter={$filter} can achieve what you want(access specific resource), here provided my API can for your reference:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?$expand=meterDetails,additionalProperties&$filter=properties/usageEnd ge '2019-01-1' AND properties/usageEnd le '2019-05-22' AND properties/instanceName eq '{instanceName}'&$top=30&api-version=2019-01-01

eq means equals, ge means greater or equal, le means less or equal, and the instanceNmae means your specific resource name that the usage is about.

Mengdi Liang
  • 17,577
  • 2
  • 28
  • 35
2

Azure Billing APIs can be used to pull usage and resource data into your preferred data analysis tools.

The Azure Resource Usage API and Azure Resource RateCard API can help accurately predict and manage costs. The APIs are implemented as a Resource Provider and part of the family of APIs exposed by the Azure Resource Manager.

Recommended Steps

  1. Use the Azure Resource Usage API to get the list of available Azure resources and estimated pricing information for each.
  2. Use Azure Resource RateCard API to get your estimated Azure consumption data.

Note: Support for Pay-as-you-go, MSDN, Monetary commitment, and Monetary credit offers (EA and CSP not supported)

  1. Azure Invoice Download API allows you to Access your Azure invoice in PDF Format once the opt-in has been complete. It can be used to pull usage and resource data into preferred data analysis tools.

Note: This feature is in first version of preview and may be subject to backward-incompatible changes. Currently, it's not available for certain subscription offers (EA, CSP, AIO not supported) and Azure Germany.

  1. Reporting APIs for EA customers - Usage Details offers a daily breakdown of consumed quantities and estimated charges by an Enrollment. The result also includes information on instances, meters, and departments. The API can be queried by Billing period or by a specified start and end date

Recommended Documents

  1. Azure Billing REST API

  2. Azure Billing API overview

  3. Azure Resource Manager overview

  4. REST API Browser

If you still have any query feel free o share. Thanks and happy coding!

Md Farid Uddin Kiron
  • 16,817
  • 3
  • 17
  • 43
1

The API you would want to look at is Consumption API and the operation you would want to use is Usage Details - List.

Please note that:

  • For {scope} parameter, please specify /subscriptions/{subscriptionId}/.
  • To get consumption for a particular resource you will need to specify that resource's path in $filter.

For example, if you want the consumption for a particular storage account for say the month of April 2019, this is how your filter criteria looks like:

$filter=properties/instanceId eq '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Storage/storageAccounts/{storage-account-name}' and properties/usageStart ge '2019-04-01T00:00:00.0000000Z' and properties/usageEnd lt '2019-05-01T00:00:00.0000000Z'&$expand=meterDetails,additionalProperties
Gaurav Mantri
  • 128,066
  • 12
  • 206
  • 241