Skip to content

Commit 48d06b9

Browse files
Added CustomizingAzdParamters readme file
1 parent 25ad76a commit 48d06b9

File tree

4 files changed

+54
-5
lines changed

4 files changed

+54
-5
lines changed

content-gen/docs/AZD_DEPLOYMENT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The deployment has sensible defaults, but you can customize:
8181
azd env set AZURE_LOCATION swedencentral
8282

8383
# Set AI Services region (must support your models)
84-
azd env set azureAiServiceLocation swedencentral
84+
azd env set AZURE_ENV_OPENAI_LOCATION swedencentral
8585

8686
# GPT Model configuration
8787
azd env set gptModelName gpt-4o
@@ -157,21 +157,21 @@ This single command will:
157157

158158
```bash
159159
# Set the resource ID of your existing AI Project
160-
azd env set azureExistingAIProjectResourceId "/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.MachineLearningServices/workspaces/<project-name>"
160+
azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID "/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.MachineLearningServices/workspaces/<project-name>"
161161
```
162162

163163
### Reuse Existing Log Analytics Workspace
164164

165165
```bash
166166
# Set the resource ID of your existing Log Analytics workspace
167-
azd env set existingLogAnalyticsWorkspaceId "/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.OperationalInsights/workspaces/<workspace-name>"
167+
azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID "/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.OperationalInsights/workspaces/<workspace-name>"
168168
```
169169

170170
### Use Existing Container Registry
171171

172172
```bash
173173
# Set the name of your existing ACR
174-
azd env set acrName myexistingacr
174+
azd env set ACR_NAME myexistingacr
175175
```
176176

177177
## Post-Deployment
@@ -312,7 +312,7 @@ Error: The model 'gpt-4o' is not available in region 'westeurope'
312312

313313
**Solution**: Set a different region for AI Services:
314314
```bash
315-
azd env set azureAiServiceLocation eastus
315+
azd env set AZURE_ENV_OPENAI_LOCATION eastus
316316
```
317317

318318
#### 3. Container Build Fails
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## [Optional]: Customizing resource names
2+
3+
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.
4+
5+
> 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-15 characters alphanumeric unique name.
6+
7+
## Parameters
8+
9+
| Name | Type | Default Value | Purpose |
10+
| -------------------------------------- | ------- | ---------------------------- | ----------------------------------------------------------------------------- |
11+
| `AZURE_LOCATION` | string | `<User selects during deployment>` | Sets the Azure region for resource deployment. Allowed: `australiaeast`, `centralus`, `eastasia`, `eastus`, `eastus2`, `japaneast`, `northeurope`, `southeastasia`, `swedencentral`, `uksouth`, `westus`, `westus3`. |
12+
| `AZURE_ENV_NAME` | string | `contentgen` | Sets the environment name prefix for all Azure resources (3-15 characters). |
13+
| `secondaryLocation` | string | `uksouth` | Specifies a secondary Azure region for database creation. |
14+
| `gptModelName` | string | `gpt-5.1` | Specifies the GPT model name to deploy. |
15+
| `gptModelVersion` | string | `2025-11-13` | Sets the GPT model version. |
16+
| `gptModelDeploymentType` | string | `GlobalStandard` | Defines the model deployment type (allowed: `Standard`, `GlobalStandard`). |
17+
| `gptModelCapacity` | integer | `150` | Sets the GPT model token capacity (minimum: `10`). |
18+
| `imageModelChoice` | string | `gpt-image-1` | Image model to deploy (allowed: `gpt-image-1`, `gpt-image-1.5`, `dall-e-3`, `none`). |
19+
| `dalleModelCapacity` | integer | `1` | Sets the image model deployment capacity in RPM (minimum: `1`). |
20+
| `azureOpenaiAPIVersion` | string | `2025-01-01-preview` | Specifies the API version for Azure OpenAI service. |
21+
| `AZURE_ENV_OPENAI_LOCATION` | string | `<User selects during deployment>` | Sets the Azure region for OpenAI resource deployment. |
22+
| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string | `""` | Reuses an existing Log Analytics Workspace instead of creating a new one. |
23+
| `AZURE_EXISTING_AI_PROJECT_RESOURCE_ID`| string | `""` | Reuses an existing AI Foundry Project instead of creating a new one. |
24+
| `ACR_NAME` | string | `contentgencontainerreg` | Sets the existing Azure Container Registry name (without `.azurecr.io`). |
25+
| `IMAGE_TAG` | string | `latest` | Sets the container image tag (e.g., `latest`, `dev`, `hotfix`). |
26+
27+
## How to Set a Parameter
28+
29+
To customize any of the above values, run the following command **before** `azd up`:
30+
31+
```bash
32+
azd env set <PARAMETER_NAME> <VALUE>
33+
```
34+
35+
**Examples:**
36+
37+
```bash
38+
azd env set AZURE_LOCATION westus2
39+
azd env set gptModelName gpt-5.1
40+
azd env set gptModelDeploymentType Standard
41+
azd env set imageModelChoice dall-e-3
42+
azd env set ACR_NAME contentgencontainerreg
43+
```

content-gen/infra/main.parameters.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
"location": {
99
"value": "${AZURE_LOCATION}"
1010
},
11+
"secondaryLocation": {
12+
"value": "${secondaryLocation}"
13+
},
1114
"gptModelName": {
1215
"value": "${gptModelName}"
1316
},

content-gen/infra/main.waf.parameters.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
"location": {
99
"value": "${AZURE_LOCATION}"
1010
},
11+
"secondaryLocation": {
12+
"value": "${secondaryLocation}"
13+
},
1114
"gptModelName": {
1215
"value": "${gptModelName}"
1316
},

0 commit comments

Comments
 (0)