Merge pull request #285639 from mumian/0822-bcp063

Add new Bicep diagnostic codes

Author: v-regandowner

articles/azure-resource-manager/bicep/bicep-core-diagnostics.md

@@ -0,0 +1,39 @@
+---
+title: BCP007
+description: Error - This declaration type isn't recognized. Specify a metadata, parameter, variable, resource, or output declaration.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/23/2024
+---
+
+# Bicep error code - BCP007
+
+This error occurs when the declaration type isn't recognized. For a list of declaration types, see [Understand the structure and syntax of Bicep files](../file.md).
+
+## Error description
+
+`This declaration type isn't recognized. Specify a metadata, parameter, variable, resource, or output declaration.`
+
+## Solution
+
+Use the correct declaration type. For more information, see [Bicep file](../file.md).
+
+## Examples
+
+The following example raises the error because `parameter` isn't a correct declaration type:
+
+```bicep
+parameter name string 
+```
+
+You can fix the error by using the correct declaration type, `param`.  
+
+```bicep
+param name string 
+```
+
+For more information, see [Parameters](../parameters.md).
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

articles/azure-resource-manager/bicep/diagnostics/bcp007.md

@@ -0,0 +1,39 @@
+---
+title: BCP009
+description: Error - Expected a literal value, an array, an object, a parenthesized expression, or a function call at this location.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/23/2024
+---
+
+# Bicep error code - BCP009
+
+This error occurs when a declaration is not completed.
+
+## Error description
+
+`Expected a literal value, an array, an object, a parenthesized expression, or a function call at this location.`
+
+## Solution
+
+Include the missing part.  For more information, see [Bicep file](../file.md).
+
+## Examples
+
+The following example raises the error because the `metadata` declaration isn't completed:
+
+```bicep
+metadata description = 
+```
+
+You can fix the error by using completing the declaration.
+
+```bicep
+metadata description = 'Creates a storage account and a web app'
+```
+
+For more information, see [Metadata](../file.md#metadata).
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

articles/azure-resource-manager/bicep/diagnostics/bcp009.md

@@ -37,6 +37,8 @@ output tennisBall object = {
 }
 ```
 
+For more information, see [Objects](../data-types.md#objects)
+
 The following example raises the error because the code is missing a _]_. 
 
 ```bicep
@@ -56,6 +58,22 @@ output colors array = [
 ]
 ```
 
+For more information, see [Arrays](../data-types.md#arrays).
+
+The following example raises the error because the code is missing `=` and the assigned value.
+
+```bicep
+output month int
+```
+
+You can fix the error by completing the output declaration.
+
+```bicep
+output month int = 3
+```
+
+For more information, see [Outputs](../file.md#outputs).
+
 ## Next steps
 
-For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

articles/azure-resource-manager/bicep/diagnostics/bcp018.md

@@ -8,15 +8,15 @@ ms.date: 08/08/2024
 
 # Bicep error code - BCP057
 
-This error occurs when the referenced name doesn't exist, either because of a typo or because it hasn't been declared.
+This error occurs when the referenced name doesn't exist, either due to a typo or because it hasn't been declared. If it's a typo, you'll encounter [BCP082](./bcp082.md) when the compiler identifies and suggests a similarly named symbol.
 
 ## Error description
 
 `The name <name> does not exist in the current context.`
 
 ## Solution
 
-Fix the typo or declare the name.
+Fix the typo or declare the symbol.
 
 ## Examples
 

articles/azure-resource-manager/bicep/diagnostics/bcp057.md

@@ -0,0 +1,46 @@
+---
+title: BCP063
+description: Error - The name <name> isn't a parameter, variable, resource, or module.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/23/2024
+---
+
+# Bicep error code - BCP063
+
+This error occurs when the system tries to locate a name within the context, but no matching name is found.
+
+## Error description
+
+`The name <name> isn't a parameter, variable, resource, or module.`
+
+## Solutions
+
+Use the property declaration types. For more information, see [Bicep file](../file.md).
+
+## Examples
+
+The following example raises the error because *@metadata* is not a correct declaration type:
+
+```bicep
+@metadata
+resource store 'Microsoft.Storage/storageAccounts@2023-05-01' existing = {
+  name: 'mystore'
+}
+```
+
+You can fix the error by properly declaring `metadata`.  
+
+```bicep
+metadata description = 'create a storage account'
+
+resource store 'Microsoft.Storage/storageAccounts@2023-05-01' existing = {
+  name: 'mystore'
+}
+```
+
+For more information, see [Metadata](../file.md#metadata).
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

articles/azure-resource-manager/bicep/diagnostics/bcp063.md

@@ -0,0 +1,37 @@
+---
+title: BCP071
+description: Error - Expected <arugment-count>, but got <argument-count>.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 07/15/2024
+---
+
+# Bicep error code - BCP071
+
+This error occurs when a function is given an incorrect number of arguments. For a list of system defined functions, see [Bicep functions](../bicep-functions-any.md).  To define you own functions, see [User-defined functions](../user-defined-functions.md).
+
+## Error description
+
+`Expected <arugment-count>, but got <argument-count>.`
+
+## Solution
+
+Provide the correct number of arguments.
+
+## Examples
+
+The following example raises the error because [`split()`](../bicep-functions-string.md#split) expects two arguments, but three arguments were provided:
+
+```bicep
+var tooManyArgs = split('a,b', ',', '?')
+```
+
+You can fix the error by removing the extra argument:
+
+```bicep
+var tooManyArgs = split('a,b', ',', '?')
+```
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

articles/azure-resource-manager/bicep/diagnostics/bcp071.md

@@ -0,0 +1,37 @@
+---
+title: BCP082
+description: Error/warning - The name <name> doesn't exist in the current context. Did you mean <name>?
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/06/2024
+---
+
+# Bicep error/warning code - BCP082
+
+This error or warning is similar to [BCP057](./bcp057.md), it occurs when the referenced name doesn't exist, likely due to a typo. The compiler identifies and suggests a similarly named symbol.
+
+## Error/warning description
+
+`The name <name> doesn't exist in the current context. Did you mean <name>?`
+
+## Solutions
+
+Fix the typo.
+
+## Examples
+
+The following example raises the error because `substirng` looks like a typo.
+
+```bicep
+var prefix = substirng('1234567890', 0, 11)
+```
+
+You can fix the error by using `substring` instead:
+
+```bicep
+var prefix = substring('1234567890', 0, 11)
+```
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep warnings and errors](../bicep-core-diagnostics.md).

articles/azure-resource-manager/bicep/diagnostics/bcp082.md

@@ -0,0 +1,41 @@
+---
+title: BCP124
+description: Error - The decorator <decorator-name> can only be attached to targets of type <data-type>, but the target has type <data-type>.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/23/2024
+---
+
+# Bicep error code - BCP124
+
+This error occurs when you specify a decorator that isn't supported by the type of the syntax being decorated.
+
+## Error description
+
+`The decorator <decorator-name> can only be attached to targets of type <data-type>, but the target has type <data-type>.`
+
+## Solutions
+
+Use the valid decorators based on the data types.
+
+## Examples
+
+The following example raises the error because `@maxValue()` is for the integer data type, not for the string data type.
+
+```bicep
+@maxValue(3)
+param name string 
+```
+
+You can fix the error by providing the correct decorator for the data type:
+
+```bicep
+@maxLength(3)
+param name string 
+```
+
+For a list of decorators, see [Decorators](../file.md#decorators).
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

articles/azure-resource-manager/bicep/diagnostics/bcp124.md

@@ -0,0 +1,39 @@
+---
+title: BCP125
+description: Error - Function <function-name> can't be used as a parameter decorator.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/23/2024
+---
+
+# Bicep error code - BCP125
+
+This error occurs when you specify an invalid parameter decorator.
+
+## Error description
+
+`Function <function-name> can't be used as a parameter decorator.`
+
+## Solutions
+
+Use the valid decorators for parameter declarations.  For more information, see [Decorators](../parameters.md#use-decorators).
+
+## Examples
+
+The following example raises the error because `@export()` isn't a valid decorator for parameters.
+
+```bicep
+@export()
+param name string 
+```
+
+You can fix the error by providing the correct decorator for parameters:
+
+```bicep
+@description('Specify the resource name.')
+param name string 
+```
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).