Linter rule - use description type properties

This rule requires properties in user-defined object types to have non-empty @description decorators. Clear descriptions explain the expected values in a type.

Linter rule code

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

use-description-type-properties

Solution

The following type fails this rule because its properties have no descriptions:

type StorageConfig = {
  name: string
  sku: string
}

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

type StorageConfig = {
  @description('The name of the storage account.')
  name: string

  @description('The SKU of the storage account.')
  sku: string
}

Next steps

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