Använda Bicep-linter

Bicep-lintern kontrollerar Bicep-filer efter syntaxfel och överträdelser av bästa praxis. Linter hjälper till att framtvinga kodningsstandarder genom att ge vägledning under utvecklingen. Du kan anpassa metodtipsen för att kontrollera filen.

Linterkrav

Lintern är integrerad i Bicep CLI och Bicep-tillägget för Visual Studio Code. Om du vill använda den måste du ha version 0.4 eller senare.

Standardregler

Standarduppsättningen med linterregler är minimal och tas från arm-ttk-testfall. Tillägget och Bicep CLI kontrollerar följande regler, som är inställda på varningsnivån.

• 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
• förenkla interpolering
• simplify-json-null
• use-parent-property
• use-protectedsettings-for-commandtoexecute-secrets
• use-recent-api-versions
• use-recent-module-versions
• use-resource-id-functions
• use-resource-symbol-reference
• use-safe-access
• use-secure-value-for-secure-inputs
• use-stable-resource-identifiers
• use-stable-vm-image
• what-if-short-circuiting

Du kan anpassa hur linterreglerna tillämpas. Om du vill skriva över standardinställningarna lägger du till en bicepconfig.json fil och tillämpar anpassade inställningar. Mer information om hur du tillämpar dessa inställningar finns i Lägga till anpassade inställningar i Bicep-konfigurationsfilen.

Använda i Visual Studio Code

Följande skärmbild visar lintern i Visual Studio Code:

I fönstret PROBLEM visas fyra fel, en varning och ett informationsmeddelande på skärmbilden. Informationsmeddelandet visar Bicep-konfigurationsfilen som används. Den visar bara den här informationen när du anger utförligt till sant i konfigurationsfilen.

Hovra musmarkören till ett av problemområdena. Linter ger information om felet eller varningen. Välj området, det visar också en blå glödlampa:

Välj antingen glödlampan eller snabbkorrigeringslänken för att se lösningen:

Välj lösningen för att åtgärda problemet automatiskt.

Använda i Bicep CLI

Följande skärmbild visar lintern på kommandoraden. Utdata från lint-kommandot och build-kommandot visar eventuella regelöverträdelser.

Du kan integrera dessa kontroller som en del av dina CI/CD-pipelines. Du kan använda en GitHub-åtgärd för att försöka skapa en bicep. Fel kommer att misslyckas pipelines.

Tysta falska positiva identifieringar

Ibland kan en regel ha falska positiva identifieringar. Du kan till exempel behöva inkludera en länk till en bloblagring direkt utan att använda funktionen environment(). I det här fallet kan du inaktivera varningen endast för en rad, inte hela dokumentet, genom att lägga till #disable-next-line <rule name> före raden med varningen.

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

Det är bra att lägga till en kommentar som förklarar varför regeln inte gäller för den här raden.

Om du vill ignorera en linterregel kan du ändra nivån för regeln till Off i bicepconfig.json. I följande exempel no-deployments-reesources ignoreras till exempel regeln:

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

Nästa steg

• Mer information om hur du anpassar linterreglerna finns i Lägga till anpassade inställningar i Bicep-konfigurationsfilen.
• Mer information om hur du använder Visual Studio Code och Bicep-tillägget finns i Snabbstart: Skapa Bicep-filer med Visual Studio Code.