Share via

Dodawanie ustawień linter w pliku konfiguracji Bicep

  • Artykuł

W pliku bicepconfig.json można dostosować ustawienia walidacji dla linteru Bicep. Linter używa tych ustawień podczas oceniania plików Bicep w celu uzyskania najlepszych rozwiązań.

W tym artykule opisano ustawienia dostępne do pracy z linterem Bicep.

Dostosowywanie lintera

Ustawienia linter są dostępne w obszarze analyzers elementu . Możesz włączyć lub wyłączyć linter, podać wartości specyficzne dla reguły i ustawić poziom reguł.

W poniższym przykładzie przedstawiono reguły dostępne dla konfiguracji.

{
  "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": "warning"
        },
        "max-outputs": {
          "level": "warning"
        },
        "max-params": {
          "level": "warning"
        },
        "max-resources": {
          "level": "warning"
        },
        "max-variables": {
          "level": "warning"
        },
        "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-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": "warning",
          "maxAllowedAgeInDays": 730
        },
        "use-resource-id-functions": {
          "level": "warning"
        },
        "use-resource-symbol-reference": {
          "level": "warning"
        },
        "use-secure-value-for-secure-inputs": {
          "level": "error"
        },
        "use-stable-resource-identifiers": {
          "level": "warning"
        },
        "use-stable-vm-image": {
          "level": "warning"
        }
      }
    }
  }
}

Właściwości są następujące:

  • włączone: określ wartość true dla włączania linter, false do wyłączania linter.
  • verbose: określ wartość true, aby wyświetlić plik bicepconfig.json używany przez Visual Studio Code.
  • reguły: określ wartości specyficzne dla reguły. Każda reguła ma poziom określający, jak linter reaguje po znalezieniu naruszenia.

Dostępne wartości dla poziomu to:

poziom Zachowanie w czasie kompilacji Zachowanie edytora
Error Naruszenia są wyświetlane jako błędy w danych wyjściowych kompilacji wiersza polecenia i powoduje niepowodzenie kompilacji. Obraźliwy kod jest podkreślony czerwonym wywijakiem i pojawia się na karcie Problemy.
Warning Naruszenia są wyświetlane jako ostrzeżenia w danych wyjściowych kompilacji wiersza polecenia, ale nie powodują niepowodzenia kompilacji. Obraźliwy kod jest podkreślony żółtym wywijakiem i pojawia się na karcie Problemy.
Info Naruszenia nie są wyświetlane w danych wyjściowych kompilacji wiersza polecenia. Obraźliwy kod jest podkreślony niebieskim wywijakiem i pojawia się na karcie Problemy.
Off Całkowicie pominięto. Całkowicie pominięto.

Adresy URL środowiska

W przypadku reguły dotyczącej zakodowanych na stałe adresów URL środowiska można dostosować, które adresy URL są sprawdzane. Domyślnie są stosowane następujące ustawienia:

{
  "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"
          ]
        }
      }
    }
  }
}

Następne kroki