Merge pull request #206577 from mumian/0729-linter-artifacts-parameters

new linter rule - artifacts-parameters

Author: JamesJBarnett

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

@@ -2,7 +2,7 @@
 title: Linter settings for Bicep config
 description: Describes how to customize configuration values for the Bicep linter
 ms.topic: conceptual
-ms.date: 07/29/2022
+ms.date: 08/01/2022
 ---
 
 # Add linter settings in the Bicep config file
@@ -26,6 +26,9 @@ The following example shows the rules that are available for configuration.
         "adminusername-should-not-be-literal": {
           "level": "warning"
         },
+        "artifacts-parameters": {
+          "level": "warning"
+        },
         "no-hardcoded-env-urls": {
           "level": "warning"
         },

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

@@ -0,0 +1,64 @@
+---
+title: Linter rule - artifacts parameters
+description: Linter rule - artifacts parameters
+ms.topic: conceptual
+ms.date: 08/05/2022
+---
+
+# Linter rule - artifacts parameters
+
+This rule verifies whether the artifacts parameters are defined correctly. The following conditions must be met to pass the test:
+
+- If you provide one parameter (either `_artifactsLocation` or `_artifactsLocationSasToken`), you must provide the other.
+- `_artifactsLocation` must be a string.
+- If `_artifactsLocation` has a default value, it must be either `deployment().properties.templateLink.uri` or a raw URL for its default value.
+- `_artifactsLocationSasToken` must be a secure string.
+- If `_artifactsLocationSasToken` has a default value, it must be an empty string.
+- If a referenced module has an `_artifactsLocation` or `_artifactsLocationSasToken` parameter, a value must be passed in for those parameters, even if they have default values in the module.
+
+## Linter rule code
+
+Use the following value in the [Bicep configuration file](bicep-config-linter.md) to customize rule settings:
+
+`artifacts-parameters`
+
+## Solution
+
+The following example fails this test because `_artifactsLocationSasToken` is missing:
+
+```bicep
+@description('The base URI where artifacts required by this template are located including a trailing \'/\'')
+param _artifactsLocation string = deployment().properties.templateLink.uri
+
+...
+```
+
+The next example fails this test because `_artifactsLocation` must be either `deployment().properties.templateLink.uri` or a raw URL when the default value is provided, and the default value of `_artifactsLocationSasToken` is not an empty string.
+
+```bicep
+@description('The base URI where artifacts required by this template are located including a trailing \'/\'')
+param _artifactsLocation string = 'something'
+
+@description('SAS Token for accessing script path')
+@secure()
+param _artifactsLocationSasToken string = 'something'
+
+...
+````
+
+This example passes this test.
+
+```bicep
+@description('The base URI where artifacts required by this template are located including a trailing \'/\'')
+param _artifactsLocation string = deployment().properties.templateLink.uri
+
+@description('SAS Token for accessing script path')
+@secure()
+param _artifactsLocationSasToken string = ''
+
+...
+```
+
+## Next steps
+
+For more information about the linter, see [Use Bicep linter](./linter.md).

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

@@ -18,6 +18,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)
+- [artifacts-parameters](./linter-rule-artifacts-parameters.md)
 - [max-outputs](./linter-rule-max-outputs.md)
 - [max-params](./linter-rule-max-parameters.md)
 - [max-resources](./linter-rule-max-resources.md)

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

@@ -354,6 +354,8 @@
       items:
       - name: Admin user name not literal
         href: linter-rule-admin-username-should-not-be-literal.md
+      - name: Artifacts parameters
+        href: linter-rule-artifacts-parameters.md
       - name: Max outputs
         href: linter-rule-max-outputs.md
       - name: Max parameters

articles/event-grid/toc.yml

@@ -25,7 +25,7 @@ items:
       - name: Azure PowerShell
         href: ../storage/blobs/storage-blob-event-quickstart-powershell.md?toc=%2fazure%2fevent-grid%2ftoc.json
       - name: Bicep
-        displayName: Resource Manager, ARM
+        displayName: Resource Manager,ARM,template
         href: blob-event-quickstart-bicep.md
       - name: ARM template
         displayName: Resource Manager
@@ -289,7 +289,7 @@ items:
     - name: Get access keys for topics or domains
       href: get-access-keys.md
     - name: Get schema supported by a topic
-      href: get-topic-schema.md      
+      href: get-topic-schema.md
     - name: Publish events custom topics using access keys
       href: post-to-custom-topic.md
     - name: Receive events at HTTP endpoint