Merge pull request #284244 from mumian/0809-readEnvironmentVariable

Add readEnvironmentVariable() remarks

Author: JamesJBarnett

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

@@ -320,15 +320,15 @@ If you need more information about a particular diagnostic code, select the **Fe
 | BCP334     | Warning | The provided value can have a length as small as {sourceMinLength} and may be too short to assign to a target with a configured minimum length of {targetMinLength}. |
 | BCP335     | Warning | The provided value can have a length as large as {sourceMaxLength} and may be too long to assign to a target with a configured maximum length of {targetMaxLength}. |
 | BCP337     | Error | This declaration type is not valid for a Bicep Parameters file. Specify a "{LanguageConstants.UsingKeyword}", "{LanguageConstants.ParameterKeyword}" or "{LanguageConstants.VariableKeyword}" declaration. |
-| BCP338     | Error | Failed to evaluate parameter "{parameterName}": {message} |
+| <a id='BCP338' />[BCP338](./diagnostics/bcp338.md) | Error | Failed to evaluate parameter \<parameter-name>: \<error-message>` |
 | BCP339     | Error | The provided array index value of "{indexSought}" is not valid. Array index should be greater than or equal to 0. |
 | BCP340     | Error | Unable to parse literal YAML value. Please ensure that it is well-formed. |
 | BCP341     | Error | This expression is being used inside a function declaration, which requires a value that can be calculated at the start of the deployment. {variableDependencyChainClause}{accessiblePropertiesClause} |
 | BCP342     | Error | User-defined types are not supported in user-defined function parameters or outputs. |
 | BCP344     | Error | Expected an assert identifier at this location. |
 | BCP345     | Error | A test declaration can only reference a Bicep File |
-| BCP0346    | Error | Expected a test identifier at this location. |
-| BCP0347    | Error | Expected a test path string at this location. |
+| BCP346    | Error | Expected a test identifier at this location. |
+| BCP347    | Error | Expected a test path string at this location. |
 | BCP348     | Error | Using a test declaration statement requires enabling EXPERIMENTAL feature "{nameof(ExperimentalFeaturesEnabled.TestFramework)}". |
 | BCP349     | Error | Using an assert declaration requires enabling EXPERIMENTAL feature "{nameof(ExperimentalFeaturesEnabled.Assertions)}". |
 | BCP350       | Error | Value of type "{valueType}" cannot be assigned to an assert. Asserts can take values of type 'bool' only. |

articles/azure-resource-manager/bicep/bicep-functions-parameters-file.md

@@ -3,7 +3,7 @@ title: Bicep functions - parameters file
 description: This article describes the Bicep functions to be used in Bicep parameter files.
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 03/20/2024
+ms.date: 08/09/2024
 ---
 
 # Parameters file function for Bicep
@@ -81,6 +81,28 @@ Namespace: [sys](bicep-functions.md#namespaces-for-functions).
 
 The string value of the environment variable or a default value.
 
+### Remarks
+
+The following command sets the environment variable only for the PowerShell process in which it's executed. You get [BCP338](./diagnostics/bcp338.md) from Visual Studio Code.
+
+```PowerShell
+$env:testEnvironmentVariable = "Hello World!"
+```
+
+To set the environment variable at the user level, use the following command:
+
+```powershell
+[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'User')
+```
+
+To set the environment variable at the machine level, use the following command:
+
+```powershell
+[System.Environment]::SetEnvironmentVariable('testEnvironmentVariable','Hello World!', 'Machine')
+```
+
+For more information, see [Environment.SetEnvironmentVariable Method](/dotnet/api/system.environment.setenvironmentvariable).
+
 ### Examples
 
 The following examples show how to retrieve the values of environment variables.

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

@@ -0,0 +1,35 @@
+---
+title: BCP338
+description: Error - Failed to evaluate parameter <parameter-name>.
+ms.topic: reference
+ms.custom: devx-track-bicep
+ms.date: 08/09/2024
+---
+
+# Bicep error code - BCP338
+
+This error occurs when Bicep can't resolve a parameter name in the Bicep parameter file.
+
+## Error description
+
+`Failed to evaluate parameter <parameter-name>: <error-message>`.
+
+## Solution
+
+Check the parameter value.
+
+## Examples
+
+The following Bicep parameter file raises the error because _testEnvironmentVariable_ can't be found:
+
+```bicep
+using 'main.bicep'
+param parTest = readEnvironmentVariable('testEnvironmentVariable')
+```
+
+It could be because the environment variable isn't defined in the user or system level. For more information, see [`readEnvironmentVariable`](../bicep-functions-parameters-file.md)
+You can fix the error by assigning a string whose length is within the allowable range.
+
+## Next steps
+
+For more information about Bicep error and warning codes, see [Bicep core diagnostics](../bicep-core-diagnostics.md).