Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markwragg/powershell-azcosttools
A PowerShell module for cmdlets related to Azure cost analysis.
https://github.com/markwragg/powershell-azcosttools
Last synced: about 6 hours ago
JSON representation
A PowerShell module for cmdlets related to Azure cost analysis.
- Host: GitHub
- URL: https://github.com/markwragg/powershell-azcosttools
- Owner: markwragg
- Created: 2024-01-09T16:03:35.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T16:30:16.000Z (2 months ago)
- Last Synced: 2024-09-15T17:53:09.212Z (2 months ago)
- Language: PowerShell
- Size: 27.4 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# PowerShell-AzCostTools
[](https://dev.azure.com/markwragg/GitHub/_build/latest?definitionId=11&branchName=main) 
A PowerShell module for cmdlets related to Azure cost analysis.
## Installation
The module is published in the PSGallery, so if you have PowerShell 5 or newer can be installed by running:
```powershell
Install-Module AzCostTools
```
## Prerequisites
This module requires the [AZ module](https://learn.microsoft.com/en-us/powershell/azure/install-azps-windows) be installed:
```powershell
Install-Module Az
```
I also recommend you install the [PSparklines module](https://github.com/endowdly/PSparklines) by [@endowdly](https://github.com/endowdly). While AzCostTools will function without it, PSparklines enables the additional generation of simplistic text based cost charts.
```powershell
Install-Module PSparklines
```
## Usage
### Retrieving costs
Ensure you have logged in to AZ PowerShell via `Login-AzAccount` and to the tenant that has the Subscription/s you wish to query.
> Depending on the number of subscriptions and/or previous months of data you wish to query the `Get-SubscriptionCost` cmdlet can take a few minutes to run.
> I recommend you return the results to a variable. If you want to see the output while also saving to a variable, use the `-OutVariable` parameter.
> E.g: `Get-SubscriptionCost -OutVariable Cost` will return the results to `$Cost` while also showing them on screen.
To return cost data for the current billing month for all Subscriptions in your current Azure Context, execute:
```powershell
Get-SubscriptionCost
```
> Errors may be returned for any subscriptions where the cost data is inaccessible, e.g you are not authorised to access costs or the subscription is of a type where costs are managed externally (such as a CSP).
There is a default table view. Pipe the result to `Format-List` to see all of the properties that are returned.
To return cost data for the current billing month for a specified subscription, and compare those costs to the previous billing month, execute:
```powershell
Get-SubscriptionCost -SubscriptionName 'AdventureWorks Cycles' -ComparePrevious -SparkLineSize 3
```
> In the above example we also increased the size of the charts by specifying `-SparkLineSize`.
To return a number of previous months, you can use the `-PreviousMonths` parameter. For example:
```powershell
Get-SubscriptionCost -PreviousMonths 5 -ComparePrevious
```
> In the above example we've also used `-ComparePrevious` so that for each month calculations are made comparing it to the previous month. This is optional.
When using `-ComparePrevious` you can also specify `-ComparePreviousOffset`. This will compare each month of cost data returned to X month/s prior as specified.
For example, if you wanted to compare costs for the last 6 months against the same 6 months from the year prior, you could execute:
```powershell
Get-SubscriptionCost -PreviousMonths 6 -ComparePrevious -ComparePreviousOffset 12
```
Other parameters available for `Get-SubscriptionCost` include:
* `-BillingMonth` — Use to specify a specific month to retrieve costs (or as a starting point from when also retrieving previous months costs).
* `-Raw` — Adds properties to the resultant object that include the raw cost data returned by `Get-AzConsumptionUsageDetail` in case you want to do further direct analysis/manipulation.
### Cost Analysis
Having retrieved a set of cost data for one or more subscriptions, you can pipe that data to `Show-CostAnalysis` to generate charts and tables analysing the costs:
```powershell
$Cost | Show-CostAnalysis
```
If `PSparklines` is installed, a daily cost chart will be generated. If the subscription has a budget this will show red for days over budget, and green for under (based on a daily budget calculation).
If there is no budget for the subscription the chart will be white.
A chart and table is also generated of the top 15 service costs, with each service name mapped to an individual colour.
If more than one subscription is in the cost data, the cmdlet will end with a total of cost for all subscriptions and a chart showing most to least expensive.
With `Show-CostAnalysis` you can also customise the size of the charts returned by specifying `-SparkLineSize`. The default is 3.
You can also specify `-ConvertToCurrency` with a 3 letter currency code if you'd like the cost values returned to be converted to a different currency.
Sometimes Azure costs are billed in a currency that is not your own and it may be more informative to view them in your local currency. For example:
```powershell
$Cost | Show-CostAnalysis -ConvertToCurrency GBP
```
> Note that this uses a free/open API for currency conversion that only refreshes the exchange rates once a day.
If you used `-ComparePrevious` when executing `Get-SubscriptionCost` you can also specify `-ComparePrevious` for `Show-CostAnalysis` to generate further tables and charts for the previous cost data. This might be most useful when using `-ComparePreviousOffset` so that you can see the charts side by side of the current and previous costs. For example:
```powershell
$Cost | Show-CostAnalysis -ComparePrevious
```
