Skip to content

Commit 50d62b1

Browse files
diberrydiberry
committed
removing env var instructions and screenshots
1 parent caa31cc commit 50d62b1

File tree

3 files changed

+8
-61
lines changed

3 files changed

+8
-61
lines changed

‎articles/ai-services/openai/includes/assistants-env-var-key.md

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,9 @@ ms.custom: devex-track-js, devex-track-typescript
99
---
1010
|Variable name | Value |
1111
|--------------------------|-------------|
12-
| `ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. Alternatively, you can find the value in **Azure OpenAI Studio** > **Playground** > **View code**. An example endpoint is: `https://docs-test-001.openai.azure.com/`.|
13-
| `API-KEY` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.|
14-
| `DEPLOYMENT-NAME` | This value will correspond to the custom name you chose for your deployment when you deployed a model. This value can be found under **Resource Management** > **Model Deployments** in the Azure portal or alternatively under **Management** > **Deployments** in Azure OpenAI Studio.|
12+
| `AZURE_OPENAI_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. Alternatively, you can find the value in **Azure OpenAI Studio** > **Playground** > **View code**. An example endpoint is: `https://docs-test-001.openai.azure.com/`.|
13+
| `AZURE_OPENAI_API_KEY` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.|
14+
| `AZURE_OPENAI_DEPLOYMENT_NAME` | This value will correspond to the custom name you chose for your deployment when you deployed a model. This value can be found under **Resource Management** > **Model Deployments** in the Azure portal or alternatively under **Management** > **Deployments** in Azure OpenAI Studio.|
1515
| `OPENAI_API_VERSION`|Learn more about [API Versions](/azure/ai-services/openai/api-version-deprecation).|
1616

17-
Go to your resource in the Azure portal. The **Keys and Endpoint** can be found in the **Resource Management** section. Copy your endpoint and access key as you'll need both for authenticating your API calls. You can use either `KEY1` or `KEY2`. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption.
18-
19-
:::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview blade for an OpenAI Resource in the Azure portal with the endpoint & access keys location circled in red." lightbox="../media/quickstarts/endpoint.png":::
20-
21-
22-
# [Command Line](#tab/command-line)
23-
24-
```cmd
25-
setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE"
26-
setx AZURE_OPENAI_KEY "REPLACE_WITH_YOUR_API_KEY_HERE"
27-
setx AZURE_OPENAI_DEPLOYMENT_NAME "REPLACE_WITH_YOUR_DEPLOYMENT_NAME"
28-
setx OPENAI_API_VERSION "REPLACE_WITH_YOUR_API_VERSION"
29-
```
30-
31-
# [PowerShell](#tab/powershell)
32-
33-
```powershell
34-
[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')
35-
[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_KEY', 'REPLACE_WITH_YOUR_API_KEY_HERE', 'User')
36-
[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_DEPLOYMENT_NAME', 'REPLACE_WITH_YOUR_DEPLOYMENT_NAME', 'User')
37-
[System.Environment]::SetEnvironmentVariable('OPENAI_API_VERSION', 'REPLACE_WITH_YOUR_API_VERSION', 'User')
38-
```
39-
40-
# [Bash](#tab/bash)
41-
42-
```bash
43-
export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE"
44-
export AZURE_OPENAI_KEY="REPLACE_WITH_YOUR_API_KEY_HERE"
45-
export AZURE_OPENAI_DEPLOYMENT_NAME="REPLACE_WITH_YOUR_DEPLOYMENT_NAME"
46-
export OPENAI_API_VERSION="REPLACE_WITH_YOUR_API_VERSION"
47-
```
17+
Learn more about [finding API keys](/azure/ai-services/cognitive-services-environment-variables) and [setting environment variables](/azure/ai-services/cognitive-services-environment-variables).

‎articles/ai-services/openai/includes/assistants-env-var-without-key.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,8 @@ ms.custom: devex-track-js, devex-track-typescript
99
---
1010
|Variable name | Value |
1111
|--------------------------|-------------|
12-
| `ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. Alternatively, you can find the value in **Azure OpenAI Studio** > **Playground** > **View code**. An example endpoint is: `https://docs-test-001.openai.azure.com/`.|
13-
| `DEPLOYMENT-NAME` | This value will correspond to the custom name you chose for your deployment when you deployed a model. This value can be found under **Resource Management** > **Model Deployments** in the Azure portal or alternatively under **Management** > **Deployments** in Azure OpenAI Studio.|
12+
| `AZURE_OPENAI_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. Alternatively, you can find the value in **Azure OpenAI Studio** > **Playground** > **View code**. An example endpoint is: `https://docs-test-001.openai.azure.com/`.|
13+
| `AZURE_OPENAI_DEPLOYMENT_NAME` | This value will correspond to the custom name you chose for your deployment when you deployed a model. This value can be found under **Resource Management** > **Model Deployments** in the Azure portal or alternatively under **Management** > **Deployments** in Azure OpenAI Studio.|
1414
| `OPENAI_API_VERSION`|Learn more about [API Versions](/azure/ai-services/openai/api-version-deprecation).|
1515

16-
# [Command Line](#tab/command-line)
17-
18-
```cmd
19-
setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE"
20-
setx AZURE_OPENAI_DEPLOYMENT_NAME "REPLACE_WITH_YOUR_DEPLOYMENT_NAME"
21-
setx OPENAI_API_VERSION "REPLACE_WITH_YOUR_API_VERSION"
22-
```
23-
24-
# [PowerShell](#tab/powershell)
25-
26-
```powershell
27-
[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')
28-
[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_DEPLOYMENT_NAME', 'REPLACE_WITH_YOUR_DEPLOYMENT_NAME', 'User')
29-
[System.Environment]::SetEnvironmentVariable('OPENAI_API_VERSION', 'REPLACE_WITH_YOUR_API_VERSION', 'User')
30-
```
31-
32-
# [Bash](#tab/bash)
33-
34-
```bash
35-
export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE"
36-
export AZURE_OPENAI_DEPLOYMENT_NAME="REPLACE_WITH_YOUR_DEPLOYMENT_NAME"
37-
export OPENAI_API_VERSION="REPLACE_WITH_YOUR_API_VERSION"
38-
```
39-
16+
Learn more about [keyless authentication](/azure/ai-services/authentication) and [setting environment variables](/azure/ai-services/cognitive-services-environment-variables).

‎articles/ai-services/openai/includes/assistants-javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ To successfully make a call against the Azure OpenAI service, set environment va
9191
---
9292
9393
> [!CAUTION]
94-
> Don't set `AZURE_OPENAI_KEY` when using keyless authentication.
94+
> Don't set `AZURE_OPENAI_API_KEY` when using keyless authentication.
9595

9696

9797
## Create an assistant

0 commit comments

Comments
 (0)