retrieve resource info for JS and TS

eric-urban · eric-urban · commit e296bb4a36ca · 2025-01-07T07:11:55.000-08:00
diff --git a/articles/ai-services/openai/includes/assistants-javascript.md b/articles/ai-services/openai/includes/assistants-javascript.md
@@ -67,16 +67,7 @@ For _keyless_ authentication, you need to
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.md)]
 
 > [!CAUTION]
 > To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
diff --git a/articles/ai-services/openai/includes/assistants-typescript.md b/articles/ai-services/openai/includes/assistants-typescript.md
@@ -66,23 +66,14 @@ For passwordless authentication, you need to
     ```
 
 
-## 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)]
+## Retrieve resource information
 
----
+[!INCLUDE [resource authentication](resource-auth.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 an assistant
 
 In our code we're going to specify the following values:
diff --git a/articles/ai-services/openai/includes/chatgpt-javascript.md b/articles/ai-services/openai/includes/chatgpt-javascript.md
@@ -24,18 +24,10 @@ 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).
 
 
-## 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)]
+## Retrieve resource information
 
----
+[!INCLUDE [resource authentication](resource-auth.md)]
 
 > [!CAUTION]
 > To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
diff --git a/articles/ai-services/openai/includes/chatgpt-typescript.md b/articles/ai-services/openai/includes/chatgpt-typescript.md
@@ -28,21 +28,11 @@ ms.date: 10/22
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.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
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it. 
diff --git a/articles/ai-services/openai/includes/dall-e-javascript.md b/articles/ai-services/openai/includes/dall-e-javascript.md
@@ -24,19 +24,9 @@ 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).
 
 
-
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.md)]
 
 > [!CAUTION]
 > To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
diff --git a/articles/ai-services/openai/includes/dall-e-typescript.md b/articles/ai-services/openai/includes/dall-e-typescript.md
@@ -25,25 +25,13 @@ 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).
 
 
-
-
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.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
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it. Then run the `npm init` command to create a node application with a _package.json_ file.
diff --git a/articles/ai-services/openai/includes/env-var-without-key.md b/articles/ai-services/openai/includes/env-var-without-key.md
diff --git a/articles/ai-services/openai/includes/gpt-v-javascript.md b/articles/ai-services/openai/includes/gpt-v-javascript.md
@@ -31,22 +31,11 @@ This SDK is provided by OpenAI with Azure specific types provided by Azure.
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.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
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it. Then run the `npm init` command to create a node application with a _package.json_ file.
diff --git a/articles/ai-services/openai/includes/gpt-v-typescript.md b/articles/ai-services/openai/includes/gpt-v-typescript.md
@@ -31,22 +31,11 @@ This SDK is provided by OpenAI with Azure specific types provided by Azure.
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.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
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it. Then run the `npm init` command to create a node application with a _package.json_ file.
diff --git a/articles/ai-services/openai/includes/javascript.md b/articles/ai-services/openai/includes/javascript.md
@@ -24,18 +24,17 @@ ms.date: 10/22/2024
 - [Azure CLI](/cli/azure/install-azure-cli) used for passwordless authentication in a local development environment, create the necessary context by signing in with the Azure CLI.
 - An Azure OpenAI Service resource with the `gpt-35-turbo-instruct` model deployed. For more information about model deployment, see the [resource deployment guide](../how-to/create-resource.md).
 
+## Retrieve resource information
 
+[!INCLUDE [resource authentication](resource-auth.md)]
 
-## Set up
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
-
-[!INCLUDE [environment-variables](environment-variables.md)]
+## Install the client library
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it.
 
-## Install the client library
-
 Install the required packages for JavaScript with npm from within the context of your new directory:
 
 ```console
diff --git a/articles/ai-services/openai/includes/realtime-javascript.md b/articles/ai-services/openai/includes/realtime-javascript.md
@@ -59,16 +59,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.md)]
 
 > [!CAUTION]
 > To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
diff --git a/articles/ai-services/openai/includes/realtime-typescript.md b/articles/ai-services/openai/includes/realtime-typescript.md
@@ -60,16 +60,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.md)]
 
 > [!CAUTION]
 > To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
diff --git a/articles/ai-services/openai/includes/resource-auth.md b/articles/ai-services/openai/includes/resource-auth.md
@@ -3,9 +3,21 @@ author: eric-urban
 ms.author: eur 
 ms.service: azure-ai-openai
 ms.topic: include
-ms.date: 12/27/2024
+ms.date: 1/7/2025
 ---
 
+#### [Microsoft Entra ID](#tab/keyless)
+
+|Variable name | Value |
+|--------------------------|-------------|
+| `AZURE_OPENAI_ENDPOINT`               | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
+| `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.|
+| `OPENAI_API_VERSION`|Learn more about [API Versions](/azure/ai-services/openai/api-version-deprecation).|
+
+Learn more about [keyless authentication](/azure/ai-services/authentication) and [setting environment variables](/azure/ai-services/cognitive-services-environment-variables).
+
+#### [API key](#tab/api-key)
+
 |Variable name | Value |
 |--------------------------|-------------|
 | `AZURE_OPENAI_ENDPOINT`               | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
@@ -15,4 +27,9 @@ ms.date: 12/27/2024
 
 Learn more about [finding API keys](/azure/ai-services/cognitive-services-environment-variables) and [setting environment variables](/azure/ai-services/cognitive-services-environment-variables).
 
-[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
+---
+
+
+
diff --git a/articles/ai-services/openai/includes/text-to-speech-javascript.md b/articles/ai-services/openai/includes/text-to-speech-javascript.md
@@ -22,21 +22,11 @@ recommendations: false
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.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
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it. Then run the `npm init` command to create a node application with a _package.json_ file.
diff --git a/articles/ai-services/openai/includes/text-to-speech-typescript.md b/articles/ai-services/openai/includes/text-to-speech-typescript.md
@@ -20,24 +20,13 @@ recommendations: false
 - [Azure CLI](/cli/azure/install-azure-cli) used for passwordless authentication in a local development environment, create the necessary context by signing in with the Azure CLI.
 - 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).
 
-
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.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
 
 In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it. Then run the `npm init` command to create a node application with a _package.json_ file.
diff --git a/articles/ai-services/openai/includes/typescript.md b/articles/ai-services/openai/includes/typescript.md
@@ -24,16 +24,18 @@ ms.date: 10/22/2024
 - [Azure CLI](/cli/azure/install-azure-cli) used for passwordless authentication in a local development environment, create the necessary context by signing in with the Azure CLI.
 - An Azure OpenAI Service resource with the `gpt-35-turbo-instruct` model deployed. For more information about model deployment, see the [resource deployment guide](../how-to/create-resource.md).
 
-## Set up
 
-[!INCLUDE [get-key-endpoint](get-key-endpoint.md)]
+## Retrieve resource information
 
-[!INCLUDE [environment-variables](environment-variables.md)]
+[!INCLUDE [resource authentication](resource-auth.md)]
 
-In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it.
+> [!CAUTION]
+> To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
 
 ## Install the client library
 
+In a console window (such as cmd, PowerShell, or Bash), create a new directory for your app, and navigate to it.
+
 Install the required packages for JavaScript with npm from within the context of your new directory:
 
 ```console
diff --git a/articles/ai-services/openai/includes/whisper-javascript.md b/articles/ai-services/openai/includes/whisper-javascript.md
@@ -22,16 +22,7 @@ author: eric-urban
 
 ## 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)]
-
----
+[!INCLUDE [resource authentication](resource-auth.md)]
 
 > [!CAUTION]
 > To use the recommended keyless authentication with the SDK, make sure that the `AZURE_OPENAI_API_KEY` environment variable isn't set. 
diff --git a/articles/ai-services/openai/includes/whisper-typescript.md b/articles/ai-services/openai/includes/whisper-typescript.md
