Skip to content

Documentation verification: Add explicit compatibility notes to Export-AzRetirementReport help #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cocallaw merged 2 commits into from
Jan 13, 2026
+19 −0
Merged

Documentation verification: Add explicit compatibility notes to Export-AzRetirementReport help #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64ff0ae
Initial plan
Copilot Jan 13, 2026
ce5769d
Enhanced Export-AzRetirementReport help documentation
Copilot Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions Public/Export-AzRetirementReport.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,25 @@ function Export-AzRetirementReport {
<#
.SYNOPSIS
Exports retirement recommendations to CSV, JSON, or HTML
.DESCRIPTION
Exports retirement recommendations retrieved from Get-AzRetirementRecommendation to various
formats for reporting and analysis. Works with recommendations from both the default Az.Advisor
method and the API method.
.PARAMETER Recommendations
Recommendation objects from Get-AzRetirementRecommendation (accepts pipeline input)
.PARAMETER OutputPath
File path for the exported report
.PARAMETER Format
Export format: CSV, JSON, or HTML (default: CSV)
.EXAMPLE
Get-AzRetirementRecommendation | Export-AzRetirementReport -OutputPath "report.csv" -Format CSV
Exports recommendations to CSV format
.EXAMPLE
Get-AzRetirementRecommendation | Export-AzRetirementReport -OutputPath "report.html" -Format HTML
Exports recommendations to HTML format
.EXAMPLE
Get-AzRetirementRecommendation -UseAPI | Export-AzRetirementReport -OutputPath "report.json" -Format JSON
Exports API-sourced recommendations to JSON format
#>
[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Low')]
param(
Expand Down