Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 20 additions & 27 deletions docs/CustomizingAzdParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,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 <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

Set the Environment Name Prefix
```shell
azd env set AZURE_ENV_NAME 'cps'
```
| Name | Type | Example Value | Purpose |
| -------------------------------------- | ------- | --------------------------- | ------------------------------------------------------------------------------------- |
| `AZURE_ENV_NAME` | string | `cps` | Sets the environment name prefix for all Azure resources. |
| `AZURE_ENV_SECONDARY_LOCATION` | string | `eastus2` | Specifies a secondary Azure region. |
| `AZURE_ENV_CU_LOCATION` | string | `WestUS` | Sets the location for the Azure Content Understanding service. |
| `AZURE_ENV_MODEL_DEPLOYMENT_TYPE` | string | `GlobalStandard` | Defines the model deployment type (allowed values: `Standard`, `GlobalStandard`). |
| `AZURE_ENV_MODEL_NAME` | string | `gpt-4o` | Specifies the GPT model name (allowed values: `gpt-4o`).
| `AZURE_ENV_MODEL_VERSION` | string | `2024-08-06` | Specifies the GPT model version (allowed values: `2024-08-06`). |
| `AZURE_ENV_MODEL_CAPACITY` | integer | `30` | Sets the model capacity (choose based on your subscription's available GPT capacity). |
| `USE_LOCAL_BUILD` | boolean | `false` | Indicates whether to use a local container build for deployment. |
| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string | `<Existing Workspace Id>` | Reuses an existing Log Analytics Workspace instead of provisioning a new one. |

Change the Azure Content Understanding Service Location (example: eastus2, westus2, etc.)
```shell
azd env set AZURE_ENV_CU_LOCATION 'West US'
```

Change the Deployment Type (allowed values: Standard, GlobalStandard)
```shell
azd env set AZURE_ENV_MODEL_DEPLOYMENT_TYPE 'GlobalStandard'
```
## How to Set a Parameter

Set the Model Name (allowed values: gpt-4o)
```shell
azd env set AZURE_ENV_MODEL_NAME 'gpt-4o'
```
To customize any of the above values, run the following command **before** `azd up`:

Change the Model Capacity (choose a number based on available GPT model capacity in your subscription)
```shell
azd env set AZURE_ENV_MODEL_CAPACITY '30'
```bash
azd env set <PARAMETER_NAME> <VALUE>
```

Change if the deployment should use a local build of the containers
```shell
azd env set USE_LOCAL_BUILD 'false'
```
**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
```
4 changes: 4 additions & 0 deletions docs/DeploymentGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ This will allow the scripts to run for the current session without permanently c

<br/>

### **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.
Expand Down
1 change: 1 addition & 0 deletions infra/main.bicepparam
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using './main.bicep'

param environmentName = readEnvironmentVariable('AZURE_ENV_NAME', 'cps')
param secondaryLocation = readEnvironmentVariable('AZURE_ENV_SECONDARY_LOCATION', 'EastUs2')
param contentUnderstandingLocation = readEnvironmentVariable('AZURE_ENV_CU_LOCATION', 'WestUS')
param deploymentType = readEnvironmentVariable('AZURE_ENV_MODEL_DEPLOYMENT_TYPE', 'GlobalStandard')
param gptModelName = readEnvironmentVariable('AZURE_ENV_MODEL_NAME', 'gpt-4o')
Expand Down
Loading