Merge pull request #117 from microsoft/psl-us18810-codmod

feat: Standardize Bicep Parameters for Code Modernization

Author: Roopan-Microsoft

docs/CustomizingAzdParameters.md

@@ -2,30 +2,33 @@
 
 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. 
 
-> 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 characters alphanumeric unique name. 
+## Parameters
 
-Change the Content Understanding Location (allowed values: Sweden Central, Australia East)
+| Name                                   | Type    | Default Value    | Purpose                                                                                              |
+| -------------------------------------- | ------- | ---------------- | ---------------------------------------------------------------------------------------------------- |
+| `AZURE_ENV_NAME`                       | string  | `azdtemp`        | 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_MODEL_DEPLOYMENT_TYPE`      | string  | `GlobalStandard` | Change the Model Deployment Type (allowed values: Standard, GlobalStandard).                         |
+| `AZURE_ENV_MODEL_NAME`                 | string  | `gpt-4o`         | Set the Model Name (allowed values: gpt-4o).                                                         |
+| `AZURE_ENV_MODEL_VERSION`              | string  | `2024-08-06`     | Set the Azure model version (allowed values: 2024-08-06)    |
+| `AZURE_ENV_MODEL_CAPACITY`             | integer | `200`            | Set the Model Capacity (choose a number based on available GPT model capacity in your subscription). |
+| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string  | `<Existing Workspace Id>`     | Set this if you want to reuse an existing Log Analytics Workspace instead of creating a new one.     |
+| `AZURE_ENV_IMAGETAG`                   | string  | `latest`         | Set the Image tag Like (allowed values: latest, dev, hotfix)    |
 
-```shell
-azd env set AZURE_ENV_CU_LOCATION 'swedencentral'
-```
-
-Change the Model Deployment Type (allowed values: Standard, GlobalStandard)
+---
 
-```shell
-azd env set AZURE_ENV_MODEL_DEPLOYMENT_TYPE Standard
-```
+## How to Set a Parameter
 
-Set the Model Name (allowed values: gpt-4o)
+To customize any of the above values, run the following command **before** `azd up`:
 
-```shell
-azd env set AZURE_ENV_MODEL_NAME gpt-4o
+```bash
+azd env set <PARAMETER_NAME> <VALUE>
 ```
 
-Change the Model Capacity (choose a number based on available GPT model capacity in your subscription)
+**Example:**
 
-```shell
-azd env set AZURE_ENV_MODEL_CAPACITY 30
+```bash
+azd env set AZURE_LOCATION westus2
 ```
-

infra/main.bicep

@@ -31,24 +31,41 @@ var safePrefix = length(Prefix) > 20 ? substring(Prefix, 0, 20) : Prefix
 ])
 @description('Location for all Ai services resources. This location can be different from the resource group location.')
 param AzureAiServiceLocation string  // The location used for all deployed resources.  This location must be in the same region as the resource group.
+
+@minValue(5)
+@description('Capacity of the GPT deployment:')
 param capacity int = 5
 
+@minLength(1)
+@description('GPT model deployment type:')
+param deploymentType string = 'GlobalStandard'
+
+@minLength(1)
+@description('Name of the GPT model to deploy:')
+param llmModel string = 'gpt-4o'
+
+@minLength(1)
+@description('Set the Image tag:')
+param imageVersion string = 'latest'
+
+@minLength(1)
+@description('Version of the GPT model to deploy:')
+param gptModelVersion string = '2024-08-06'
+
+
+
 var uniqueId = toLower(uniqueString(subscription().id, safePrefix, resourceGroup().location))
 var UniquePrefix = 'cm${padLeft(take(uniqueId, 12), 12, '0')}'
 var ResourcePrefix = take('cm${safePrefix}${UniquePrefix}', 15)
-var imageVersion = 'latest'
 var location  = resourceGroup().location
 var dblocation  = resourceGroup().location
 var cosmosdbDatabase  = 'cmsadb'
 var cosmosdbBatchContainer  = 'cmsabatch'
 var cosmosdbFileContainer  = 'cmsafile'
 var cosmosdbLogContainer  = 'cmsalog'
-var deploymentType  = 'GlobalStandard'
 var containerName  = 'appstorage'
-var llmModel  = 'gpt-4o'
 var storageSkuName = 'Standard_LRS'
 var storageContainerName = replace(replace(replace(replace('${ResourcePrefix}cast', '-', ''), '_', ''), '.', ''),'/', '')
-var gptModelVersion = '2024-08-06'
 var azureAiServicesName = '${abbrs.ai.aiServices}${ResourcePrefix}'
 
 

infra/main.bicepparam

@@ -1,4 +1,9 @@
 using './main.bicep'
 
-param AzureAiServiceLocation = readEnvironmentVariable('AZURE_LOCATION','japaneast')
 param Prefix = readEnvironmentVariable('AZURE_ENV_NAME','azdtemp')
+param AzureAiServiceLocation = readEnvironmentVariable('AZURE_LOCATION','japaneast')
+param capacity = int(readEnvironmentVariable('AZURE_ENV_MODEL_CAPACITY', '200'))
+param deploymentType = readEnvironmentVariable('AZURE_ENV_MODEL_DEPLOYMENT_TYPE', 'GlobalStandard')
+param llmModel = readEnvironmentVariable('AZURE_ENV_MODEL_NAME', 'gpt-4o')
+param gptModelVersion = readEnvironmentVariable('AZURE_ENV_MODEL_VERSION', '2024-08-06')
+param imageVersion = readEnvironmentVariable('AZURE_ENV_IMAGETAG', 'latest')