Modules/Inventory/ARIResourceReport.psm1
|
<#
.Synopsis Main module for Excel Report Building .DESCRIPTION This module is the main module for building the Excel Report. .Link https://github.com/microsoft/ARI/Modules/Inventory/ARIResourceReport.psm1 .COMPONENT This powershell Module is part of Azure Resource Inventory (ARI) .NOTES Version: 4.0.1 First Release Date: 15th Oct, 2024 Authors: Claudio Merola #> Function Build-AzureResourceReport { Param($Subscriptions, $ExtractionRuntime, $DefaultPath, $Resources, $SecurityCenter, $File, $DDFile, $Heavy, $SkipDiagram, $RunLite, $PlatOS, $InTag, $SkipAPIs, $SkipPolicy, $SkipAdvisory, $Automation, $Overview, $Debug) if ($Overview -eq 1 -and $SkipAPIs) { $Overview = 2 } if ($Debug.IsPresent) { $DebugPreference = 'Continue' $ErrorActionPreference = 'Continue' } else { $ErrorActionPreference = "silentlycontinue" } $ReportingRunTime = Measure-Command -Expression { #### Generic Conditional Text rules, Excel style specifications for the spreadsheets and tables: $TableStyle = "Light19" Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Excel Table Style used: ' + $TableStyle) Write-Progress -activity 'Azure Inventory' -Status "21% Complete." -PercentComplete 21 -CurrentOperation "Starting to process extraction data.." <######################################################### IMPORT UNSUPPORTED VERSION LIST ######################################################################> Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Importing List of Unsupported Versions.') $Unsupported = Get-ARIUnsupportedData -Debug $Debug $DataActive = ('Azure Resource Inventory Reporting (' + ($Resources.count) + ') Resources') <######################################################### RESOURCE GROUP JOB ######################################################################> if ($Automation.IsPresent) { $SmaResources = Start-ARIAutResourceJob -Resources $Resources -Subscriptions $Subscriptions -InTag $InTag -Unsupported $Unsupported } else { Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Starting Resource Jobs.') $DebugEnvSize = Start-ARIResourceJobs -Resources $Resources -Subscriptions $Subscriptions -InTag $InTag -Heavy $Heavy -Unsupported $Unsupported -Debug $Debug } <############################################################## RESOURCES LOOP CREATION #############################################################> if (!$Automation.IsPresent) { if($DebugEnvSize -in ('Large','Medium-Large')) { Clear-Variable -Name Resources [System.GC]::Collect() | out-null Start-Sleep -Milliseconds 100 [System.GC]::GetTotalMemory($true) | out-null Start-Sleep -Milliseconds 100 } Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Starting Jobs Collector.') Write-Progress -activity $DataActive -Status "Processing Inventory" -PercentComplete 0 $c = 0 $JobNames = (Get-Job | Where-Object {$_.name -like 'ResourceJob_*'}).Name while (get-job -Name $JobNames | Where-Object { $_.State -eq 'Running' }) { $jb = get-job -Name $JobNames $c = (((($jb.count - ($jb | Where-Object { $_.State -eq 'Running' }).Count)) / $jb.Count) * 100) Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Resource Jobs Still Running: '+[string]($jb | Where-Object { $_.State -eq 'Running' }).count) $c = [math]::Round($c) Write-Progress -Id 1 -activity "Processing Resource Jobs" -Status "$c% Complete." -PercentComplete $c Start-Sleep -Seconds 5 } Write-Progress -Id 1 -activity "Processing Resource Jobs" -Status "100% Complete." -Completed Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Jobs Compleated.') if($DebugEnvSize -ne 'Large') { $SmaResources = Foreach ($Job in $JobNames) { $TempJob = Receive-Job -Name $Job Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Job '+ $Job +' Returned: ' + ($TempJob.values | Where-Object {$_ -ne $null}).Count + ' Resource Types.') $TempJob } } else { Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Checking Cache Folder.') if ((Test-Path -Path ($DefaultPath+'ReportCache\') -PathType Container) -eq $false) { Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Creating Folder for Cache Files.') New-Item -Type Directory -Force -Path ($DefaultPath+'ReportCache\') | Out-Null } else { If ((Get-ChildItem -Path ($DefaultPath+'ReportCache\') -Recurce | Measure-Object).Count -ge 1) { Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Removing Old Cache Files.') Remove-Item -Path ($DefaultPath+'\ReportCache') -Recurse New-Item -Type Directory -Force -Path ($DefaultPath+'ReportCache\') | Out-Null } } Foreach ($Job in $JobNames) { $TempJob = Receive-Job -Name $Job Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Job '+ $Job +' Returned: ' + ($TempJob.values | Where-Object {$_ -ne $null}).Count + ' Resource Types.') Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Creating Cache File: '+$job) $TempJob | ConvertTo-Json -Depth 40 | Out-File ($DefaultPath+'ReportCache\'+$job+'.json') Remove-Job -Name $Job Remove-Variable -Name TempJob } } } <############################################################## Processing ###################################################################> if($DebugEnvSize -eq 'Large') { Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Starting Resource Reporting Cache (Large Environment).') Build-ARILargeReportResources -DefaultPath $DefaultPath -Debug $Debug } <################################################################### EXTRA REPORTS ###################################################################> Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Starting Default Data Reporting.') Start-ARIExtraReports -File $File -QuotaUsage $QuotaUsage -SecurityCenter $SecurityCenter -SkipPolicy $SkipPolicy -SkipAdvisory $SkipAdvisory -TableStyle $TableStyle -Debug $Debug <################################################################### LARGE ENV REPORTS ###################################################################> if($DebugEnvSize -eq 'Large') { $c = 0 $JobNames = (Get-Job | Where-Object {$_.name -like 'ExcelJob_*'}).Name while (get-job -Name $JobNames | Where-Object { $_.State -eq 'Running' }) { $jb = get-job -Name $JobNames $c = (((($jb.count - ($jb | Where-Object { $_.State -eq 'Running' }).Count)) / $jb.Count) * 100) Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Reporting Jobs Still Running: '+[string]($jb | Where-Object { $_.State -eq 'Running' }).count) $c = [math]::Round($c) Write-Progress -Id 1 -activity "Processing Excel Jobs" -Status "$c% Complete." -PercentComplete $c Start-Sleep -Seconds 5 } Write-Progress -Id 1 -activity "Processing Excel Jobs" -Status "100% Complete." -Completed Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Excel Jobs Compleated.') Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Starting Ordering of Cached Files.') Start-ARILargeEnvOrderFiles -DefaultPath $DefaultPath -Debug $Debug } <################################################################### RESOURCE REPORTING ###################################################################> Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Starting Resource Reporting.') Start-ARIResourceReporting -InTag $InTag -file $file -SmaResources $SmaResources -DefaultPath $DefaultPath -TableStyle $TableStyle -Unsupported $Unsupported -DebugEnvSize $DebugEnvSize -DataActive $DataActive -Debug $Debug <################################################################### REPORTING HEADERS ###################################################################> Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Adjusting Header Details.') Start-ARIExcelHeaders -File $file -Debug $Debug <################################################################### CHARTS ###################################################################> Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Generating Overview sheet (Charts).') } Write-Progress -activity 'Azure Resource Inventory Reporting Charts' -Status "15% Complete." -PercentComplete 15 -CurrentOperation "Invoking Excel Chart's Module." Build-ARIExcelChart -File $File -TableStyle $TableStyle -PlatOS $PlatOS -Subscriptions $Subscriptions -ExtractionRunTime $ExtractionRuntime -ReportingRunTime $ReportingRunTime -RunLite $RunLite -Overview $Overview -Debug $Debug [System.GC]::GetTotalMemory($true) | out-null Start-Sleep -Milliseconds 100 [System.GC]::Collect() | out-null Start-Sleep -Milliseconds 100 Write-Debug ((get-date -Format 'yyyy-MM-dd_HH_mm_ss')+' - '+'Finished Charts Phase.') Write-Progress -activity 'Azure Resource Inventory Reporting Charts' -Status "100% Complete." -Completed if(!$SkipDiagram.IsPresent) { Write-Progress -activity 'Diagrams' -Status "Completing Diagram" -PercentComplete 70 -CurrentOperation "Consolidating Diagram" while (get-job -Name 'DrawDiagram' | Where-Object { $_.State -eq 'Running' }) { Write-Progress -Id 1 -activity 'Processing Diagrams' -Status "50% Complete." -PercentComplete 50 Start-Sleep -Seconds 2 } Write-Progress -Id 1 -activity 'Processing Diagrams' -Status "100% Complete." -Completed Write-Progress -activity 'Diagrams' -Status "Closing Diagram File" -Completed } Get-Job | Wait-Job | Remove-Job } |