Add reference to built-in rules in README
This commit is contained in:
Родитель
d41480a5f9
Коммит
95ce2b7b93
|
@ -14,6 +14,8 @@ The Template BPA is built using .NET 5. Having the [.NET 5 Runtime](https://dot
|
|||
|
||||
After ensuring the .NET Runtime is installed, download the latest Template BPA release by clicking on 'Releases' to the right.
|
||||
|
||||
Also explore [information about 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:
|
||||
|
||||
|
@ -23,6 +25,7 @@ Currently, the working directory during execution must be the same directory the
|
|||
|
||||
### Input
|
||||
The Template BPA depends on a few inputs – the Template BPA rules, ARM template, and (optional) ARM template parameters. The Template BPA rules are written in JSON. You can add and modify what rules to run. See the [documentation for more information about how to author Template BPA JSON rules](./docs/authoring-json-rules.md). The Template BPA then runs the configured rules against the provided [ARM templates]( https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/) and their 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 templates.
|
||||
|
||||
**Note**: Providing the Template BPA with template parameter values will result in more accurate results as it will more accurately represent your deployments. The values provided to parameters may affect the evaluation of the Template BPA rule, altering its results. That said, **do not** save sensitive data (passwords, connection strings, etc.) in parameter files in your repositories. Instead, [retrieve these values from your ARM template from Azure Key Vault](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/key-vault-parameter?tabs=azure-cli#reference-secrets-with-static-id).
|
||||
|
||||
### Output
|
||||
|
|
Загрузка…
Ссылка в новой задаче