Regola Linter - usa le proprietà del tipo di descrizione

Questa regola richiede che le proprietà nei tipi di oggetti definiti dall'utente abbiano decoratori non vuoti @description . Descrizioni chiare spiegano i valori attesi in un tipo.

Note

Questa regola è disattivata di default. Cambia il livello inbicepconfig.json per attivarlo. Questa regola valuta anche proprietà aggiuntive dichiarate con *.

Codice regola Linter

Usare il valore seguente nel file di configurazione Bicep per personalizzare le impostazioni delle regole:

use-description-type-properties

Soluzione

Il seguente tipo non rispetta questa regola perché le sue proprietà non hanno descrizioni:

type StorageConfig = {
  name: string
  sku: string
}

Per risolvere il problema, aggiungi un decoratore non vuoto @description a ogni proprietà:

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

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

Passaggi successivi

Per ulteriori informazioni su linter, vedere Usare linter di Bicep.