Dela via

Lägg till linterinställningar i Bicep-konfigurationsfilen

I en bicepconfig.json fil kan du anpassa valideringsinställningarna för Bicep-lintern. Linter använder de här inställningarna när du utvärderar dina Bicep-filer för bästa praxis.

I den här artikeln beskrivs de inställningar som är tillgängliga för att arbeta med Bicep-lintern.

Anpassa linter

Linter-inställningarna är tillgängliga under elementet analyzers . Du kan aktivera eller inaktivera linter, ange regelspecifika värden och ange regelnivå.

I följande exempel visas de regler som är tillgängliga för konfiguration.

{
  "analyzers": {
    "core": {
      "enabled": true,
      "rules": {
        "adminusername-should-not-be-literal": {
          "level": "warning"
        },
        "artifacts-parameters": {
          "level": "warning"
        },
        "decompiler-cleanup": {
          "level": "warning"
        },
        "explicit-values-for-loc-params": {
          "level": "off"
        },
        "max-asserts": {
          "level": "error"
        },
        "max-outputs": {
          "level": "error"
        },
        "max-params": {
          "level": "error"
        },
        "max-resources": {
          "level": "error"
        },
        "max-variables": {
          "level": "error"
        },
        "nested-deployment-template-scoping": {
          "level": "error"
        },
        "no-conflicting-metadata" : {
          "level": "warning"
        },
        "no-deployments-resources" : {
          "level": "warning"
        },
        "no-hardcoded-env-urls": {
          "level": "warning"
        },
        "no-hardcoded-location": {
          "level": "off"
        },
        "no-loc-expr-outside-params": {
          "level": "off"
        },
        "no-unnecessary-dependson": {
          "level": "warning"
        },
        "no-unused-existing-resources": {
          "level": "warning"
        },
        "no-unused-imports": {
          "level": "warning"
        },
        "no-unused-params": {
          "level": "warning"
        },
        "no-unused-vars": {
          "level": "warning"
        },
        "outputs-should-not-contain-secrets": {
          "level": "warning"
        },
        "prefer-interpolation": {
          "level": "warning"
        },
        "prefer-unquoted-property-names": {
          "level": "warning"
        },
        "protect-commandtoexecute-secrets": {
          "level": "warning"
        },
        "secure-parameter-default": {
          "level": "warning"
        },
        "secure-params-in-nested-deploy": {
          "level": "warning"
        },
        "secure-secrets-in-params": {
          "level": "warning"
        },
        "simplify-interpolation": {
          "level": "warning"
        },
        "simplify-json-null": {
          "level": "warning"
        },
        "use-parent-property": {
          "level": "warning"
        },
        "use-recent-api-versions": {
          "level": "off",
          "maxAllowedAgeInDays": 730
        },
        "use-recent-module-versions": {
          "level": "off"
        },
        "use-resource-id-functions": {
          "level": "off"
        },
        "use-resource-symbol-reference": {
          "level": "warning"
        },
        "use-safe-access": {
          "level": "warning"
        },
        "use-secure-value-for-secure-inputs": {
          "level": "error"
        },
        "use-stable-resource-identifiers": {
          "level": "warning"
        },
        "use-stable-vm-image": {
          "level": "warning"
        },
        "what-if-short-circuiting": {
          "level": "off"
        }
      }
    }
  }
}

Egenskaperna är:

  • aktiverad: ange true för aktivering av linter, false för inaktivering av linter.
  • verbose: ange true för att visa den bicepconfig.json fil som används av Visual Studio Code.
  • regler: ange regelspecifika värden. Varje regel har en nivå som avgör hur lintern svarar när en överträdelse hittas.

De tillgängliga värdena för nivån är:

nivå Byggtidsbeteende Redigeringsbeteende
Error Överträdelser visas som Fel i kommandoradsversionens utdata och gör att bygget misslyckas. Felande kod understryks med en röd squiggle och visas på fliken Problem.
Warning Överträdelser visas som Varningar i kommandoradsversionens utdata, men de gör inte att bygget misslyckas. Felande kod understryks med en gul squiggle och visas på fliken Problem.
Info Överträdelser visas inte i kommandoradsversionens utdata. Felande kod understryks med en blå squiggle och visas på fliken Problem.
Off Fullständigt undertryckt. Fullständigt undertryckt.

Miljö-URL:er

För regeln om hårdkodade miljö-URL:er kan du anpassa vilka URL:er som är markerade. Som standard tillämpas följande inställningar:

{
  "analyzers": {
    "core": {
      "enabled": true,
      "rules": {
        "no-hardcoded-env-urls": {
          "level": "warning",
          "disallowedhosts": [
            "api.loganalytics.io",
            "api.loganalytics.iov1",
            "asazure.windows.net",
            "azuredatalakeanalytics.net",
            "azuredatalakestore.net",
            "batch.core.windows.net",
            "core.windows.net",
            "database.windows.net",
            "datalake.azure.net",
            "gallery.azure.com",
            "graph.windows.net",
            "login.microsoftonline.com",
            "management.azure.com",
            "management.core.windows.net",
            "region.asazure.windows.net",
            "trafficmanager.net",
            "vault.azure.net"
          ],
          "excludedhosts": [
            "schema.management.azure.com"
          ]
        }
      }
    }
  }
}

Nästa steg