Merge pull request #288258 from mumian/main

restructure the diagnostic files

Author: JamesJBarnett

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

@@ -1,32 +1,36 @@
 ---
 title: BCP007
-description: Error - This declaration type isn't recognized. Specify a metadata, parameter, variable, resource, or output declaration.
+description: 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
+# Bicep diagnostic 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).
+This diagnostic 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
+## Description
 
-`This declaration type isn't recognized. Specify a metadata, parameter, variable, resource, or output declaration.`
+This declaration type isn't recognized. Specify a metadata, parameter, variable, resource, or output declaration.
+
+## Level
+
+Error
 
 ## 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:
+The following example raises the diagnostic because `parameter` isn't a correct declaration type:
 
 ```bicep
 parameter name string 
 ```
 
-You can fix the error by using the correct declaration type, `param`.  
+You can fix the diagnostic by using the correct declaration type, `param`.  
 
 ```bicep
 param name string 
@@ -36,4 +40,4 @@ 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).
+For more information about Bicep diagnostics, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

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

@@ -1,32 +1,36 @@
 ---
 title: BCP009
-description: Error - Expected a literal value, an array, an object, a parenthesized expression, or a function call at this location.
+description: 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
+# Bicep diagnostic code - BCP009
 
-This error occurs when a declaration is not completed.
+This diagnostic occurs when a declaration is not completed.
 
-## Error description
+## Description
 
-`Expected a literal value, an array, an object, a parenthesized expression, or a function call at this location.`
+Expected a literal value, an array, an object, a parenthesized expression, or a function call at this location.
+
+## Level
+
+Error
 
 ## 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:
+The following example raises the diagnostic because the `metadata` declaration isn't completed:
 
 ```bicep
 metadata description = 
 ```
 
-You can fix the error by using completing the declaration.
+You can fix the diagnostic by using completing the declaration.
 
 ```bicep
 metadata description = 'Creates a storage account and a web app'
@@ -36,4 +40,4 @@ 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).
+For more information about Bicep diagnostics, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

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

@@ -1,34 +1,38 @@
 ---
 title: BCP018
-description: Error - Expected the <character> character at this location.
+description: Expected the <character> character at this location.
 ms.topic: reference
 ms.custom: devx-track-bicep
 ms.date: 08/08/2024
 ---
 
-# Bicep error code - BCP018
+# Bicep diagnostic code - BCP018
 
-This error occurs when a character, such as a bracket, is missing.
+This diagnostic occurs when a character, such as a bracket, is missing.
 
-## Error description
+## Description
 
-`Expected the <character> character at this location.`
+Expected the \<character> character at this location.
+
+## Level
+
+Error
 
 ## Solution
 
 Add the missing character.
 
 ## Examples
 
-The following example raises the error because the code is missing a _}_. 
+The following example raises the diagnostic because the code is missing a _}_. 
 
 ```bicep
 output tennisBall object = {
   type: 'tennis'
   color: 'yellow'
 ```
 
-You can fix the error by adding the missing _}_.
+You can fix the diagnostic by adding the missing _}_.
 
 ```bicep
 output tennisBall object = {
@@ -39,7 +43,7 @@ output tennisBall object = {
 
 For more information, see [Objects](../data-types.md#objects)
 
-The following example raises the error because the code is missing a _]_. 
+The following example raises the diagnostic because the code is missing a _]_. 
 
 ```bicep
 output colors array = [
@@ -48,7 +52,7 @@ output colors array = [
   'white'
 ```
 
-You can fix the error by adding the missing _]_.
+You can fix the diagnostic by adding the missing _]_.
 
 ```bicep
 output colors array = [
@@ -60,13 +64,13 @@ 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.
+The following example raises the diagnostic because the code is missing `=` and the assigned value.
 
 ```bicep
 output month int
 ```
 
-You can fix the error by completing the output declaration.
+You can fix the diagnostic by completing the output declaration.
 
 ```bicep
 output month int = 3
@@ -76,4 +80,4 @@ 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 diagnostics, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

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

@@ -1,34 +1,38 @@
 ---
 title: BCP033
-description: Error/warning - Expected a value of type <data-type> but the provided value is of type <data-type>.
+description: Expected a value of type <data-type> but the provided value is of type <data-type>.
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 07/15/2024
+ms.date: 10/10/2024
 ---
 
-# Bicep error/warning code - BCP033
+# Bicep diagnostic code - BCP033
 
-This error/warning occurs when you assign a value of a mismatched data type.
+This diagnostic occurs when you assign a value of a mismatched data type.
 
-## Error/warning description
+## Description
 
-`Expected a value of type <data-type> but the provided value is of type <data-type>.`
+Expected a value of type \<data-type> but the provided value is of type \<data-type>.
+
+## Level
+
+Warning / Error
 
 ## Solution
 
-Use the expected data type.  
+Use the expected data type. If the provided value is a token, enclose it in the [any() function](../bicep-functions-any.md) to mitigate the issue.
 
 ## Examples
 
-The following example raises the error because the expected data type is a string. The actual provided value is an integer:
+The following example raises the diagnostic because the expected data type is a string. The actual provided value is an integer:
 
 ```bicep
 var myValue = 5
 
 output myString string = myValue
 ```
 
-You can fix the error by providing a string value:
+You can fix the diagnostic by providing a string value:
 
 ```bicep
 var myValue = '5'
@@ -38,4 +42,4 @@ output myString string = myValue
 
 ## Next steps
 
-For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).
+For more information about Bicep diagnostics, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

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

@@ -1,26 +1,30 @@
 ---
 title: BCP035
-description: Error/warning - The specified <data-type> declaration is missing the following required properties <property-name>.
+description: The specified <data-type> declaration is missing the following required properties <property-name>.
 ms.topic: reference
 ms.custom: devx-track-bicep
 ms.date: 07/15/2024
 ---
 
-# Bicep error/warning code - BCP035
+# Bicep diagnostic code - BCP035
 
-This error/warning occurs when your resource definition is missing a required property.
+This diagnostic occurs when your resource definition is missing a required property.
 
-## Error/warning description
+## Description
 
-`The specified <date-type> declaration is missing the following required properties: <property-name>.`
+The specified \<date-type> declaration is missing the following required properties: \<property-name>.
+
+## Level
+
+Warning / Error
 
 ## Solution
 
 Add the missing property to the resource definition.
 
 ## Examples
 
-The following example raises the warning for _virtualNetworkGateway1_ and _virtualNetworkGateway2_:
+The following example raises the diagnostic for _virtualNetworkGateway1_ and _virtualNetworkGateway2_:
 
 ```bicep
 var networkConnectionName = 'testConnection'
@@ -44,13 +48,13 @@ resource networkConnection 'Microsoft.Network/connections@2023-11-01' = {
 }
 ```
 
-The warning is:
+The diagnostic is:
 
-```warning
+```diagnostic
 The specified "object" declaration is missing the following required properties: "properties". If this is an inaccuracy in the documentation, please report it to the Bicep Team.
 ```
 
-You can verify the missing properties from the [template reference](/azure/templates). If you see the warning from Visual Studio Code, hover the cursor over the resource symbolic name and select **View document** to open the template reference.
+You can verify the missing properties from the [template reference](/azure/templates). If you see the diagnostic from Visual Studio Code, hover the cursor over the resource symbolic name and select **View document** to open the template reference.
 
 You can fix the issue by adding the missing properties:
 
@@ -78,7 +82,7 @@ resource networkConnection 'Microsoft.Network/connections@2023-11-01' = {
 }
 ```
 
-The following example raises the error for _outValue_ because the required property _value_ is missing:
+The following example raises the diagnostic for _outValue_ because the required property _value_ is missing:
 
 ```bicep
 @discriminator('type')
@@ -98,4 +102,4 @@ output outValue taggedUnion = {type: 'foo', value: 3}
 
 ## Next steps
 
-For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).
+For more information about Bicep diagnostics, see [Bicep core diagnostics](../bicep-core-diagnostics.md).

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

@@ -1,26 +1,30 @@
 ---
 title: BCP036
-description: Error/warning - The property <property-name> expected a value of type <data-type> but the provided value is of type <data-type>.
+description: The property <property-name> expected a value of type <data-type> but the provided value is of type <data-type>.
 ms.topic: reference
 ms.custom: devx-track-bicep
 ms.date: 07/15/2024
 ---
 
-# Bicep error/warning code - BCP036
+# Bicep diagnostic code - BCP036
 
-This error/warning occurs when you assign a value to a property whose expected data type isn't compatible with the type of the assigned value.
+This diagnostic occurs when you assign a value to a property whose expected data type isn't compatible with the type of the assigned value.
 
-## Error/warning description
+## Description
 
-`The property <property-name> expected a value of type <data-type> but the provided value is of type <data-type>.`
+The property \<property-name> expected a value of type \<data-type> but the provided value is of type \<data-type>.
+
+## Level
+
+Warning / Error
 
 ## Solution
 
 Assign a value with the correct data type.
 
 ## Examples
 
-The following example raises the error because `sku` is defined as a string, not an integer:
+The following example raises the diagnostic because `sku` is defined as a string, not an integer:
 
 ```bicep
 type storageAccountConfigType = {
@@ -50,4 +54,4 @@ param foo storageAccountConfigType = {
 
 ## Next steps
 
-For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).
+For more information about Bicep diagnostics, see [Bicep core diagnostics](../bicep-core-diagnostics.md).