Merge pull request #176068 from tfitzmac/1015adminname

add admin username linter rule

Author: laurabren

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

@@ -0,0 +1,68 @@
+---
+title: Linter rule - admin user name should not be literal
+description: Linter rule - admin user name should not be a literal
+ms.topic: conceptual
+ms.date: 10/15/2021
+---
+
+# Linter rule - admin user name should not be literal
+
+This rule finds when an admin user name is set to a literal value.
+
+## Returned code
+
+`adminusername-should-not-be-literal`
+
+## Solution
+
+Don't use a literal value or an expression that evaluates to a literal value. Instead, create a parameter for the user name and assign it to the admin user name.
+
+The following example fails this test because the user name is a literal value.
+
+```bicep
+resource vm 'Microsoft.Compute/virtualMachines@2020-12-01' = {
+  name: 'name'
+  location: location
+  properties: {
+    osProfile: {
+      adminUsername: 'adminUsername'
+    }
+  }
+}
+```
+
+The next example fails this test because the expression evaluates to a literal value when the default value is used.
+
+```bicep
+var defaultAdmin = 'administrator'
+resource vm 'Microsoft.Compute/virtualMachines@2020-12-01' = {
+  name: 'name'
+  location: location
+  properties: {
+    osProfile: {
+      adminUsername: defaultAdmin
+    }
+  }
+}
+```
+
+This example passes this test.
+
+```bicep
+@secure()
+param adminUsername string
+param location string
+resource vm 'Microsoft.Compute/virtualMachines@2020-12-01' = {
+  name: 'name'
+  location: location
+  properties: {
+    osProfile: {
+      adminUsername: adminUsername
+    }
+  }
+}
+```
+
+## Next steps
+
+For more information about the linter, see [Use Bicep linter](./linter.md).

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

@@ -99,12 +99,4 @@ You can customize it by adding a bicepconfig.json file and applying new settings
 
 ## Next steps
 
-* For more information about the linter, see [Use Bicep linter](./linter.md).
-* The current linter rules are:
-
-  * [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
-  * [no-unused-params](./linter-rule-no-unused-parameters.md)
-  * [no-unused-vars](./linter-rule-no-unused-variables.md)
-  * [prefer-interpolation](./linter-rule-prefer-interpolation.md)
-  * [secure-parameter-default](./linter-rule-secure-parameter-default.md)
-  * [simplify-interpolation](./linter-rule-simplify-interpolation.md)
+For more information about the linter, see [Use Bicep linter](./linter.md).

articles/azure-resource-manager/bicep/linter-rule-no-unused-parameters.md

@@ -19,12 +19,4 @@ To reduce confusion in your template, delete any parameters that are defined but
 
 ## Next steps
 
-* For more information about the linter, see [Use Bicep linter](./linter.md).
-* The current linter rules are:
-
-  * [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
-  * [no-unused-params](./linter-rule-no-unused-parameters.md)
-  * [no-unused-vars](./linter-rule-no-unused-variables.md)
-  * [prefer-interpolation](./linter-rule-prefer-interpolation.md)
-  * [secure-parameter-default](./linter-rule-secure-parameter-default.md)
-  * [simplify-interpolation](./linter-rule-simplify-interpolation.md)
+For more information about the linter, see [Use Bicep linter](./linter.md).

articles/azure-resource-manager/bicep/linter-rule-no-unused-variables.md

@@ -19,12 +19,4 @@ To reduce confusion in your template, delete any variables that are defined but
 
 ## Next steps
 
-* For more information about the linter, see [Use Bicep linter](./linter.md).
-* The current linter rules are:
-
-  * [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
-  * [no-unused-params](./linter-rule-no-unused-parameters.md)
-  * [no-unused-vars](./linter-rule-no-unused-variables.md)
-  * [prefer-interpolation](./linter-rule-prefer-interpolation.md)
-  * [secure-parameter-default](./linter-rule-secure-parameter-default.md)
-  * [simplify-interpolation](./linter-rule-simplify-interpolation.md)
+For more information about the linter, see [Use Bicep linter](./linter.md).

articles/azure-resource-manager/bicep/linter-rule-prefer-interpolation.md

@@ -33,12 +33,4 @@ var vnetName = 'vnet-${suffix}'
 
 ## Next steps
 
-* For more information about the linter, see [Use Bicep linter](./linter.md).
-* The current linter rules are:
-
-  * [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
-  * [no-unused-params](./linter-rule-no-unused-parameters.md)
-  * [no-unused-vars](./linter-rule-no-unused-variables.md)
-  * [prefer-interpolation](./linter-rule-prefer-interpolation.md)
-  * [secure-parameter-default](./linter-rule-secure-parameter-default.md)
-  * [simplify-interpolation](./linter-rule-simplify-interpolation.md)
+For more information about the linter, see [Use Bicep linter](./linter.md).

articles/azure-resource-manager/bicep/linter-rule-secure-parameter-default.md

@@ -51,12 +51,4 @@ param adminPassword string = newGuid()
 
 ## Next steps
 
-* For more information about the linter, see [Use Bicep linter](./linter.md).
-* The current linter rules are:
-
-  * [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
-  * [no-unused-params](./linter-rule-no-unused-parameters.md)
-  * [no-unused-vars](./linter-rule-no-unused-variables.md)
-  * [prefer-interpolation](./linter-rule-prefer-interpolation.md)
-  * [secure-parameter-default](./linter-rule-secure-parameter-default.md)
-  * [simplify-interpolation](./linter-rule-simplify-interpolation.md)
+For more information about the linter, see [Use Bicep linter](./linter.md).

articles/azure-resource-manager/bicep/linter-rule-simplify-interpolation.md

@@ -41,12 +41,4 @@ resource AutomationAccount 'Microsoft.Automation/automationAccounts@2020-01-13-p
 
 ## Next steps
 
-* For more information about the linter, see [Use Bicep linter](./linter.md).
-* The current linter rules are:
-
-  * [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
-  * [no-unused-params](./linter-rule-no-unused-parameters.md)
-  * [no-unused-vars](./linter-rule-no-unused-variables.md)
-  * [prefer-interpolation](./linter-rule-prefer-interpolation.md)
-  * [secure-parameter-default](./linter-rule-secure-parameter-default.md)
-  * [simplify-interpolation](./linter-rule-simplify-interpolation.md)
+For more information about the linter, see [Use Bicep linter](./linter.md).

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

@@ -17,6 +17,7 @@ The linter is integrated into the Bicep CLI and the Bicep extension for Visual S
 
 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)
 - [no-hardcoded-env-urls](./linter-rule-no-hardcoded-environment-urls.md)
 - [no-unused-params](./linter-rule-no-unused-parameters.md)
 - [no-unused-vars](./linter-rule-no-unused-variables.md)

articles/azure-resource-manager/bicep/toc.yml

@@ -92,6 +92,8 @@
         href: linter.md
       - name: Linter rules
         items:
+        - name: Admin user name not literal
+          href: linter-rule-admin-username-should-not-be-literal.md
         - name: No hardcoded environment URLs
           href: linter-rule-no-hardcoded-environment-urls.md
         - name: No unused parameters
@@ -157,7 +159,7 @@
   - name: Data types
     href: data-types.md
     displayName: supported types,arrays,booleans,integers,objects,strings,secure
-  - name: Bicep configuration file
+  - name: Configuration file
     href: bicep-config.md
   - name: Functions
     items: