Skip to content

Commit 06a481e

Browse files
authored
Update Azure OpenAI deployment instructions (#419)
1 parent 5e32d7d commit 06a481e

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

docs/development/AzureOAIDeployment/DeployingAzureOAI.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ param customDomainName string = '<Insert own unique domain name>'
4343
param modeldeploymentname string = '<Insert own deployment name>'
4444
4545
@description('The model being deployed')
46-
param model string = 'gpt-4'
46+
param model string = 'gpt-4o'
4747
4848
@description('Version of the model being deployed')
49-
param modelversion string = 'turbo-2024-04-09'
49+
param modelversion string = '2024-11-20'
5050
5151
@description('Capacity for specific model used')
5252
param capacity int = 80
@@ -60,8 +60,13 @@ param location string = resourceGroup().location
6060
param sku string = 'S0'
6161
```
6262

63+
> **Note:** The `customDomainName` parameter is not a full domain URL. It's a unique subdomain prefix
64+
> that Azure will use to create your OpenAI endpoint. For example, if you set `customDomainName` to
65+
> `mycompany-openai`, your endpoint will be `https://mycompany-openai.openai.azure.com/`. This name
66+
> must be globally unique across all Azure OpenAI services.
67+
6368
The above is defaulted to use your resource groups location as the location for the account and
64-
`gpt-4` version `turbo-2024-04-09`. You can modify this based on the particular model you feel best
69+
`gpt-4o` version `2024-11-20`. You can modify this based on the particular model you feel best
6570
fits your needs. You can find more information on available models at
6671
[Azure OpenAI Service models][03]. Additionally, you may need to modify the capacity of the
6772
deployment based on what model you use, you can find more information at
@@ -78,9 +83,9 @@ instance! Simply use either Azure CLI or Azure PowerShell to deploy the bicep fi
7883
az deployment group create --resource-group <resource group name> --template-file ./main.bicep
7984

8085
// Get the endpoint and key of the deployment
81-
az cognitiveservices account show --name <account name> --resource-group <resource group name> | jq -r .properties.endpoint
86+
az cognitiveservices account show --name <account name> --resource-group <resource group name> --query "properties.endpoint" -o tsv
8287

83-
az cognitiveservices account keys list --name <account name> --resource-group <resource group name> | jq -r .key1
88+
az cognitiveservices account keys list --name <account name> --resource-group <resource group name> --query "key1" -o tsv
8489
```
8590

8691
#### Using Azure PowerShell
@@ -105,18 +110,18 @@ example below shows the default system prompt and the fields that need to be upd
105110
// Declare GPT instances.
106111
"GPTs": [
107112
{
108-
"Name": "ps-az-gpt4",
113+
"Name": "ps-az-gpt4o",
109114
"Description": "<insert description here>",
110115
"Endpoint": "<insert endpoint here>",
111116
"Deployment": "<insert deployment name here>",
112-
"ModelName": "gpt-4",
117+
"ModelName": "gpt-4o",
113118
"Key": "<insert key here>",
114119
"SystemPrompt": "1. You are a helpful and friendly assistant with expertise in PowerShell scripting and command line.\n2. Assume user is using the operating system `osx` unless otherwise specified.\n3. Use the `code block` syntax in markdown to encapsulate any part in responses that is code, YAML, JSON or XML, but not table.\n4. When encapsulating command line code, use '```powershell' if it's PowerShell command; use '```sh' if it's non-PowerShell CLI command.\n5. When generating CLI commands, never ever break a command into multiple lines. Instead, always list all parameters and arguments of the command on the same line.\n6. Please keep the response concise but to the point. Do not overexplain."
115120
}
116121
],
117122
// Specify the default GPT instance to use for user query.
118123
// For example: "ps-az-gpt4"
119-
"Active": "ps-az-gpt4"
124+
"Active": "ps-az-gpt4o"
120125
}
121126
```
122127

docs/development/AzureOAIDeployment/main.bicep

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ param customDomainName string = '<Insert own unique domain name>'
88
param modeldeploymentname string = '<Insert own deployment name>'
99

1010
@description('The model being deployed')
11-
param model string = 'gpt-4'
11+
param model string = 'gpt-4o'
1212

1313
@description('Version of the model being deployed')
14-
param modelversion string = 'turbo-2024-04-09'
14+
param modelversion string = '2024-11-20'
1515

1616
@description('Capacity for specific model used')
1717
param capacity int = 80
@@ -24,7 +24,7 @@ param location string = resourceGroup().location
2424
])
2525
param sku string = 'S0'
2626

27-
resource openAIService 'Microsoft.CognitiveServices/accounts@2024-10-01' = {
27+
resource openAIService 'Microsoft.CognitiveServices/accounts@2025-10-01-preview' = {
2828
name: aiserviceaccountname
2929
location: location
3030
identity: {
@@ -39,7 +39,7 @@ resource openAIService 'Microsoft.CognitiveServices/accounts@2024-10-01' = {
3939
}
4040
}
4141

42-
resource azopenaideployment 'Microsoft.CognitiveServices/accounts/deployments@2024-10-01' = {
42+
resource azopenaideployment 'Microsoft.CognitiveServices/accounts/deployments@2025-10-01-preview' = {
4343
parent: openAIService
4444
name: modeldeploymentname
4545
properties: {

0 commit comments

Comments
 (0)