Skip to content

QUICKSTART.md

Latest commit

 

History

History
137 lines (92 loc) · 3.11 KB

QUICKSTART.md

File metadata and controls

137 lines (92 loc) · 3.11 KB

AzRetirementMonitor v2.0 - Quick Start Guide

Compatible with PowerShell 5.1+ (Desktop and Core)

Quick Start (Recommended Method)

# Step 1: Install required modules
Install-Module -Name Az.Advisor, Az.Accounts -Scope CurrentUser

# Step 2: Connect to Azure
Connect-AzAccount

# Step 3: Get retirement recommendations
Get-AzRetirementRecommendation

# Step 4: Export to HTML report
Get-AzRetirementRecommendation | Export-AzRetirementReport -OutputPath "report.html" -Format HTML

Alternative Method (REST API)

# Step 1: Log in to Azure CLI
az login

# Step 2: Connect module for API access
Connect-AzRetirementMonitor -UsingAPI

# Step 3: Get retirement recommendations via API
Get-AzRetirementRecommendation -UseAPI

# Step 4: Export to CSV report
Get-AzRetirementRecommendation -UseAPI | Export-AzRetirementReport -OutputPath "report.csv" -Format CSV

# Step 5: Disconnect when done
Disconnect-AzRetirementMonitor

What Changed in v2.0?

✅ Default Method (NEW)

  • Uses Az.Advisor PowerShell module
  • Full parity with Azure Portal
  • No need for Connect-AzRetirementMonitor
  • Just run Connect-AzAccount and go!

⚙️ API Method (Still Available)

  • Uses REST API directly
  • Requires Connect-AzRetirementMonitor -UsingAPI
  • Use -UseAPI switch on Get-AzRetirementRecommendation

Common Commands

Get All Recommendations

# Default method
Get-AzRetirementRecommendation

# API method
Get-AzRetirementRecommendation -UseAPI

Get Recommendations for Specific Subscriptions

Get-AzRetirementRecommendation -SubscriptionId "12345678-1234-1234-1234-123456789012"

Export to Different Formats

# CSV
Get-AzRetirementRecommendation | Export-AzRetirementReport -OutputPath "report.csv" -Format CSV

# JSON
Get-AzRetirementRecommendation | Export-AzRetirementReport -OutputPath "report.json" -Format JSON

# HTML
Get-AzRetirementRecommendation | Export-AzRetirementReport -OutputPath "report.html" -Format HTML

Troubleshooting

"Az.Advisor module not available or not connected"

Solution: Install the module and connect to Azure

Install-Module -Name Az.Advisor -Scope CurrentUser
Connect-AzAccount

"Not authenticated. Run Connect-AzRetirementMonitor -UsingAPI first"

Solution: You're trying to use API mode. Either:

  1. Remove -UseAPI to use default method, OR
  2. Run Connect-AzRetirementMonitor -UsingAPI first

"Connect-AzRetirementMonitor requires -UsingAPI parameter"

Solution: This is expected! For default method, you don't need Connect-AzRetirementMonitor.

# For default method (recommended)
Connect-AzAccount  # NOT Connect-AzRetirementMonitor

# For API method only
Connect-AzRetirementMonitor -UsingAPI

Migration from v1.x

Old workflow:

Connect-AzRetirementMonitor
Get-AzRetirementRecommendation

New workflow (recommended):

Connect-AzAccount
Get-AzRetirementRecommendation

New workflow (API method):

Connect-AzRetirementMonitor -UsingAPI
Get-AzRetirementRecommendation -UseAPI