Articles in this section

Set up a connection to Microsoft Azure OpenAI

Microsoft Azure OpenAI service allows businesses and developers to integrate OpenAI’s language models that can be adapted to specific tasks including content generation, summarization, image understanding, semantic search, natural language to code, and more.

Set up a connection

Note

For users wanting to connect to Microsoft Copilot, see Set up a connection to Microsoft Copilot.

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting Instructions
Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

Subdomain * 

Enter your Azure OpenAI subdomain. For example, if your Azure OpenAI service endpoint URL is https://platform.openai.azure.com, then platform is your subdomain.

How to retrieve the subdomain 

Version *  Enter your Azure OpenAI service API version in YYYY-MM-DD format.
API key * 

Enter your Azure OpenAI API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

How to retrieve the API key 

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see token auth universal connector documentation.

How to retrieve the subdomain

  1. Sign in to your Azure portal.
  2. Search for Azure OpenAI service.
  3. Create an Azure OpenAI resource. For detailed information on how to create a resource, see Create a Resource.
  4. Navigate to Overview > Endpoint.
  5. Copy the Subdomain.

How to retrieve the API key

  1. Sign in to your Azure portal.
  2. Search for Azure OpenAI service.
  3. Create an Azure OpenAI resource. For detailed information on how to create a resource, see Create a Resource.
  4. Navigate to Resource management > Keys and endpoint.
  5. Copy the Key 1 (API key).

Set up a connection for the AI agent

After you start creating an AI agent and select Bring your own key (BYOK), select an existing connection or create a new one. If you create a new connection, complete all of the required * authentication settings described below:

Setting Instructions
Name your connection *

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

Azure Foundry resource endpoint * Enter your Azure Foundry resource endpoint. For example, if your resource is myresource, enter the endpoint in this format: https://myresource.services.ai.azure.com.
API key * Enter the Azure API key. For detailed information on retrieving the API key, see API keys.
Multiple layers of protection are in place, including AES-256 encryption, to keep your connection’s API key safe. When you edit this form later, you must enter this token again; it is stored only when the connection is saved and is never displayed as text.

Additional reference