US:18810-Standardize Bicep Parameters for DocGen

Author: VishalS-Microsoft

docs/CustomizingAzdParameters.md

@@ -3,46 +3,36 @@
 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 <key> <value>` before running `azd up`. On the first azd command, it will prompt you for the environment name. Be sure to choose 3-20 charaters alphanumeric unique name. 
+> 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 charaters alphanumeric unique name. 
 
+## Parameters
 
-Change the Secondary Location (example: eastus2, westus2, etc.)
+| Name                                   | Type    | Example Value                | Purpose                                                                       |
+| -------------------------------------- | ------- | ---------------------------- | ----------------------------------------------------------------------------- |
+| `AZURE_LOCATION`                       | string  | `japaneast` | Sets the Azure region for resource deployment.                                |
+| `AZURE_ENV_NAME`                       | string  | `docgen`                   | Sets the environment name prefix for all Azure resources.                     |
+| `AZURE_ENV_SECONDARY_LOCATION`         | string  | `eastus2`                  | Specifies a secondary Azure region.                                           |
+| `AZURE_ENV_MODEL_DEPLOYMENT_TYPE`      | string  | `Standard`                 | Defines the model deployment type (allowed: `Standard`, `GlobalStandard`).    |
+| `AZURE_ENV_MODEL_NAME`                 | string  | `gpt-4o`                   | Specifies the GPT model name (allowed: `gpt-4`, `gpt-4o`).                    |
+| `AZURE_ENV_MODEL_VERSION`                 | string  | `2024-05-13`                   | Set the Azure model version (allowed values: `2024-08-06`).                    |
+| `AZURE_ENV_OPENAI_API_VERSION`                 | string  | `2024-05-01-preview`                   | Specifies the API version for Azure OpenAI.                    |
+| `AZURE_ENV_MODEL_CAPACITY`             | integer | `30`                         | Sets the GPT model capacity (based on what's available in your subscription). |
+| `AZURE_ENV_EMBEDDING_MODEL_NAME`       | string  | `text-embedding-ada-002`   | Sets the name of the embedding model to use.                                  |
+| `AZURE_ENV_IMAGETAG`       | string  | `latest`   | Set the Image tag Like (allowed values: latest, dev, hotfix)                                   |
+| `AZURE_ENV_EMBEDDING_MODEL_CAPACITY`   | integer | `80`                         | Sets the capacity for the embedding model deployment.                         |
+| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string  | `<Existing Workspace Id>`  | Reuses an existing Log Analytics Workspace instead of creating a new one.     |
 
-```shell
-azd env set AZURE_ENV_SECONDARY_LOCATION eastus2
-```
-
-Change the Model Deployment Type (allowed values: Standard, GlobalStandard)
-
-```shell
-azd env set AZURE_ENV_MODEL_DEPLOYMENT_TYPE Standard
-```
-
-Set the Model Name (allowed values: gpt-4, gpt-4o)
 
-```shell
-azd env set AZURE_ENV_MODEL_NAME gpt-4o
-```
+## How to Set a Parameter
 
-Change the Model Capacity (choose a number based on available GPT model capacity in your subscription)
+To customize any of the above values, run the following command **before** `azd up`:
 
-```shell
-azd env set AZURE_ENV_MODEL_CAPACITY 30
+```bash
+azd env set <PARAMETER_NAME> <VALUE>
 ```
 
-Change the Embedding Model 
-
-```shell
-azd env set AZURE_ENV_EMBEDDING_MODEL_NAME text-embedding-ada-002
-```
-
-Change the Embedding Deployment Capacity (choose a number based on available embedding model capacity in your subscription)
-
-```shell
-azd env set AZURE_ENV_EMBEDDING_MODEL_CAPACITY 80
-```
+**Example:**
 
-Set the Log Analytics Workspace Id if you need to reuse the existing workspace
-```shell
-azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '<Existing Log Analytics Workspace Id>'
+```bash
+azd env set AZURE_LOCATION westus2
 ```

docs/DeploymentGuide.md

@@ -22,6 +22,11 @@ Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
 
 This will allow the scripts to run for the current session without permanently changing your system's policy.
 
+### **Configurable Deployment Settings**  
+
+When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md): 
+
+
 ## Deployment Options & Steps
 
 Pick from the options below to see step-by-step instructions for GitHub Codespaces, VS Code Dev Containers, and Local Environments.

infra/main.bicepparam

@@ -6,7 +6,10 @@ param secondaryLocation = readEnvironmentVariable('AZURE_ENV_SECONDARY_LOCATION'
 param deploymentType = readEnvironmentVariable('AZURE_ENV_MODEL_DEPLOYMENT_TYPE', 'GlobalStandard')
 param gptModelName = readEnvironmentVariable('AZURE_ENV_MODEL_NAME', 'gpt-4o')
 param gptModelVersion = readEnvironmentVariable('AZURE_ENV_MODEL_VERSION', '2024-05-13')
+param azureOpenaiAPIVersion = readEnvironmentVariable('AZURE_ENV_OPENAI_API_VERSION', '2024-05-01-preview')
 param gptDeploymentCapacity = int(readEnvironmentVariable('AZURE_ENV_MODEL_CAPACITY', '30'))
+param embeddingModel = readEnvironmentVariable('AZURE_ENV_EMBEDDING_MODEL_NAME', 'text-embedding-ada-002')
+param imageTag = readEnvironmentVariable('AZURE_ENV_IMAGETAG', 'latest')
 
 param embeddingDeploymentCapacity = int(readEnvironmentVariable('AZURE_ENV_EMBEDDING_MODEL_CAPACITY', '80'))
 param existingLogAnalyticsWorkspaceId = readEnvironmentVariable('AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID', '')