Merge pull request #301594 from mumian/0619-linter-format

Document the default values for linter rules

Author: v-ccolin

articles/azure-resource-manager/bicep/bicep-config-linter.md

@@ -3,7 +3,7 @@ title: Linter settings for Bicep config
 description: Describes how to customize configuration values for the Bicep linter
 ms.topic: conceptual
 ms.custom: devx-track-bicep
-ms.date: 04/28/2025
+ms.date: 06/19/2025
 ---
 
 # Add linter settings in the Bicep config file
@@ -37,19 +37,19 @@ The following example shows the rules that are available for configuration.
           "level": "off"
         },
         "max-asserts": {
-          "level": "warning"
+          "level": "error"
         },
         "max-outputs": {
-          "level": "warning"
+          "level": "error"
         },
         "max-params": {
-          "level": "warning"
+          "level": "error"
         },
         "max-resources": {
-          "level": "warning"
+          "level": "error"
         },
         "max-variables": {
-          "level": "warning"
+          "level": "error"
         },
         "nested-deployment-template-scoping": {
           "level": "error"
@@ -115,11 +115,11 @@ The following example shows the rules that are available for configuration.
           "level": "warning"
         },
         "use-recent-api-versions": {
-          "level": "warning",
+          "level": "off",
           "maxAllowedAgeInDays": 730
         },
         "use-recent-module-versions": {
-          "level": "warning"
+          "level": "off"
         },
         "use-resource-id-functions": {
           "level": "off"
@@ -140,7 +140,7 @@ The following example shows the rules that are available for configuration.
           "level": "warning"
         },
         "what-if-short-circuiting": {
-          "level": "warning"
+          "level": "off"
         }
       }
     }

articles/azure-resource-manager/bicep/linter-rule-admin-username-should-not-be-literal.md

@@ -23,6 +23,8 @@ Don't use a literal value or an expression that evaluates to a literal value. In
 The following example fails this test because the user name is a literal value.
 
 ```bicep
+param location string = resourceGroup().location
+
 resource vm 'Microsoft.Compute/virtualMachines@2023-03-01' = {
   name: 'name'
   location: location
@@ -37,6 +39,8 @@ resource vm 'Microsoft.Compute/virtualMachines@2023-03-01' = {
 The next example fails this test because the expression evaluates to a literal value when the default value is used.
 
 ```bicep
+param location string = resourceGroup().location
+
 var defaultAdmin = 'administrator'
 resource vm 'Microsoft.Compute/virtualMachines@2023-03-01' = {
   name: 'name'
@@ -54,7 +58,8 @@ This example passes this test.
 ```bicep
 @secure()
 param adminUsername string
-param location string
+param location string = resourceGroup().location
+
 resource vm 'Microsoft.Compute/virtualMachines@2023-03-01' = {
   name: 'name'
   location: location

articles/azure-resource-manager/bicep/linter-rule-explicit-values-for-loc-params.md

@@ -3,13 +3,16 @@ title: Linter rule - use explicit values for module location parameters
 description: Linter rule - use explicit values for module location parameters.
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 02/12/2025
+ms.date: 06/19/2025
 ---
 
 # Linter rule - use explicit values for module location parameters
 
 This rule finds module parameters that are used for resource locations and may inadvertently default to an unexpected value.
 
+> [!NOTE]
+> This rule is off by default. Change the level in [bicepconfig.json](./bicep-config-linter.md) to enable it.
+
 ## Linter rule code
 
 Use the following value in the [Bicep configuration file](bicep-config-linter.md) to customize rule settings:

articles/azure-resource-manager/bicep/linter-rule-no-hardcoded-location.md

@@ -3,13 +3,16 @@ title: Linter rule - no hardcoded locations
 description: Linter rule - no hardcoded locations
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 02/12/2025
+ms.date: 06/19/2025
 ---
 
 # Linter rule - no hardcoded locations
 
 This rule finds uses of Azure location values that aren't parameterized.
 
+> [!NOTE]
+> This rule is off by default. Change the level in [bicepconfig.json](./bicep-config-linter.md) to enable it.
+
 ## Linter rule code
 
 Use the following value in the [Bicep configuration file](bicep-config-linter.md) to customize rule settings:
@@ -25,18 +28,29 @@ Rather than using a hardcoded string or variable value, use a parameter, the str
 The following example fails this test because the resource's `location` property uses a string literal:
 
 ```bicep
-  resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
-      location: 'westus'
+resource stg 'Microsoft.Storage/storageAccounts@2024-01-01' = {
+  name: 'stg'
+  location: 'westus'
+  kind: 'StorageV2'
+  sku: {
+    name: 'Premium_LRS'
   }
+}
 ```
 
 You can fix it by creating a new `location` string parameter (which may optionally have a default value - resourceGroup().location is frequently used as a default):
 
 ```bicep
-  param location string = resourceGroup().location
-  resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
-      location: location
+param location string = resourceGroup().location
+
+resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
+  name: 'stg${uniqueString(resourceGroup().id)}'
+  location: location
+  kind: 'StorageV2'
+  sku: {
+    name: 'Premium_LRS'
   }
+}
 ```
 
 Use **Quick Fix** to create a location parameter and replace the string literal with the parameter name. See the following screenshot:
@@ -46,19 +60,19 @@ Use **Quick Fix** to create a location parameter and replace the string literal
 The following example fails this test because the resource's `location` property uses a variable with a string literal.
 
 ```bicep
-  var location = 'westus'
-  resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
-      location: location
-  }
+var location = 'westus'
+resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
+  location: location
+}
 ```
 
 You can fix it by turning the variable into a parameter:
 
 ```bicep
-  param location string = 'westus'
-  resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
-      location: location
-  }
+param location string = 'westus'
+resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
+    location: location
+}
 ```
 
 The following example fails this test because a string literal is being passed in to a module parameter that is in turn used for a resource's `location` property:

articles/azure-resource-manager/bicep/linter-rule-no-loc-expr-outside-params.md

@@ -3,13 +3,16 @@ title: Linter rule - no location expressions outside of parameter default values
 description: Linter rule - no location expressions outside of parameter default values
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 02/12/2025
+ms.date: 06/19/2025
 ---
 
 # Linter rule - no location expressions outside of parameter default values
 
 This rule finds `resourceGroup().location` or `deployment().location` used outside of a parameter default value.
 
+> [!NOTE]
+> This rule is off by default. Change the level in [bicepconfig.json](./bicep-config-linter.md) to enable it.
+
 ## Linter rule code
 
 Use the following value in the [Bicep configuration file](bicep-config-linter.md) to customize rule settings:

articles/azure-resource-manager/bicep/linter-rule-what-if-short-circuiting.md

@@ -3,7 +3,7 @@ title: Linter rule - what-if short circuiting
 description: Linter rule - what-if short circuiting
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 02/12/2025
+ms.date: 06/19/2025
 ---
 
 # Linter rule - what-if short circuiting

articles/azure-resource-manager/bicep/linter.md

@@ -3,7 +3,7 @@ title: Use Bicep linter
 description: Learn how to use Bicep linter.
 ms.topic: how-to
 ms.custom: devx-track-bicep
-ms.date: 06/06/2025
+ms.date: 06/19/2025
 ---
 
 # Use Bicep linter
@@ -12,51 +12,53 @@ The Bicep linter checks Bicep files for syntax errors and best practice violatio
 
 ## Linter requirements
 
-The linter is integrated into the Bicep CLI and the Bicep extension for Visual Studio Code. To use it, you must have version **0.4 or later**.
+The linter is integrated into the Bicep CLI and the Bicep extension for Visual Studio Code. To use it, you must have [Bicep CLI version 0.4 or later](https://github.com/Azure/bicep/releases/tag/v0.4.1).
 
 ## Default rules
 
 The default set of linter rules is minimal and taken from [arm-ttk test cases](../templates/template-test-cases.md). The extension and Bicep CLI check the following rules, which are set to the warning level.
 
-- [adminusername-should-not-be-literal](./linter-rule-admin-username-should-not-be-literal.md)
-- [artifacts-parameters](./linter-rule-artifacts-parameters.md)
-- [decompiler-cleanup](./linter-rule-decompiler-cleanup.md)
-- [explicit-values-for-loc-params](./linter-rule-explicit-values-for-loc-params.md)
-- [max-asserts](./linter-rule-max-asserts.md)
-- [max-outputs](./linter-rule-max-outputs.md)
-- [max-params](./linter-rule-max-parameters.md)
-- [max-resources](./linter-rule-max-resources.md)
-- [max-variables](./linter-rule-max-variables.md)
-- [nested-deployment-template-scoping](./linter-rule-nested-deployment-template-scoping.md)
-- [no-conflicting-metadata](./linter-rule-no-conflicting-metadata.md)
-- [no-deployments-resources](./linter-rule-no-deployments-resources.md)
-- [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
-- [no-hardcoded-location](./linter-rule-no-hardcoded-location.md)
-- [no-loc-expr-outside-params](./linter-rule-no-loc-expr-outside-params.md)
-- [no-unnecessary-dependson](./linter-rule-no-unnecessary-dependson.md)
-- [no-unused-existing-resources](./linter-rule-no-unused-existing-resources.md)
-- [no-unused-imports](./linter-rule-no-unused-imports.md)
-- [no-unused-params](./linter-rule-no-unused-parameters.md)
-- [no-unused-vars](./linter-rule-no-unused-variables.md)
-- [outputs-should-not-contain-secrets](./linter-rule-outputs-should-not-contain-secrets.md)
-- [prefer-interpolation](./linter-rule-prefer-interpolation.md)
-- [prefer-unquoted-property-names](./linter-rule-prefer-unquoted-property-names.md)
-- [protect-commandtoexecute-secrets](./linter-rule-use-protectedsettings-for-commandtoexecute-secrets.md)
-- [secure-parameter-default](./linter-rule-secure-parameter-default.md)
-- [secure-params-in-nested-deploy](./linter-rule-secure-params-in-nested-deploy.md)
-- [secure-secrets-in-params](./linter-rule-secure-secrets-in-parameters.md)
-- [simplify-interpolation](./linter-rule-simplify-interpolation.md)
-- [simplify-json-null](./linter-rule-simplify-json-null.md)
-- [use-parent-property](./linter-rule-use-parent-property.md)
-- [use-recent-api-versions](./linter-rule-use-recent-api-versions.md)
-- [use-recent-module-versions](./linter-rule-use-recent-module-versions.md)
-- [use-resource-id-functions](./linter-rule-use-resource-id-functions.md)
-- [use-resource-symbol-reference](./linter-rule-use-resource-symbol-reference.md)
-- [use-safe-access](./linter-rule-use-safe-access.md)
-- [use-secure-value-for-secure-inputs](./linter-rule-use-secure-value-for-secure-inputs.md)
-- [use-stable-resource-identifiers](./linter-rule-use-stable-resource-identifier.md)
-- [use-stable-vm-image](./linter-rule-use-stable-vm-image.md)
-- [what-if-short-circuiting](./linter-rule-what-if-short-circuiting.md)
+| Linter rule | Default level |
+| --- | --- |
+| <a id='adminusername-should-not-be-literal' />[adminusername-should-not-be-literal](./linter-rule-admin-username-should-not-be-literal.md) | warning |
+| <a id='artifacts-parameters' />[artifacts-parameters](./linter-rule-artifacts-parameters.md) | warning |
+| <a id='decompiler-cleanup' />[decompiler-cleanup](./linter-rule-decompiler-cleanup.md) | warning |
+| <a id='explicit-values-for-loc-params' />[explicit-values-for-loc-params](./linter-rule-explicit-values-for-loc-params.md) | off |
+| <a id='max-asserts' />[max-asserts](./linter-rule-max-asserts.md) | error |
+| <a id='max-outputs' />[max-outputs](./linter-rule-max-outputs.md) | error |
+| <a id='max-params' />[max-params](./linter-rule-max-parameters.md) | error |
+| <a id='max-resources' />[max-resources](./linter-rule-max-resources.md) | error |
+| <a id='max-variables' />[max-variables](./linter-rule-max-variables.md) | error |
+| <a id='nested-deployment-template-scoping' />[nested-deployment-template-scoping](./linter-rule-nested-deployment-template-scoping.md) | error |
+| <a id='no-conflicting-metadata' />[no-conflicting-metadata](./linter-rule-no-conflicting-metadata.md) | warning |
+| <a id='no-deployments-resources' />[no-deployments-resources](./linter-rule-no-deployments-resources.md) | warning |
+| <a id='no-hardcoded-env-urls' />[no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md) | warning |
+| <a id='no-hardcoded-location' />[no-hardcoded-location](./linter-rule-no-hardcoded-location.md) | off |
+| <a id='no-loc-expr-outside-params' />[no-loc-expr-outside-params](./linter-rule-no-loc-expr-outside-params.md) | off |
+| <a id='no-unnecessary-dependson' />[no-unnecessary-dependson](./linter-rule-no-unnecessary-dependson.md) | warning |
+| <a id='no-unused-existing-resources' />[no-unused-existing-resources](./linter-rule-no-unused-existing-resources.md) | warning |
+| <a id='no-unused-imports' />[no-unused-imports](./linter-rule-no-unused-imports.md) | warning |
+| <a id='no-unused-params' />[no-unused-params](./linter-rule-no-unused-parameters.md) | warning |
+| <a id='no-unused-vars' />[no-unused-vars](./linter-rule-no-unused-variables.md) | warning |
+| <a id='outputs-should-not-contain-secrets' />[outputs-should-not-contain-secrets](./linter-rule-outputs-should-not-contain-secrets.md) | warning |
+| <a id='prefer-interpolation' />[prefer-interpolation](./linter-rule-prefer-interpolation.md) | warning |
+| <a id='prefer-unquoted-property-names' />[prefer-unquoted-property-names](./linter-rule-prefer-unquoted-property-names.md) | warning |
+| <a id='protect-commandtoexecute-secrets' />[protect-commandtoexecute-secrets](./linter-rule-use-protectedsettings-for-commandtoexecute-secrets.md) | warning |
+| <a id='secure-parameter-default' />[secure-parameter-default](./linter-rule-secure-parameter-default.md) | warning |
+| <a id='secure-params-in-nested-deploy' />[secure-params-in-nested-deploy](./linter-rule-secure-params-in-nested-deploy.md) | warning |
+| <a id='secure-secrets-in-params' />[secure-secrets-in-params](./linter-rule-secure-secrets-in-parameters.md) | warning |
+| <a id='simplify-interpolation' />[simplify-interpolation](./linter-rule-simplify-interpolation.md) | warning |
+| <a id='simplify-json-null' />[simplify-json-null](./linter-rule-simplify-json-null.md) | warning |
+| <a id='use-parent-property' />[use-parent-property](./linter-rule-use-parent-property.md) | warning |
+| <a id='use-recent-api-versions' />[use-recent-api-versions](./linter-rule-use-recent-api-versions.md) | off |
+| <a id='use-recent-module-versions' />[use-recent-module-versions](./linter-rule-use-recent-module-versions.md) | off |
+| <a id='use-resource-id-functions' />[use-resource-id-functions](./linter-rule-use-resource-id-functions.md) | off |
+| <a id='use-resource-symbol-reference' />[use-resource-symbol-reference](./linter-rule-use-resource-symbol-reference.md) | warning |
+| <a id='use-safe-access' />[use-safe-access](./linter-rule-use-safe-access.md) | warning |
+| <a id='use-secure-value-for-secure-inputs' />[use-secure-value-for-secure-inputs](./linter-rule-use-secure-value-for-secure-inputs.md) | warning |
+| <a id='use-stable-resource-identifiers' />[use-stable-resource-identifiers](./linter-rule-use-stable-resource-identifier.md) | warning |
+| <a id='use-stable-vm-image' />[use-stable-vm-image](./linter-rule-use-stable-vm-image.md) | warning |
+| <a id='what-if-short-circuiting' />[what-if-short-circuiting](./linter-rule-what-if-short-circuiting.md) | off |
 
 You can enable or disable all linter rules and control how they are applied using a configuration file. To override the default behavior, create a **bicepconfig.json** file with your custom settings. For more information about applying those settings, see [Add custom settings in the Bicep config file](bicep-config-linter.md).