This is a simple command line tool to get the cost of your Azure subscription. It uses the Azure Cost Management API to get the cost and output the results to the console or JSON. E.g. so it can be used in a workflow to get the cost of your subscription and use it in subsequent steps.
You can install this tool globally, using the dotnet tool command:
dotnet tool install --global azure-cost-cli
When there is a new version available on NuGet, you can use the dotnet tool update
command to upgrade:
dotnet tool update --global azure-cost-cli
With a --version
parameter, you can specify a specific version to install. Use the --no-cache
parameter to force a re-download of the package if it cannot find the latest version.
You can invoke the tool using the azure-cost
command. You can use the --help
parameter to get a list of all available options.
azure-cost --help
Which will show:
USAGE:
azure-cost [OPTIONS]
EXAMPLES:
azure-cost accumulatedCost -s 00000000-0000-0000-0000-000000000000
azure-cost accumulatedCost -s 00000000-0000-0000-0000-000000000000 -o json
azure-cost costByResource -s 00000000-0000-0000-0000-000000000000 -o text
azure-cost budgets -s 00000000-0000-0000-0000-000000000000
OPTIONS:
-h, --help Prints help information
--debug Increase logging verbosity to show all debug logs
-s, --subscription The subscription id to use
-o, --output The output format to use. Defaults to Console (Console, Json, JsonC, Markdown, Text, Csv)
-t, --timeframe The timeframe to use for the costs. Defaults to BillingMonthToDate. When set to Custom, specify the from and to dates using the --from and --to options
--from The start date to use for the costs. Defaults to the first day of the previous month
--to The end date to use for the costs. Defaults to the current date
--others-cutoff 10 The number of items to show before collapsing the rest into an 'Others' item
--query JMESPath query string. See http://jmespath.org/ for more information and examples
--useUSD Force the use of USD for the currency. Defaults to false to use the currency returned by the API
--skipHeader Skip header creation for specific output formats. Useful when appending the output from multiple runs into one file. Defaults to false
COMMANDS:
accumulatedCost Show the accumulated cost details
costByResource Show the cost details by resource
budgets Get the available budgets
When you do not specify a subscription id, it will fetch the actively selected one of the az cli
instead.
If the application is not working properly, you can use the
--debug
parameter to increase the logging verbosity and see more details.
This tool uses the Azure Cost Management API to get the cost. Not all subscriptions have access to this API. To check if your subscription has access, you can use the
az account subscription show --subscription-id yourid --query '[subscriptionPolicies.quotaId]' -o tsv
command. Validate the resulting quota id with the ones on the Microsoft list to see if it is supported. Running the tool with the--debug
parameter will also show the quota id that is used.
There is a pretty strict rate limit on the cost api; the calls are retried after a 429 is received, but it might take a while before the call succeeds as it honors the retry time out.
To make the call to the Azure cost API, you do need to run this from a user account with permissions to access the cost overview of the subscription. Further more, it needs to find the active credentials and it does so by using the ChainedTokenCredential
provider which will look for the az cli
token first. Make sure to run az login
(with optionally the --tenant
parameter) to make sure you have an active session.
You can use this tool in a GitHub workflow to get the cost of your subscription and store the results in markdown as a Job Summary. This can be used to get a quick overview of the cost of your subscription.
name: Azure Cost CLI Workflow
on:
workflow_dispatch:
inputs:
az-subscription-id:
description: 'Azure Subscription ID'
required: true
jobs:
run-azure-cost-cli:
runs-on: ubuntu-latest
steps:
- name: Azure Login
uses: azure/login@v1
with:
creds: ${{ secrets.AZURE_CREDENTIALS }}
- name: Install Azure Cost CLI
run: dotnet tool install -g azure-cost-cli
- name: Run Azure Cost CLI
run: azure-cost accumulatedCost -o markdown --subscription ${{ github.event.inputs.az-subscription-id }} >> $GITHUB_STEP_SUMMARY
The last step output the markdown to the Job Summary. This can be used to show the cost of the subscription in the workflow summary. Use it on a schedule to get for example a daily overview. Alternatively you can use the -o json
parameter to get the results in JSON format and use it for further processing.
This will retrieve the accumulated cost of the subscription. This is the total cost of the subscription since the beginning of the period specified. We will try to fetch the forecast as well and organise by location, type and resource group. You can use the different formatters to get the results in different formats.
This is the default command when you do not specify a command.
azure-cost accumulatedCost -s 574385a9-08e9-49fe-91a2-27660d92b8f5
This will retrieve the cost of the subscription by resource. This will fetch the resource details including the meter information. It is up to the formatter how this is returned. Use the json
formatter to get the full details.
azure-cost costByResource -s 574385a9-08e9-49fe-91a2-27660d92b8f5 -o json
This will retrieve the available budgets for the subscription. It will show the current status of the budget and the amount of the budget. As well as listing the configured notifications.
azure-cost budgets -s 574385a9-08e9-49fe-91a2-27660d92b8f5
Use the --query
to specify a JMESPath expression. This allows you to filter the results. For example, to get the yesterday cost of the subscription, you can use the following query:
azure-cost -s 574385a9-08e9-49fe-91a2-27660d92b8f5 -o json --query "totals.yesterdayCost"
Or to list only the resource groups:
azure-cost -s 574385a9-08e9-49fe-91a2-27660d92b8f5 -o json --query "ByResourceGroup[*].[ResourceGroup, Cost]"
will output:
[["mindbyte-sand-api",28.94824],["rg-test",16.457219149662315],["rg-weu",0.252499694771765],["cloud-storage-westeu",0.183537445632]]
For the JMESPath parsing, it uses the JMESPath.Net library. Not all constructions might be implemented yet. If you find a query that does not work, please open an issue with a reproducable path at their repo.
The tool supports multiple output formats. The default is Console
which will output the results to the console. You can specify a different format using the --output
parameter. The following formats are supported:
The default output format. It will output the results to the console in a graphical way.
The Json format is great for further processing of the data. It will output the results in a JSON format to the console. Using the > operator, you can redirect the output to a file. Use jsonc
to get a colorized output.
azure-cost accumulatedCost -s 00000000-0000-0000-0000-000000000000 -o json > cost.json
{
"totals": {
"todaysCost": 0.521266170218092,
"yesterdayCost": 2.367501588413211,
"lastSevenDaysCost": 17.089367673307038,
"lastThirtyDaysCost": 30.887236456720686
},
"cost": [
{
"Date": "2023-04-01",
"Cost": 2.365348403419757,
"Currency": "EUR"
},
// snip
],
"forecastedCosts": [
{
"Date": "2023-04-13",
"Cost": 0,
"Currency": "EUR"
},
// snip
],
"byServiceNames": [
{
"ServiceName": "API Management",
"Cost": 19.524664,
"Currency": "EUR"
},
// snip
],
"ByLocation": [
{
"Location": "EU West",
"Cost": 30.68711937543843,
"Currency": "EUR"
},
// snip
],
"ByResourceGroup": [
{
"ResourceGroup": "rg-west-eu",
"Cost": 30.68711937543843,
"Currency": "EUR"
},
// snip
]
}
A simple textual format. It will output the results in a simple text format.
Azure Cost Overview for 574385a9-08e9-49fe-91a2-27660d92b8f5 from 01/04/2023 to 14/04/2023
Totals:
Today: 0,52 EUR
Yesterday: 2,37 EUR
Last 7 days: 17,09 EUR
Last 30 days: 30,89 EUR
By Service Name:
API Management: 19,52 EUR
Azure App Service: 5,32 EUR
Azure Monitor: 3,67 EUR
Container Registry: 2,06 EUR
Log Analytics: 0,17 EUR
Storage: 0,13 EUR
Key Vault: 0,00 EUR
Bandwidth: 0,00 EUR
By Location:
EU West: 30,69 EUR
Unknown: 0,20 EUR
US West: 0,00 EUR
US West 2: 0,00 EUR
A CSV format. It will output the results in a CSV format which can be used in Excel or other tools. It will use the default culture of your system to format the numbers. If you combine the output of multiple runs into one file (like using the >>
to append to a file), you can use the --skipHeader
parameter to prevent the header from being written multiple times.
azure-cost accumulatedCost -s 574385a9-08e9-49fe-91a2-27660d92b8f5 -o csv > cost.csv
Date,Cost,CostUsd,Currencycost
01/05/2023,"2,366588585885843","2,563252097372957",EUR
02/05/2023,"2,36675103555328","2,563428046607759",EUR
03/05/2023,"2,366643737168579","2,563311831727289",EUR
04/05/2023,"2,366407861778791","2,563056355092609",EUR
05/05/2023,"2,367958990965315","2,564736383114534",EUR
06/05/2023,"1,904236728129323","2,06247880023687",EUR
07/05/2023,"2,36694351092248","2,613934066287242",EUR
08/05/2023,"0,521257579853968","0,575650808311731",EUR
A markdown format. It will output the results in a series of simple tables.
azure-cost accumulatedCost -s 574385a9-08e9-49fe-91a2-27660d92b8f5 -o markdown > cost.md
# Azure Cost Overview
> Details for subscription id `574385a9-08e9-49fe-91a2-27660d92b8f5` from **01/04/2023** to **20/04/2023**
## Totals
|Period|Amount|
|---|---:|
|Today|0,00 EUR|
|Yesterday|1,27 EUR|
|Last 7 days|15,48 EUR|
|Last 30 days|45,84 EUR|
## By Service Name
|Service|Amount|
|---|---:|
|API Management|28,95 EUR|
|Azure App Service|7,89 EUR|
|Azure Monitor|5,51 EUR|
|Container Registry|3,06 EUR|
|Log Analytics|0,25 EUR|
|Storage|0,19 EUR|
|Key Vault|0,00 EUR|
|Bandwidth|0,00 EUR|
## By Location
|Location|Amount|
|---|---:|
|EU West|45,55 EUR|
|Unknown|0,30 EUR|
|US West|0,00 EUR|
|US North Central|0,00 EUR|
|US West 2|0,00 EUR|
## By Resource Group
|Resource Group|Amount|
|---|---:|
|mindbyte-sand-api|28,95 EUR|
|mindbyte-sand-azuremonitor|5,51 EUR|
|mindbyte-sand-registry|3,06 EUR|
<sup>Generated at 2023-04-21 07:40:23</sup>
Excluded in the above sample, but it will also include mermaidjs diagrams as well.