retrieve resource info for JS and TS

eric-urban · eric-urban · commit 5e7169abb325 · 2025-01-06T18:31:25.000-08:00
diff --git a/articles/ai-services/openai/includes/assistants-env-var-key.md b/articles/ai-services/openai/includes/assistants-env-var-key.md
diff --git a/articles/ai-services/openai/includes/assistants-env-var-without-key.md b/articles/ai-services/openai/includes/assistants-env-var-without-key.md
diff --git a/articles/ai-services/openai/includes/assistants-javascript.md b/articles/ai-services/openai/includes/assistants-javascript.md
@@ -64,16 +64,17 @@ For _keyless_ authentication, you need to
     npm install @azure/identity
     ```
 
+
 ## Retrieve resource information
 
-#### [Microsoft Entra ID](#tab/javascript-keyless)
+#### [Microsoft Entra ID](#tab/keyless)
 
-[!INCLUDE [assistants-keyless-environment-variables](assistants-env-var-without-key.md)]
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
 
 
-#### [API key](#tab/javascript-key)
+#### [API key](#tab/api-key)
 
-[!INCLUDE [assistants-key-environment-variables](assistants-env-var-key.md)]
+[!INCLUDE [key-environment-variables](env-var-key.md)]
 
 ---
 
@@ -98,7 +99,7 @@ An individual assistant can access up to 128 tools including `code interpreter`,
     
 ## Create a new JavaScript application
 
-#### [Microsoft Entra ID](#tab/javascript-keyless)
+#### [Microsoft Entra ID](#tab/keyless)
 
 1. Create the `index.js` file with the following code:
 
@@ -205,7 +206,7 @@ An individual assistant can access up to 128 tools including `code interpreter`,
 
 
 
-#### [API key](#tab/javascript-key)
+#### [API key](#tab/api-key)
 
 1. Create the `index.js` file with the following code:
 
diff --git a/articles/ai-services/openai/includes/assistants-typescript.md b/articles/ai-services/openai/includes/assistants-typescript.md
@@ -65,17 +65,17 @@ For passwordless authentication, you need to
     npm install @azure/identity
     ```
 
-## Retrieve resource information
 
+## Retrieve resource information
 
-#### [Microsoft Entra ID](#tab/typescript-keyless)
+#### [Microsoft Entra ID](#tab/keyless)
 
-[!INCLUDE [assistants-keyless-environment-variables](assistants-env-var-without-key.md)]
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
 
 
-#### [API key](#tab/typescript-key)
+#### [API key](#tab/api-key)
 
-[!INCLUDE [assistants-key-environment-variables](assistants-env-var-key.md)]
+[!INCLUDE [key-environment-variables](env-var-key.md)]
 
 ---
 
diff --git a/articles/ai-services/openai/includes/chatgpt-javascript.md b/articles/ai-services/openai/includes/chatgpt-javascript.md
@@ -24,11 +24,22 @@ ms.date: 10/22
 - An Azure OpenAI Service resource with either a `gpt-35-turbo` or `gpt-4` series models deployed. For more information about model deployment, see the [resource deployment guide](../how-to/create-resource.md).
 
 
-## Set up
+## Retrieve resource information
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
+#### [Microsoft Entra ID](#tab/keyless)
+
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
+
+
+#### [API key](#tab/api-key)
+
+[!INCLUDE [key-environment-variables](env-var-key.md)]
+
+---
+
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
 
-[!INCLUDE [environment-variables](environment-variables.md)]
 
 ## Create a Node application
 
diff --git a/articles/ai-services/openai/includes/chatgpt-typescript.md b/articles/ai-services/openai/includes/chatgpt-typescript.md
@@ -26,12 +26,22 @@ ms.date: 10/22
 - An Azure OpenAI Service resource with a `gpt-35-turbo` or `gpt-4` series models deployed. For more information about model deployment, see the [resource deployment guide](../how-to/create-resource.md).
 
 
+## Retrieve resource information
 
-## Set up
+#### [Microsoft Entra ID](#tab/keyless)
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
+
+
+#### [API key](#tab/api-key)
+
+[!INCLUDE [key-environment-variables](env-var-key.md)]
+
+---
+
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
 
-[!INCLUDE [environment-variables](environment-variables.md)]
 
 ## Create a Node application
 
diff --git a/articles/ai-services/openai/includes/dall-e-javascript.md b/articles/ai-services/openai/includes/dall-e-javascript.md
@@ -24,12 +24,22 @@ Use this guide to get started generating images with the Azure OpenAI SDK for Ja
 - An Azure OpenAI resource created in a supported region (see [Region availability](/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability)). For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md).
 
 
-## Setup
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
+## Retrieve resource information
 
-[!INCLUDE [environment-variables](environment-variables.md)]
+#### [Microsoft Entra ID](#tab/keyless)
 
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
+
+
+#### [API key](#tab/api-key)
+
+[!INCLUDE [key-environment-variables](env-var-key.md)]
+
+---
+
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
 
 ## Create a Node application
 
diff --git a/articles/ai-services/openai/includes/dall-e-typescript.md b/articles/ai-services/openai/includes/dall-e-typescript.md
@@ -26,11 +26,22 @@ Use this guide to get started generating images with the Azure OpenAI SDK for Ja
 
 
 
-## Setup
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
+## Retrieve resource information
 
-[!INCLUDE [environment-variables](environment-variables.md)]
+#### [Microsoft Entra ID](#tab/keyless)
+
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
+
+
+#### [API key](#tab/api-key)
+
+[!INCLUDE [key-environment-variables](env-var-key.md)]
+
+---
+
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
 
 
 ## Create a Node application
diff --git a/articles/ai-services/openai/includes/gpt-v-javascript.md b/articles/ai-services/openai/includes/gpt-v-javascript.md
@@ -25,13 +25,26 @@ This SDK is provided by OpenAI with Azure specific types provided by Azure.
 
 ---
 
-
 > [!NOTE]
 > This library is maintained by OpenAI. Refer to the [release history](https://github.com/openai/openai-node/releases) to track the latest updates to the library.
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
 
-[!INCLUDE [environment-variables](environment-variables.md)]
+## Retrieve resource information
+
+#### [Microsoft Entra ID](#tab/keyless)
+
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
+
+
+#### [API key](#tab/api-key)
+
+[!INCLUDE [key-environment-variables](env-var-key.md)]
+
+---
+
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
+
 
 
 ## Create a Node application
diff --git a/articles/ai-services/openai/includes/gpt-v-typescript.md b/articles/ai-services/openai/includes/gpt-v-typescript.md
@@ -28,9 +28,23 @@ This SDK is provided by OpenAI with Azure specific types provided by Azure.
 > [!NOTE]
 > This library is maintained by OpenAI. Refer to the [release history](https://github.com/openai/openai-node/releases) to track the latest updates to the library.
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
 
-[!INCLUDE [environment-variables](environment-variables.md)]
+## Retrieve resource information
+
+#### [Microsoft Entra ID](#tab/keyless)
+
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
+
+
+#### [API key](#tab/api-key)
+
+[!INCLUDE [key-environment-variables](env-var-key.md)]
+
+---
+
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
+
 
 
 ## Create a Node application
diff --git a/articles/ai-services/openai/includes/realtime-javascript.md b/articles/ai-services/openai/includes/realtime-javascript.md
@@ -59,11 +59,12 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
 
 ## Retrieve resource information
 
-#### [Microsoft Entra ID](#tab/javascript-keyless)
+#### [Microsoft Entra ID](#tab/keyless)
 
 [!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
 
-#### [API key](#tab/javascript-key)
+
+#### [API key](#tab/api-key)
 
 [!INCLUDE [key-environment-variables](env-var-key.md)]
 
@@ -74,7 +75,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
 
 ## Text in audio out
 
-#### [Microsoft Entra ID](#tab/javascript-keyless)
+#### [Microsoft Entra ID](#tab/keyless)
 
 1. Create the `text-in-audio-out.js` file with the following code:
 
@@ -143,7 +144,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
     ```
 
 
-#### [API key](#tab/javascript-key)
+#### [API key](#tab/api-key)
 
 1. Create the `text-in-audio-out.js` file with the following code:
 
diff --git a/articles/ai-services/openai/includes/realtime-typescript.md b/articles/ai-services/openai/includes/realtime-typescript.md
@@ -60,22 +60,23 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
 
 ## Retrieve resource information
 
-#### [Microsoft Entra ID](#tab/javascript-keyless)
+#### [Microsoft Entra ID](#tab/keyless)
 
 [!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
 
-#### [API key](#tab/javascript-key)
+
+#### [API key](#tab/api-key)
 
 [!INCLUDE [key-environment-variables](env-var-key.md)]
 
 ---
 
 > [!CAUTION]
 > To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
-    
+
 ## Text in audio out
 
-#### [Microsoft Entra ID](#tab/typescript-keyless)
+#### [Microsoft Entra ID](#tab/keyless)
 
 1. Create the `text-in-audio-out.ts` file with the following code:
 
@@ -170,7 +171,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
     node text-in-audio-out.js
     ```
 
-#### [API key](#tab/typescript-key)
+#### [API key](#tab/api-key)
 
 1. Create the `text-in-audio-out.ts` file with the following code:
 
diff --git a/articles/ai-services/openai/includes/text-to-speech-javascript.md b/articles/ai-services/openai/includes/text-to-speech-javascript.md
@@ -20,57 +20,22 @@ recommendations: false
 - An Azure OpenAI resource created in a supported region (see [Region availability](/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability)). For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md).
 
 
-## Set up
+## Retrieve resource information
 
-### Retrieve key and endpoint
+#### [Microsoft Entra ID](#tab/keyless)
 
-To successfully make a call against Azure OpenAI, you need an **endpoint** and a **key**.
+[!INCLUDE [keyless-environment-variables](env-var-without-key.md)]
 
-|Variable name | Value |
-|--------------------------|-------------|
-| `AZURE_OPENAI_ENDPOINT`               | The service endpoint can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. Alternatively, you can find the endpoint via the **Deployments** page in Azure AI Foundry portal. An example endpoint is: `https://docs-test-001.openai.azure.com/`.|
-| `AZURE_OPENAI_API_KEY` | This value can be found in the **Keys & Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.|
 
-Go to your resource in the Azure portal. The **Endpoint and Keys** can be found in the **Resource Management** section. Copy your endpoint and access key as you 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.
+#### [API key](#tab/api-key)
 
-:::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot of the overview UI for an Azure OpenAI resource in the Azure portal with the endpoint & access keys location highlighted." lightbox="../media/quickstarts/endpoint.png":::
+[!INCLUDE [key-environment-variables](env-var-key.md)]
 
-### Environment variables
-
-Create and assign persistent environment variables for your key and endpoint.
-
-[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
-
-# [Command Line](#tab/command-line)
-
-```CMD
-setx AZURE_OPENAI_API_KEY "REPLACE_WITH_YOUR_KEY_VALUE_HERE" 
-```
-
-```CMD
-setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE" 
-```
-
-# [PowerShell](#tab/powershell)
-
-```powershell
-[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_API_KEY', 'REPLACE_WITH_YOUR_KEY_VALUE_HERE', 'User')
-```
-
-```powershell
-[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')
-```
-
-# [Bash](#tab/bash)
+---
 
-```Bash
-echo export AZURE_OPENAI_API_KEY="REPLACE_WITH_YOUR_KEY_VALUE_HERE" >> /etc/environment && source /etc/environment
-```
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
 
-```Bash
-echo export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE" >> /etc/environment && source /etc/environment
-```
----
 
 ## Create a Node application
 
diff --git a/articles/ai-services/openai/includes/text-to-speech-typescript.md b/articles/ai-services/openai/includes/text-to-speech-typescript.md
diff --git a/articles/ai-services/openai/includes/whisper-javascript.md b/articles/ai-services/openai/includes/whisper-javascript.md
diff --git a/articles/ai-services/openai/includes/whisper-typescript.md b/articles/ai-services/openai/includes/whisper-typescript.md
