Megosztás a következőn keresztül:

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 Bicep CLI 0.4-es vagy újabb verziójá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.

Linter szabály Alapértelmezett szint
adminusername-should-not-be-literális figyelmeztetés
artifacts-parameters figyelmeztetés
decompiler-cleanup figyelmeztetés
explicit értékek lokális paraméterekhez kikapcsolva
max-asserts hiba
maximális kimenetek hiba
max-params hiba
maximális erőforrások hiba
maximális változók hiba
beágyazott-telepítési-sablon-keretezés hiba
nem ütköző metaadatok figyelmeztetés
no-deployments-resources figyelmeztetés
no-hardcoded-env-urls figyelmeztetés
nincs beágyazott elérési út kikapcsolva
no-loc-expr-outside-params kikapcsolva
nincs-szükségtelen-függőségek figyelmeztetés
nem használt meglévő erőforrások figyelmeztetés
nem használt importok figyelmeztetés
nem használt paraméterek figyelmeztetés
no-unused-vars (nincs használatlan változó) figyelmeztetés
a kimenetek nem tartalmazhatnak titkokat figyelmeztetés
prefer-interpoláció figyelmeztetés
előnyben részesíti az idézőjelek nélküli tulajdonságneveket figyelmeztetés
védje-a-végrehajtandó-parancs-titkait figyelmeztetés
secure-parameter-default figyelmeztetés
secure-params-in-nested-deploy figyelmeztetés
secure-secrets-in-params figyelmeztetés
egyszerűsíti az interpolációt figyelmeztetés
egyszerűsítés-json-null figyelmeztetés
use-parent-property figyelmeztetés
használja-az-újabb-api-verziókat kikapcsolva
használd-a-legújabb-modul-verziókat kikapcsolva
use-resource-id-functions kikapcsolva
erőforrás-szimbólum-referencia használata figyelmeztetés
biztonságos hozzáférés használata figyelmeztetés
használjon-biztonságos-értéket-a-biztonságos-bemenetekhez figyelmeztetés
használjon stabil forrás-azonosítókat figyelmeztetés
use-stable-vm-image figyelmeztetés
mi-van-ha-rövidzáras-logika kikapcsolva

Engedélyezheti vagy letilthatja az összes linter-szabályt, és szabályozhatja az alkalmazásuk módját egy konfigurációs fájl használatával. Az alapértelmezett viselkedés felülbírálásához hozzon létre egy bicepconfig.json fájlt az egyéni beállításaival. 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ó:

Bicep linter használata a Visual Studio Code-ban.

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:

Bicep linter használata a Visual Studio Code-ban – gyorsjavítás megjelenítése.

Válassza a villanykörte vagy a gyorsjavítás hivatkozását a megoldás megtekintéséhez:

Bicep linter használata a Visual Studio Code-ban – gyorsjavítási megoldás megjelenítése.

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.

Bicep linter-használat a parancssorban.

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 Offszintjé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