This commit is contained in:
Norbu Sonam 2021-07-15 16:03:02 -04:00
Родитель 926b0c5431
Коммит 999650560e
1 изменённых файлов: 6 добавлений и 3 удалений

Просмотреть файл

@ -16,16 +16,19 @@ After ensuring the .NET Runtime is installed, download the latest Template BPA r
To preview the rules that come bundled with the Template BPA, explore [the built-in rules](docs/built-in-bpa-rules.md).
## Using the Template BPA
The Template BPA is executed via a command line. Here is the format to invoke it:
The Template BPA is executed via a command line. Here are the formats to invoke it:
`TemplateAnalyzer.exe -t <template-path> [-p <parameters-path>]`
`TemplateAnalyzer.exe analyze-template <template-path> [-p <parameters-path>]`
`TemplateAnalyzer.exe analyze-directory <directory-path>`
### Input
The Template BPA accepts the following inputs:
Argument | Description
--- | ---
`-t` or `--template-file-path` | The ARM template to analyze
`<template-path>` | The ARM template to analyze
`<directory-path>` | The directory to find ARM templates
**(Optional)** `-p` or `--parameters-file-path` | A [parameters file](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/parameter-files)
The Template BPA runs the [configured rules](#understanding-and-customizing-rules) against the provided ARM template and its corresponding [template parameters](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/parameter-files), if specified. If no template parameters are specified, then the Template BPA generates the minimum number of placeholder parameters to properly evaluate [template functions](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-functions) in the ARM template.