Usare Bicep linter

Bicep linter controlla i file Bicep per individuare errori di sintassi e violazioni delle procedure consigliate. Linter consente di applicare gli standard di codifica fornendo indicazioni durante lo sviluppo. È possibile personalizzare le procedure consigliate da usare per controllare il file.

Requisiti di Linter

Linter è integrato nell'interfaccia della riga di comando di Bicep e nell'estensione Bicep per Visual Studio Code. Per usarlo, è necessario avere la versione 0.4 o successiva.

Regole predefinite

Il set predefinito di regole linter è minimo e ottenuto da test case arm-ttk. L'estensione e l'interfaccia della riga di comando di Bicep controllano le regole seguenti, che vengono impostate sul livello di avviso.

• adminusername-should-not-be-literal
• artifacts-parameters
• decompiler-cleanup
• explicit-values-for-loc-params
• max-asserts
• max-outputs
• max-params
• max-resources
• max-variables
• nested-deployment-template-scoping
• no-conflicting-metadata
• no-deployments-resources
• no-hardcoded-env-urls
• no-hardcoded-location
• no-loc-expr-outside-params
• no-unnecessary-dependson
• no-unused-existing-resources
• no-unused-params
• no-unused-vars
• outputs-should-not-contain-secrets
• prefer-interpolation
• prefer-unquoted-property-names
• secure-parameter-default
• secure-params-in-nested-deploy
• secure-secrets-in-params
• simplify-interpolation
• simplify-json-null
• use-parent-property
• use-protectedsettings-for-commandtoexecute-secrets
• use-recent-api-versions
• use-resource-id-functions
• use-resource-symbol-reference
• use-stable-resource-identifiers
• use-stable-vm-image

È possibile personalizzare la modalità di applicazione delle regole linter. Per sovrascrivere le impostazioni predefinite, aggiungere un file bicepconfig.json e applicare impostazioni personalizzate. Per altre informazioni sull'applicazione di tali impostazioni, vedere Aggiungere impostazioni personalizzate nel file di configurazione bicep.

Usare in Visual Studio Code

Lo screenshot seguente illustra il linter in Visual Studio Code:

Nel riquadro PROBLEMI sono presenti quattro errori, un avviso e un messaggio informativo visualizzato nello screenshot. Il messaggio informativo mostra il file di configurazione Bicep usato. Mostra solo queste informazioni quando si imposta verbose su true nel file di configurazione.

Passare il cursore del mouse su una delle aree problematiche. Linter fornisce i dettagli relativi all'errore o all'avviso. Selezionare l'area, che mostra anche una lampadina blu:

Selezionare la lampadina o il collegamento Correzione rapida per visualizzare la soluzione:

Selezionare la soluzione per risolvere automaticamente il problema.

Usare nell'interfaccia della riga di comando di Bicep

Lo screenshot seguente mostra il linter nella riga di comando. L'output del comando lint e del comando di compilazione mostra eventuali violazioni delle regole.

È possibile integrare questi controlli come parte delle pipeline CI/CD. È possibile usare un'azione GitHub per tentare una compilazione bicep. Gli errori avranno esito negativo nelle pipeline.

Ridurre al minimo i falsi positivi.

A volte una regola può avere falsi positivi. Ad esempio, potrebbe essere necessario includere un collegamento a un archivio BLOB direttamente senza usare la funzione environment() . In questo caso è possibile disabilitare l'avviso solo per una riga, non per l'intero documento, aggiungendo #disable-next-line <rule name> prima della riga con l'avviso.

#disable-next-line no-hardcoded-env-urls //Direct download link to my toolset
scriptDownloadUrl: 'https://mytools.blob.core.windows.net/...'

È consigliabile aggiungere un commento che spiega perché la regola non si applica a questa riga.

Se si vuole eliminare una regola linter, è possibile modificare il livello della regola impostando Off in bicepconfig.json. Nel caso seguente, ad esempio, la regola no-deployments-reesources viene eliminata:

{
  "analyzers": {
    "core": {
      "rules": {
        "no-deployments-resources": {
          "level": "off"
        }
      }
    }
  }
}

Passaggi successivi

• Per altre informazioni sulla personalizzazione delle regole linter, vedere Aggiungere impostazioni personalizzate nel file di configurazione Bicep.
• Per altre informazioni sull'uso di Visual Studio Code e dell'estensione Bicep, vedere Avvio rapido: Creare file Bicep con Visual Studio Code.