Cost retrieval script

.gitignore

@@ -13,6 +13,8 @@
 1-Collect/summary.json
 2-AvailabilityCheck/Availability_*.json
 2-AvailabilityCheck/Azure_*.json
+3-CostInformation/*.json
+3-CostInformation/*.csv
 
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs

3-CostInformation/Get-CostInformation.ps1

@@ -0,0 +1,146 @@
+<#
+.SYNOPSIS
+    Take a collection of given resource IDs and return the cost incurred during previous months,
+    grouped as needed. For this we use the Microsoft.CostManagement provider of each subscription.
+    Requires Az.CostManagement module 0.4.2 or later.
+    PS1> Install-Module -Name Az.CostManagement
+
+.PARAMETER startDate
+    The start date of the period to be examined (default is the first day of the previous month)
+
+.PARAMETER endDate
+    The end date of the period to be examined (default is the last day of the previous month)
+
+.PARAMETER resourceFile
+    A JSON file containing the resources
+
+.PARAMETER outputFile
+    The CSV file to export the results to, otherwise displayed in the console
+
+.EXAMPLE
+    .\Get-CostInformation.ps1
+    .\Get-CostInformation.ps1 -startDate "2023-01-01" -endDate "2023-06-30" -resourceFile "resources.json" -outputFile "resource_cost.csv"
+
+#>
+
+param (
+    [string]$startDate    = (Get-Date).AddMonths(-1).ToString("yyyy-MM-01"),                    # the first day of the previous month
+    [string]$endDate      = (Get-Date).AddDays(-1 * (Get-Date).Day).ToString("yyyy-MM-dd"),     # the last day of the previous month
+    [string]$resourceFile = "resources.json",
+    [string]$outputFile   = "resource_cost.csv",
+    [switch]$testMode
+)
+
+# Output to file (true) or console (false)
+$fileOutput = $true
+
+# Timeframe
+# Supported types are BillingMonthToDate, Custom, MonthToDate, TheLastBillingMonth, TheLastMonth, WeekToDate
+$timeframe = "Custom"
+
+# Granularity
+# Supported types are Daily and Monthly so far. Omit just to get the total cost.
+#$granularity = "Monthly"
+
+# Type
+# Supported types are Usage (deprecated), ActualCost, and AmortizedCost
+# https://stackoverflow.com/questions/68223909/in-the-azure-consumption-usage-details-api-what-is-the-difference-between-the-m
+$type = "AmortizedCost"
+
+# Read the content of the workloads file
+$jsonContent = Get-Content -Path $resourceFile -Raw
+
+# Convert the JSON content to a PowerShell object
+$workloads = $jsonContent | ConvertFrom-Json
+$resourceTable = $workloads | Select-Object ResourceSubscriptionId, ResourceId
+
+if ($testMode) {
+    $subscriptionIds = @($subscriptionIds[0]) # For testing, use only the first subscription ID
+}
+
+$grouping = @(
+    @{
+        type = "Dimension"
+        name = "BillingMonth"
+    },
+    @{
+        type = "Dimension"
+        name = "ResourceId"
+    },
+    @{
+        type = "Dimension"
+        name = "PricingModel"
+    },
+    @{
+        type = "Dimension"
+        name = "MeterCategory"
+    },
+    @{
+        type = "Dimension"
+        name = "MeterSubcategory"
+    },
+    @{
+        type = "Dimension"
+        name = "Meter"
+    }
+)
+
+# Aggregation
+# Supported types are Sum, Average, Minimum, Maximum, Count, and Total.
+$aggregation = @{
+    PreTaxCost = @{
+        type = "Sum"
+        name = "PreTaxCost"
+    }
+}
+
+$table = @()
+
+$subscriptionIds = $resourceTable.ResourceSubscriptionId | Sort-Object -Unique
+
+if ($subscriptionIds.Count -eq 1) {
+    $subscriptionIds = @($subscriptionIds) # If only one subscription ID is found, use it as an array
+}
+
+# Loop through subscription IDs and issue a cost management query for the resources in each subscription
+
+for ($subIndex = 0; $subIndex -lt $subscriptionIds.Count; $subIndex++) {
+    $scope = "/subscriptions/$($subscriptionIds[$subIndex])"
+
+    $resourceIds = $resourceTable | Where-Object { $_.ResourceSubscriptionId -eq $subscriptionIds[$subIndex] } | Select-Object -ExpandProperty ResourceId
+    Write-Output "Querying subscription $(${subIndex}+1) of $($subscriptionIds.Count): $($subscriptionIds[$subIndex])"
+
+    $dimensions = New-AzCostManagementQueryComparisonExpressionObject -Name 'ResourceId' -Value $resourceIds
+    $filter = New-AzCostManagementQueryFilterObject -Dimensions $dimensions
+
+    $queryResult = Invoke-AzCostManagementQuery `
+        -Scope $scope `
+        -Timeframe $timeframe `
+        -Type $type `
+        -TimePeriodFrom $startDate `
+        -TimePeriodTo $endDate `
+        -DatasetAggregation $aggregation `
+        -DatasetGrouping $grouping `
+        -DatasetFilter $filter
+        # -DatasetGranularity $granularity
+
+    # Convert the query result into a table
+    for ($i = 0; $i -lt $queryResult.Row.Count; $i++) {
+        $row = [PSCustomObject]@{}
+        for ($j = 0; $j -lt $queryResult.Column.Count; $j++) {
+            $row | Add-Member -MemberType NoteProperty -Name $queryResult.Column.Name[$j] -Value $queryResult.Row[$i][$j]
+        }
+        $table += $row
+    }
+    # For testing - limit to one subscription
+    # $subIndex = $subscriptionIds.Count
+}
+
+# If an output file is specified, export the table to Excel, otherwise display it
+if ($fileOutput) {
+    #$table | Export-Excel -WorksheetName $label -TableName $label -Path .\$outputFile
+    $table | Export-Csv -Path $outputFile -NoTypeInformation -Encoding UTF8
+    Write-Output "$($table.Count) rows written to $outputFile"
+} else {
+    $table | Format-Table -AutoSize
+}

3-CostInformation/README.md

@@ -0,0 +1,60 @@
+# Cost data retrieval
+
+## About the script
+
+This script is intended to take a collection of given resource IDs and return the cost incurred during previous months, grouped as needed. For this we use the Microsoft.CostManagement provider of each subscription. This means one call of the Cost Management PowerShell module per subscription.
+
+Requires Az.CostManagement module version 0.4.2.
+
+`PS1> Install-Module -Name Az.CostManagement`
+
+Instructions for use:
+
+1. Log on to Azure using `Connect-AzAccount`. Ensure that you have Cost Management Reader access to each subscription listed in the resources file (default `resources.json`)
+2. Navigate to the 3-CostInformation folder and run the script using `.\Get-CostInformation.ps1`. The script will generate a CSV file in the current folder.
+
+## Documentation links
+Documentation regarding the Az.CostManagement module is not always straightforward. Helpful links are:
+
+| Documentation | Link |
+| -------- | ------- |
+| Cost Management Query (API) | [Link](https://learn.microsoft.com/en-us/rest/api/cost-management/query/usage) |
+| Az.CostManagement Query (PowerShell) | [Link](https://learn.microsoft.com/en-us/powershell/module/az.costmanagement/invoke-azcostmanagementquery) |
+
+Valid dimensions for grouping are:
+
+``` text
+AccountName
+BenefitId
+BenefitName
+BillingAccountId
+BillingMonth
+BillingPeriod
+ChargeType
+ConsumedService
+CostAllocationRuleName
+DepartmentName
+EnrollmentAccountName
+Frequency
+InvoiceNumber
+MarkupRuleName
+Meter
+MeterCategory
+MeterId
+MeterSubcategory
+PartNumber
+PricingModel
+PublisherType
+ReservationId
+ReservationName
+ResourceGroup
+ResourceGroupName
+ResourceGuid
+ResourceId
+ResourceLocation
+ResourceType
+ServiceName
+ServiceTier
+SubscriptionId
+SubscriptionName
+```