US:18890-Standardize Bicep Parameters for MACAE

Author: VishalS-Microsoft

docs/CustomizingAzdParameters.md

@@ -0,0 +1,29 @@
+## [Optional]: Customizing resource names 
+
+By default this template will use the environment name as the prefix to prevent naming collisions within Azure. The parameters below show the default values. You only need to run the statements below if you need to change the values. 
+
+> To override any of the parameters, run `azd env set <PARAMETER_NAME> <VALUE>` before running `azd up`. On the first azd command, it will prompt you for the environment name. Be sure to choose 3-20 characters alphanumeric unique name. 
+
+## Parameters
+| Name                         | Type   | Default Value     | Purpose                                                                                             |
+| ---------------------------- | ------ | ----------------- | --------------------------------------------------------------------------------------------------- |
+| `AZURE_ENV_NAME`             | string | `macae`           | Used as a prefix for all resource names to ensure uniqueness across environments.                   |
+| `AZURE_LOCATION`             | string | `japaneast`       | Location of the Azure resources. Controls where the infrastructure will be deployed.                |
+| `AZURE_ENV_OPENAI_LOCATION`  | string | `swedencentral`   | Specifies the region for OpenAI resource deployment.                                                |
+| `AZURE_ENV_ENABLE_TELEMETRY` | bool   | `true`            | Enables telemetry for monitoring and diagnostics.                                                   |
+
+---
+
+## How to Set a Parameter
+
+To customize any of the above values, run the following command **before** `azd up`:
+
+```bash
+azd env set <PARAMETER_NAME> <VALUE>
+```
+
+**Example:**
+
+```bash
+azd env set AZURE_LOCATION westus2
+```

documentation/DeploymentGuide.md

@@ -134,15 +134,15 @@ Consider the following settings during your deployment to modify specific settin
 <details>
   <summary><b>Configurable Deployment Settings</b></summary>
 
-When you start the deployment, most parameters will have **default values**, but you can update the following settings:
-
-| **Setting**                       | **Description**                                                                             | **Default value** |
-| --------------------------------- | ------------------------------------------------------------------------------------------- | ----------------- |
-| **Azure Region**                  | The region where resources will be created.                                                 | East US           |
-| **Secondary Location**            | A **less busy** region for **Azure Cosmos DB**, useful in case of availability constraints. | eastus2           |
-| **Deployment Type**               | Select from a drop-down list.                                                               | GlobalStandard    |
-| **GPT Model**                     | Choose from **gpt-4, gpt-4o, gpt-4o-mini**.                                                 | gpt-4o            |
-| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**.                                                      | 140k              |
+When you start the deployment, most parameters will have **default values**, but you can update the following settings [here](../docs/CustomizingAzdParameters.md):
+
+| **Setting**                    | **Description**                                                                      | **Default value** |
+| ------------------------------ | ------------------------------------------------------------------------------------ | ----------------- |
+| **Environment Name**           | Used as a prefix for all resource names to ensure uniqueness across environments.    | macae             |
+| **Azure Region**               | Location of the Azure resources. Controls where the infrastructure will be deployed. | japaneast         |
+| **OpenAI Deployment Location** | Specifies the region for OpenAI resource deployment.                                 | swedencentral     |
+| **Enable Telemetry**           | Enables telemetry for monitoring and diagnostics.                                    | true              |
+
 
 </details>
 

infra/main.bicepparam

@@ -1,8 +1,9 @@
 using './main.bicep'
 
-param solutionPrefix = null //Type a string value to customize the prefix for your resource names
+param solutionPrefix = readEnvironmentVariable('AZURE_ENV_NAME', 'macae')
 param solutionLocation = readEnvironmentVariable('AZURE_LOCATION', 'swedencentral')
 param azureOpenAILocation = readEnvironmentVariable('AZURE_ENV_OPENAI_LOCATION', 'swedencentral')
+param enableTelemetry = bool(readEnvironmentVariable('AZURE_ENV_ENABLE_TELEMETRY', 'true'))
 param logAnalyticsWorkspaceConfiguration = {
   dataRetentionInDays: 30
   existingWorkspaceResourceId: ''

infra/main.waf-aligned.bicepparam

@@ -1,8 +1,9 @@
 using './main.bicep'
 
-param solutionPrefix = null //Type a string value to customize the prefix for your resource names
+param solutionPrefix = readEnvironmentVariable('AZURE_ENV_NAME', 'macae')
 param solutionLocation = readEnvironmentVariable('AZURE_LOCATION', 'swedencentral')
 param azureOpenAILocation = readEnvironmentVariable('AZURE_ENV_OPENAI_LOCATION', 'swedencentral')
+param enableTelemetry = bool(readEnvironmentVariable('AZURE_ENV_ENABLE_TELEMETRY', 'true'))
 param virtualMachineConfiguration = {
   adminUsername: 'adminuser'
   adminPassword: 'P@ssw0rd1234'