Merge pull request #284204 from mumian/0807-error-codes-bcp055

Document bcp018, 057, 062, 192, 288, 294, 302, 401

Author: JamesJBarnett

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

@@ -329,6 +329,12 @@ type oneOfSeveralObjects = {foo: 'bar'} | {fizz: 'buzz'} | {snap: 'crackle'}
 type mixedTypeArray = ('fizz' | 42 | {an: 'object'} | null)[]
 ```
 
+Type unions must be reducible to a single ARM type, such as 'string', 'int', or 'bool'. Otherwise, you get the [BCP294](./diagnostics/bcp294.md) error code. For example:
+
+```bicep
+type foo = 'a' | 1
+```
+
 Any type expression can be used as a sub-type in a union type declaration (between `|` characters). For example, the following examples are all valid:
 
 ```bicep

articles/azure-resource-manager/bicep/data-types.md

@@ -0,0 +1,61 @@
+---
+title: BCP018
+description: Error - Expected the <character> character at this location.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/08/2024
+---
+
+# Bicep error code - BCP018
+
+This error occurs when a character, such as a bracket, is missing.
+
+## Error description
+
+`Expected the <character> character at this location.`
+
+## Solution
+
+Add the missing character.
+
+## Examples
+
+The following example raises the error because the code is missing a _}_. 
+
+```bicep
+output tennisBall object = {
+  type: 'tennis'
+  color: 'yellow'
+```
+
+You can fix the error by adding the missing _}_.
+
+```bicep
+output tennisBall object = {
+  type: 'tennis'
+  color: 'yellow'
+}
+```
+
+The following example raises the error because the code is missing a _]_. 
+
+```bicep
+output colors array = [
+  'red'
+  'blue'
+  'white'
+```
+
+You can fix the error by adding the missing _]_.
+
+```bicep
+output colors array = [
+  'red'
+  'blue'
+  'white'
+]
+```
+
+## 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/bcp018.md

@@ -16,7 +16,7 @@ This error/warning occurs when you reference a property that isn't defined in th
 
 ## Solution
 
-Reference the correct property name
+Reference the correct property name.
 
 ## Examples
 

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

@@ -0,0 +1,33 @@
+---
+title: BCP055
+description: Error - Cannot access properties of type <type-name>. A <type-name> type is required.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/07/2024
+---
+
+# Bicep error code - BCP055
+
+This error occurs when you reference a nonexistent property of a type.
+
+## Error description
+
+`Cannot access properties of type <type-name>. A <type-name> type is required.`
+
+## Examples
+
+The following example raises the error because _string.bar_ isn't defined:
+
+```bicep
+type foo = string.bar
+```
+
+You can fix the error by removing the reference:
+
+```bicep
+type foo = string
+```
+
+## 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/bcp055.md

@@ -0,0 +1,45 @@
+---
+title: BCP057
+description: Error - The name <name> doesn't exist in the current context.
+ms.topic: reference
+ms.custom: devx-track-bicep
+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.
+
+## Error description
+
+`The name <name> does not exist in the current context.`
+
+## Solution
+
+Fix the typo or declare the name.
+
+## Examples
+
+The following example raises the error because _bar_ has never been declared:
+
+```bicep
+var foo = bar 
+```
+
+The following example raises the error because _bar1_ is a typo:
+
+```bicep
+var bar = 'white'
+var foo = bar1 
+```
+
+You can fix the error by declaring _bar_, or fix the typo.
+
+```bicep
+var bar = 'white'
+var foo = bar 
+```
+
+## 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/bcp057.md

@@ -0,0 +1,43 @@
+---
+title: BCP062
+description: Error - The referenced declaration with name <type-name> is not valid.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/08/2024
+---
+
+# Bicep error code - BCP062
+
+This error occurs when the referenced declaration has an error.
+
+## Error description
+
+`The referenced declaration with name <type-name> is not valid.`
+
+## Examples
+
+The following example raises the error because the referenced [user-defined data type](../user-defined-data-types.md) has an error:
+
+```bicep
+type ball = object.bar
+
+output tennisBall ball = {
+  name: 'tennis'
+  color: 'yellow'
+}
+```
+
+You can fix the error by fixing the _ball_ definition:
+
+```bicep
+type ball = object
+
+output tennisBall ball = {
+  name: 'tennis'
+  color: 'yellow'
+}
+```
+
+## 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/bcp062.md

@@ -12,7 +12,11 @@ This error/warning occurs when a property name seems to be a typo.
 
 ## Error/warning description
 
-`The property <property-name> is not allowed on objects of type <resource-type>. Did you mean <property-name>?`
+`The property <property-name> is not allowed on objects of type <resource-type/type-definition>. Did you mean <property-name>?`
+
+## Solution
+
+Fix the typo.
 
 ## Examples
 
@@ -32,6 +36,34 @@ resource storageAccount 'Microsoft.Storage/storageAccounts@2023-05-01' existing
 }
 ```
 
+The following example raises the error because the property name _color1_ looks like a typo.
+
+```bicep
+type ball = {
+  name: string
+  color: string
+}
+
+output tennisBall ball = {
+  name: 'tennis'
+  color1: 'yellow'
+}
+```
+
+You can fix the error by correcting the typo:
+
+```bicep
+type ball = {
+  name: string
+  color: string
+}
+
+output tennisBall ball = {
+  name: 'tennis'
+  color: 'yellow'
+}
+```
+
 ## 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/bcp089.md

@@ -0,0 +1,58 @@
+---
+title: BCP192
+description: Error - Unable to restore the artifact with reference <reference>.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/08/2024
+---
+
+# Bicep error code - BCP192
+
+This error occurs when Bicep can't copy the external module to the local cache. For example, an incorrect module reference. For more information about using modules in Bicep and Bicep restore, see [Bicep modules](../modules.md).
+
+## Error description
+
+`Unable to restore the artifact with reference <reference>: <error-message>.`
+
+## Solution
+
+Fix the module reference.
+
+## Examples
+
+The following example raises the error because the public module version doesn't exist:
+
+```bicep
+module storage 'br/public:avm/res/storage/storage-account:0.1.0' = {
+  name: 'myStorage'
+  params: {
+    name: 'store${resourceGroup().name}'
+  }
+}
+```
+
+The following example raises the error because there is a typo in the reference:
+
+```bicep
+module storage 'br/public:avm/res/storage/storage-account1:0.11.1' = {
+  name: 'myStorage'
+  params: {
+    name: 'store${resourceGroup().name}'
+  }
+}
+```
+
+You can fix the error by correct the AVM reference and the version:
+
+```bicep
+module storage 'br/public:avm/res/storage/storage-account:0.11.1' = {
+  name: 'myStorage'
+  params: {
+    name: 'store${resourceGroup().name}'
+  }
+}
+```
+
+## 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/bcp192.md

@@ -0,0 +1,39 @@
+---
+title: BCP288
+description: Error - <name> refers to a type but is being used as a value here.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/08/2024
+---
+
+# Bicep error code - BCP288
+
+This error occurs when the name specified is a type, but it's being used as a value.
+
+## Error description
+
+`<name> refers to a type but is being used as a value here.`
+
+## Solution
+
+Use a name of a value.
+
+## Examples
+
+The following example raises the error because _bar_ is a name of a [user-defined data type](../user-defined-data-types.md), not a value:
+
+```bicep
+type bar = 'white'
+var foo = bar 
+```
+
+You can fix the error by assigning a value to the variable _foo_:
+
+```bicep
+var bar = 'white'
+var foo = bar 
+```
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).