Skip to content

Latest commit

 

History

History
150 lines (114 loc) · 3.1 KB

Start-WARAReport.md

File metadata and controls

150 lines (114 loc) · 3.1 KB
external help file Module Name online version schema
wara-help.xml
wara
2.0.0

Start-WARAReport

SYNOPSIS

Well-Architected Reliability Assessment Report Generator Function

SYNTAX

Start-WARAReport [-Help] [-includeLow] [[-CustomerName] <String>] [[-WorkloadName] <String>]
 [-ExpertAnalysisFile] <String> [[-AssessmentFindingsFile] <String>] [[-PPTTemplateFile] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The function `Start-WARAReport` processes the Excel file created by the `Start-WARAAnalyzer` command and generates the final PowerPoint and Word reports for the Well-Architected Reliability Assessment.

EXAMPLES

EXAMPLE 1

Start-WARAReport -ExpertAnalysisFile 'C:\WARA_Script\WARA Action Plan 2024-03-07_16_06.xlsx' -CustomerName 'ABC Customer' -WorkloadName 'SAP On Azure'

PARAMETERS

-Help

Switch to display help information.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-includeLow

Option to also consider Low Impact recommendations.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CustomerName

Name of the customer for whom the report is being generated.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WorkloadName

Name of the workload being assessed.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExpertAnalysisFile

Path to the Excel file created by the "2_wara_data_analyzer" script.

Type: String
Parameter Sets: (All)
Aliases: ExcelFile

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AssessmentFindingsFile

Path to the Assessment Findings file.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PPTTemplateFile

Path to the PowerPoint template file.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/Azure/Azure-Proactive-Resiliency-Library-v2