Bicep linter gebruiken

De Bicep linter controleert Bicep-bestanden op syntaxisfouten en schendingen van best practice. De linter helpt coderingsstandaarden af te dwingen door richtlijnen te bieden tijdens de ontwikkeling. U kunt de aanbevolen procedures aanpassen voor het controleren van het bestand.

Linter-vereisten

De linter is geïntegreerd in de Bicep CLI en de Bicep-extensie voor Visual Studio Code. Als u deze wilt gebruiken, moet u versie 0.4 of hoger hebben.

Standaardregels

De standaardset linterregels is minimaal en is afkomstig uit arm-ttk-testcases. De extensie en Bicep CLI controleren de volgende regels, die zijn ingesteld op het waarschuwingsniveau.

• adminusername-should-not-be-literal
• artefacten-parameters
• opschonen van decompiler
• explicit-values-for-loc-params
• max-asserts
• max-outputs
• max-params
• max-resources
• max-variables
• bereik genest-deployment-template
• geen conflicterende metagegevens
• no-deployments-resources
• no-hardcoded-env-urls
• no-hardcoded-location
• no-loc-expr-outside-params
• no-onnodig-dependson
• geen ongebruikte bestaande resources
• no-unused-params
• no-unused-vars
• outputs-should-not-contain-secrets
• voorkeursinterpolatie
• prefer-unquoted-property-names
• secure-parameter-default
• secure-params-in-nested-deploy
• secure-secrets-in-params
• interpolatie vereenvoudigen
• simplify-json-null
• use-parent-property
• use-protectedsettings-for-commandtoexecute-secrets
• use-recent-api-versions
• use-resource-id-functions
• use-resource-symbol-reference
• use-secure-value-for-secure-inputs
• use-stable-resource-identifiers
• use-stable-vm-image

U kunt aanpassen hoe de linterregels worden toegepast. Als u de standaardinstellingen wilt overschrijven, voegt u een bicepconfig.json-bestand toe en past u aangepaste instellingen toe. Zie Aangepaste instellingen toevoegen in het Bicep-configuratiebestand voor meer informatie over het toepassen van deze instellingen.

Gebruiken in Visual Studio Code

In de volgende schermopname ziet u de linter in Visual Studio Code:

In het deelvenster PROBLEMEN zijn er vier fouten, één waarschuwing en één informatiebericht in de schermopname. Het informatiebericht toont het Bicep-configuratiebestand dat wordt gebruikt. Deze informatie wordt alleen weergegeven wanneer u uitgebreid instelt op waar in het configuratiebestand.

Plaats de muisaanwijzer op een van de probleemgebieden. Linter geeft de details over de fout of waarschuwing. Selecteer het gebied, het toont ook een blauwe gloeilamp:

Selecteer de gloeilamp of de koppeling Snelle oplossing om de oplossing te bekijken:

Selecteer de oplossing om het probleem automatisch op te lossen.

Gebruiken in Bicep CLI

In de volgende schermopname ziet u de linter op de opdrachtregel. In de uitvoer van de lintopdracht en de buildopdracht worden eventuele schendingen van regels weergegeven.

U kunt deze controles integreren als onderdeel van uw CI/CD-pijplijnen. U kunt een GitHub-actie gebruiken om een bicep-build uit te voeren. Fouten mislukken in de pijplijnen.

Fout-positieven silencing

Soms kan een regel fout-positieven hebben. U moet bijvoorbeeld rechtstreeks een koppeling naar een blobopslag opnemen zonder de functie environment() te gebruiken. In dit geval kunt u de waarschuwing voor slechts één regel uitschakelen, niet het hele document, door vóór de regel met de waarschuwing toe te voegen #disable-next-line <rule name> .

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

Het is raadzaam een opmerking toe te voegen waarin wordt uitgelegd waarom de regel niet van toepassing is op deze regel.

Als u een linterregel wilt onderdrukken, kunt u het niveau van de regel Off wijzigen in bicepconfig.json. In het volgende voorbeeld wordt de no-deployments-reesources regel bijvoorbeeld onderdrukt:

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

Volgende stappen

• Zie Aangepaste instellingen toevoegen in het Bicep-configuratiebestand voor meer informatie over het aanpassen van de linterregels.
• Zie quickstart: Bicep-bestanden maken met Visual Studio Code voor meer informatie over het gebruik van Visual Studio Code en de Bicep-extensie.