A Bicep linter használata
A Bicep-linter szintaxishibákat és ajánlott eljárásokat keres a Bicep-fájlokban. A linter segít a kódolási szabványok betartatásában azáltal, hogy útmutatást nyújt a fejlesztés során. Testre szabhatja a fájl ellenőrzéséhez használandó ajánlott eljárásokat.
Linter-követelmények
A linter integrálva van a Bicep CLI-be és a Visual Studio Code Bicep-bővítményébe. A használatához a 0.4-es vagy újabb verzióval kell rendelkeznie.
Alapértelmezett szabályok
Az alapértelmezett linter szabályok minimálisak, és arm-ttk tesztesetekből származnak. A bővítmény és a Bicep CLI a következő szabályokat ellenőrzi, amelyek a figyelmeztetési szintre vannak beállítva.
- adminusername-should-not-be-literál
- artifacts-parameters
- decompiler-cleanup
- explicit-values-for-loc-params
- max-asserts
- maximális kimenetek
- max-params
- maximális erőforrások
- maximális változók
- beágyazott-deployment-template-scoping
- nem ütköző metaadatok
- no-deployments-resources
- no-hardcoded-env-urls
- nincs merevlemez-hely
- no-loc-expr-outside-params
- nincs-szükségtelen-dependson
- nem használt-meglévő erőforrások
- nem használt paramok
- no-unused-vars
- outputs-should-not-contain-secrets
- prefer-interpoláció
- prefer-unquoted-property-names
- protect-commandtoexecute-secrets
- secure-parameter-default
- secure-params-in-nested-deploy
- secure-secrets-in-params
- egyszerűsíti az interpolációt
- egyszerűsítés-json-null
- use-parent-property
- use-recent-api-versions
- use-recent-module-versions
- use-resource-id-functions
- use-resource-symbol-reference
- biztonságos hozzáférés használata
- use-secure-value-for-secure-inputs
- use-stable-resource-identifiers
- use-stable-vm-image
- what-if-short-circuiting
Testre szabhatja a linterszabályok alkalmazását. Az alapértelmezett beállítások felülírásához adjon hozzá egy bicepconfig.json fájlt, és alkalmazza az egyéni beállításokat. A beállítások alkalmazásával kapcsolatos további információkért lásd : Egyéni beállítások hozzáadása a Bicep konfigurációs fájlban.
Használat a Visual Studio Code-ban
Az alábbi képernyőképen a Visual Studio Code linterje látható:
A PROBLÉMÁK panelen négy hiba, egy figyelmeztetés és egy információs üzenet jelenik meg a képernyőképen. Az információs üzenet a használt Bicep-konfigurációs fájlt jeleníti meg. Csak akkor jelenik meg ez az információ, ha a konfigurációs fájlban igaz értékre állítja be a részletes adatokat.
Vigye az egérmutatót az egyik problémás területre. Linter megadja a hiba vagy figyelmeztetés részleteit. Válassza ki a területet, és kék izzót is mutat:
Válassza a villanykörte vagy a gyorsjavítás hivatkozását a megoldás megtekintéséhez:
Válassza ki a megoldást a probléma automatikus megoldásához.
Használat a Bicep CLI-ben
Az alábbi képernyőképen a parancssori linter látható. A lint parancs és a build parancs kimenete minden szabálysértést mutat.
Ezeket az ellenőrzéseket a CI/CD-folyamatok részeként integrálhatja. Egy GitHub-művelettel megkísérelhet bicep-buildet. A hibák sikertelenek lesznek a folyamatokban.
Hamis pozitív értékek elhallgattatása
Előfordulhat, hogy egy szabály hamis pozitív eredményt ad. Előfordulhat például, hogy közvetlenül a környezet() függvény használata nélkül is fel kell vennie egy blobtárolóra mutató hivatkozást.
Ebben az esetben a figyelmeztetést csak egy sorra tilthatja le, nem pedig a teljes dokumentumra, ha a figyelmeztetést tartalmazó sor elé ad hozzá #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/...'
Érdemes megjegyzést fűzni, amely elmagyarázza, hogy a szabály miért nem vonatkozik erre a sorra.
Ha el szeretné tiltani a linterszabályt, módosíthatja a szabály Off
szintjét a bicepconfig.json. Az alábbi példában például a no-deployments-resources
szabály el van tiltva:
{
"analyzers": {
"core": {
"rules": {
"no-deployments-resources": {
"level": "off"
}
}
}
}
}
Következő lépések
- A linterszabályok testreszabásával kapcsolatos további információkért lásd : Egyéni beállítások hozzáadása a Bicep konfigurációs fájlban.
- A Visual Studio Code és a Bicep bővítmény használatával kapcsolatos további információkért tekintse meg a Rövid útmutatót: Bicep-fájlok létrehozása a Visual Studio Code-tal.