Azure Proactive Resiliency Library v2
Tools Glossary GitHub GitHub Issues Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Reports Cmdlet

Overview

The Reports cmdlet serves as the final step in a Well-Architected Reliability Assessment (WARA) engagement. It takes the Excel spreadsheet generated by the Data Analyzer cmdlet and converts it into Microsoft Word, PowerPoint, and Excel formats. The Reports cmdlet automates the process of creating comprehensive reports from the analyzed data, making it easier to share insights and recommendations.

Requirements

  • PowerShell 7
  • Microsoft Excel, Word and PowerPoint installed
  • Role Based Access Control: Reader role to access to resources to be evaluated. Although access to the Azure Subscriptions is not required to run the script, the access will be required for the user to complete some manual validations of configurations of Azure resources after the script generates the Excel file.

Quick Start (Local Machine only - Cloud Shell is not supported)

Start-WARAReport

The Start-WARAReport cmdlet is used to generate the WARA reports.

Whatever directory you run the Start-WARAReport cmdlet in, the Word and PowerPoint files will be created in that directory. For example: if you run the Start-WARAReport cmdlet in the C:\Temp directory, the Word and PowerPoint files will be created in the C:\Temp directory.

You can review all of the parameters of Start-WARAReport here.

Examples

Create the Word and PowerPoint reports from the Action Plan Excel output

Start-WARAReport -ExpertAnalysisFile 'C:\WARA\Expert-Analysis-v1-2025-02-04-11-14.xlsx'