Public/Get-SubscriptionCost.ps1
|
function Get-SubscriptionCost { <# .SYNOPSIS Retrieves the Azure costs for one or more billing months for one or more subscriptions. .DESCRIPTION Invokes the Get-AzConsumptionUsageDetail cmdlet against one or more subscriptions to return billing data for a specified number of months. If you are interested to see how costs have changed since the previous mont use the -ComparePrevious switch to return additional properties that contain the cost data for the previous month and properties that calculate the cost difference. .PARAMETER SubscriptionName The name or name/s of the Subscriptions to query. If not specified all subscriptions available in the current context will be used. .PARAMETER BillingMonth The billing month to query for cost data, specified as a [datetime] object. You can specify just month/year, e.g 10/2023. If not specified uses the current date. .PARAMETER PreviousMonths The number of previous billing months to query. Default: 0. .PARAMETER SparkLineSize The row height of sparklines to generate (requires PSparkines module). Default: 1. .PARAMETER ComparePrevious Switch: Include values for the previous billing month and adds additional properties that compare the current month to the previous. .PARAMETER ComparePreviousOffset The number of months prior you want to compare the current billing month to, when using -ComparePrevious, e.g set to 3 to compare to 3 months prior. .PARAMETER Raw Switch: Include the raw cost consumption data as a property on the returned object. .PARAMETER EaSubscription Switch: Force use of alternative consumption collection script for Enterprise Agreement subscriptions. .PARAMETER EaSubscriptionKind Specify the kind of Enterprise Agreement, modern or legacy. Default: modern. .EXAMPLE Get-SubscriptionCost Description ----------- Returns costs for the current billing month for all subscriptions in the current Azure context. .EXAMPLE Get-SubscriptionCost -SubscriptionName 'MySubscriptionA' Description ----------- Returns costs for the current billing month for the specified subscription name. .EXAMPLE Get-SubscriptionCost -SubscriptionName 'MySubscriptionA','MySubscriptionB' Description ----------- Returns costs for the current billing month for the specified subscription names. .EXAMPLE Get-SubscriptionCost -BillingMonth 01/2024 -PreviousMonths 3 Description ----------- Returns costs from October 2023 to January 2024 for all subscriptions in the current Azure context. .EXAMPLE Get-SubscriptionCost -BillingMonth 01/2024 -PreviousMonths 3 -ComparePrevious Description ----------- Returns costs from October 2023 to January 2024 for all subscriptions in the current Azure context and includes properties for comparing each month with the one prior. .EXAMPLE Get-SubscriptionCost -BillingMonth 01/2024 -PreviousMonths 3 -ComparePrevious -ComparePreviousOffset 12 Description ----------- Returns costs from October 2023 to January 2024 for all subscriptions in the current Azure context and includes properties for comparing each month with the one 12 months prior #> [CmdletBinding()] param( [Alias('Name', 'Subscription')] [string[]] $SubscriptionName, [Alias('Month')] [datetime] $BillingMonth = (Get-Date), [Alias('PrevMonths')] [int] $PreviousMonths = 0, [ValidateRange(1, 10)] [int] $SparkLineSize = 1, [Alias('ComparePrev')] [switch] $ComparePrevious, [Alias('ComparePrevOffset')] [int] $ComparePreviousOffset, [switch] $EaSubscription, [ValidateSet('Legacy', 'Modern')] [string] $EaSubscriptionKind = 'Modern', [switch] $Raw ) begin { # Store the users current AZ context before we start $PreAzContext = Get-AzContext } process { try { if (-not $SubscriptionName) { $SubscriptionName = (Get-AzSubscription -ErrorAction Stop).Name } foreach ($Name in $SubscriptionName) { try { $Consumption = $null $PrevConsumption = $null $isEaSubscription = $EaSubscription if ($PreAzContext.Subscription.Name -ne $Name) { Set-AzContext -Subscription $Name -ErrorAction Stop | Out-Null } $SubscriptionId = (Get-AzContext).Subscription.Id for ($BillingMonthCount = 0; $BillingMonthCount -le $PreviousMonths; $BillingMonthCount++) { $BillingDate = (Get-Date $BillingMonth).AddMonths(-$BillingMonthCount) $BillingPeriod = $BillingDate.ToString('yyyyMM') if (-not $ComparePreviousOffset) { $ComparePreviousOffset = 1 } $PrevBillingDate = (Get-Date $BillingMonth).AddMonths( - ($ComparePreviousOffset + $BillingMonthCount)) $PrevBillingPeriod = $PrevBillingDate.ToString('yyyyMM') try { $Consumption = if ($PrevConsumption -and $ComparePreviousOffset -eq 1) { $PrevConsumption } else { Write-Progress -Activity "Getting data for billing period $BillingPeriod" -Status $Name try { if (-not $isEaSubscription) { Get-AzConsumptionUsageDetail -BillingPeriodName $BillingPeriod -ErrorAction Stop } } catch { if ($_.Exception.Message -match 'BadRequest') { $isEaSubscription = $true } } if ($isEaSubscription) { Get-EaConsumptionUsageDetail -SubscriptionId $SubscriptionId -BillingPeriodName $BillingPeriod -SubscriptionKind $EaSubscriptionKind -ErrorAction Stop } } $Currency = ($Consumption | Select-Object -First 1).Currency $Cost = ($Consumption | Measure-Object -Property PretaxCost -Sum).Sum $DailyCost = Get-DailyCost -Consumption $Consumption $DailyCostCalc = $DailyCost.Cost | Measure-Object -Maximum -Minimum -Average -Sum $CostPerService = Get-ServiceCost -Consumption $Consumption $Budgets = Get-AzConsumptionBudget -ErrorAction SilentlyContinue $ActiveBudgets = foreach ($Budget in $Budgets) { if ($BillingDate -ge $Budget.TimePeriod.StartDate -and $Budget.TimePeriod.EndDate -ge $BillingDate) { [pscustomobject]@{ BudgetAmount = $Budget.Amount BudgetTimeGrain = $Budget.TimeGrain } } } if (Test-PSparklinesModule) { $CostSparkLine = if ($DailyCost.Count -gt 1) { $CostSparkLine = Get-Sparkline $DailyCost.Cost -NumLines $SparkLineSize | Write-Sparkline } } $CostObject = [ordered]@{ PSTypeName = 'Subscription.Cost' Name = $Name BillingPeriod = $BillingPeriod Currency = $Currency Cost = [math]::Round($Cost, 2) DailyCost_SparkLine = ($CostSparkLine -join "`n") DailyCost_Min = [math]::Round(($DailyCostCalc).Minimum, 2) DailyCost_Max = [math]::Round(($DailyCostCalc).Maximum, 2) DailyCost_Avg = [math]::Round(($DailyCostCalc).Average, 2) MostExpensive_Date = ($DailyCost | Sort-Object Cost -Descending | Select-Object -First 1).Date LeastExpensive_Date = ($DailyCost | Sort-Object Cost | Select-Object -First 1).Date DailyCost = $DailyCost CostPerService = $CostPerService MostExpensiveService = ($CostPerService | Sort-Object Cost -Descending | Select-Object -First 1).Service MostExpensiveService_Cost = [math]::Round(($CostPerService | Sort-Object Cost -Descending | Select-Object -First 1).Cost, 2) LeastExpensiveService = ($CostPerService | Sort-Object Cost | Select-Object -First 1).Service LeastExpensiveService_Cost = [math]::Round(($CostPerService | Sort-Object Cost | Select-Object -First 1).Cost, 2) ActiveBudgets = $ActiveBudgets } if ($ComparePrevious) { Write-Progress -Activity "Getting data for previous billing period $PrevBillingPeriod" -Status $Name try { if (-not $isEaSubscription) { $PrevConsumption = Get-AzConsumptionUsageDetail -BillingPeriodName $BillingPeriod -ErrorAction Stop } } catch { if ($_.Exception.Message -match 'BadRequest') { $isEaSubscription = $true } } if ($isEaSubscription) { $PrevConsumption = Get-EaConsumptionUsageDetail -SubscriptionId $SubscriptionId -BillingPeriodName $BillingPeriod -SubscriptionKind $EaSubscriptionKind -ErrorAction Stop } $PrevCost = ($PrevConsumption | Measure-Object -Property PretaxCost -Sum).Sum $PrevDailyCost = Get-DailyCost -Consumption $PrevConsumption $PrevDailyCostCalc = $PrevDailyCost.Cost | Measure-Object -Maximum -Minimum -Average -Sum $PrevCostPerService = Get-ServiceCost -Consumption $PrevConsumption $CostChange = $Cost - $PrevCost $ChangePct = $CostChange / $PrevCost $DailyCostChange = Get-DailyCostChange -DailyCost $DailyCost -PrevDailyCost $PrevDailyCost -ComparePreviousOffset $ComparePreviousOffset if (Test-PSparklinesModule) { $PrevCostSparkLine = if ($PrevDailyCost.Count -gt 1) { Get-Sparkline $PrevDailyCost.Cost -NumLines $SparkLineSize | Write-Sparkline } } $ComparePreviousCostObject = [ordered]@{ PrevBillingPeriod = $PrevBillingPeriod PrevCost = [math]::Round($PrevCost, 2) PrevDailyCost_SparkLine = ($PrevCostSparkLine -join "`n") PrevDailyCost_Min = [math]::Round(($PrevDailyCostCalc).Minimum, 2) PrevDailyCost_Max = [math]::Round(($PrevDailyCostCalc).Maximum, 2) PrevDailyCost_Avg = [math]::Round(($PrevDailyCostCalc).Average, 2) PrevMostExpensiveDate = ($DailyCost | Sort-Object Cost -Descending | Select-Object -First 1).Date PrevLeastExpensiveDate = ($DailyCost | Sort-Object Cost | Select-Object -First 1).Date PrevDailyCost = $PrevDailyCost PrevCostPerService = $PrevCostPerService PrevMostExpensiveService = ($PrevCostPerService | Sort-Object Cost -Descending | Select-Object -First 1).Service PrevMostExpensiveService_Cost = [math]::Round(($PrevCostPerService | Sort-Object Cost -Descending | Select-Object -First 1).Cost, 2) PrevLeastExpensiveService = ($PrevCostPerService | Sort-Object Cost | Select-Object -First 1).Service PrevLeastExpensiveService_Cost = [math]::Round(($PrevCostPerService | Sort-Object Cost | Select-Object -First 1).Cost, 2) CostChange = [math]::Round($CostChange, 2) CostChange_Pct = "{0:p2}" -f $ChangePct DailyCostChange = $DailyCostChange } $CostObject += $ComparePreviousCostObject $CostObject['PSTypeName'] = 'Subscription.Cost.ComparePrev' } if ($Raw) { $RawCostObject = [ordered]@{ Consumption_Raw = $Consumption } $CostObject += $RawCostObject } if ($ComparePrevious -and $Raw) { $PrevRawCostObject = [ordered]@{ PrevConsumption_Raw = $PrevConsumption } $CostObject += $PrevRawCostObject } [pscustomobject]$CostObject } catch { Write-Error $_ } } } catch { Write-Error $_ } } } catch { throw $_ } finally { # Return the user to their previous AZ context (in case it has changed). $PreAzContext | Set-AzContext | Out-Null } } } |