Linter rule - use description outputs

This rule requires every output to have a non-empty @description decorator. Clear descriptions explain the value returned by an output.

Linter rule code

Use the following value in the Bicep configuration file to customize rule settings:

use-description-outputs

Solution

The following output fails this rule because it has no description:

output storageAccountName string = storageAccount.name

To fix the problem, add a non-empty @description decorator:

@description('The name of the deployed storage account.')
output storageAccountName string = storageAccount.name

Next steps

For more information about the linter, see Use Bicep linter.