Azure OpenAI Connection
Overview
The Azure OpenAI connection allows IB-X Agents to connect to Azure OpenAI Service and use OpenAI models deployed in your Azure environment.
Use this connection when your organization manages its OpenAI model deployments through Azure and wants IB-X to access those models using the Azure OpenAI endpoint and credentials.
The connection uses the Azure OpenAI resource information provided by your Azure environment, including:
- Endpoint URL
- API Key
- API Version
The required Azure OpenAI resource and model deployments must already be configured in Azure before creating the connection in IB-X.
Prerequisites
Before creating an Azure OpenAI connection in IB-X:
- Create or identify the Azure OpenAI resource that IB-X will use.
- Deploy the required OpenAI models in the Azure environment.
- Obtain the Endpoint URL for the Azure OpenAI resource.
- Obtain an API Key that can access the resource.
- Identify the API Version supported by the Azure OpenAI APIs and capabilities you intend to use.
Unlike the direct OpenAI service, Azure OpenAI requires the models you intend to use to be available through your Azure environment.
Ensure that the required model deployments are available before configuring IB-X activities to use this connection.
Connection Properties
Configure the following properties when creating an Azure OpenAI connection.
| Property | Required | Description |
|---|---|---|
| Name | Yes | Unique name used to identify the Azure OpenAI connection in IB-X. |
| Description | No | Optional description of the connection and its intended usage. |
| Endpoint URL | Yes | Endpoint URL of the Azure OpenAI resource that IB-X connects to. |
| API Key | Yes | API key used to authenticate IB-X requests to the Azure OpenAI resource. |
| API Version | No | Azure OpenAI API version used when sending requests to the configured endpoint. |
Endpoint URL
Specify the endpoint of the Azure OpenAI resource.
An Azure OpenAI endpoint typically follows a resource-specific format such as:
https://<resource-name>.openai.azure.com/
Use the endpoint provided for your Azure OpenAI resource.
Enter the Azure OpenAI resource endpoint, not the URL of an individual model deployment.
The model or deployment to use is selected by the IB-X activity that uses this connection.
API Key
Specify the API key associated with the Azure OpenAI resource.
IB-X uses this key to authenticate requests sent to the configured Azure OpenAI endpoint.
The API key can be obtained from the corresponding Azure OpenAI resource in Azure.
The API Key is a sensitive credential.
Do not expose the API key in documentation, screenshots, source code, or other unsecured locations. Manage and rotate the key according to your organization's security policies.
API Version
Specify the Azure OpenAI API version that IB-X should use when communicating with the configured Azure OpenAI resource.
For example:
2025-03-01-preview
The API version determines the Azure OpenAI API contract and capabilities available to IB-X.
Use an API version that is supported by Azure OpenAI and by the models and capabilities you intend to use.
Azure may introduce new API versions and retire older preview versions over time. Review the Azure OpenAI documentation before changing this value.
Model Deployments
Azure OpenAI models must be available in your Azure environment before they can be used by IB-X.
The Azure OpenAI connection identifies the Azure resource and authentication information, while the IB-X activity determines which available model or deployment is used for a particular operation.
For example, your Azure environment may contain deployments for different models based on the AI capabilities required by your Agents.
Having a valid Azure OpenAI connection does not by itself make every OpenAI model available.
The required model must be available through the configured Azure OpenAI environment before it can be used by an IB-X Agent.
Testing the Connection
After providing the required Azure OpenAI connection properties, click Test Connection to verify that IB-X can communicate with the configured Azure OpenAI resource.
A successful test confirms that:
- The Endpoint URL is reachable.
- The API Key can authenticate with the Azure OpenAI resource.
- The configured API Version can be used by the connection.
If the connection test fails, verify:
- The Endpoint URL is correct.
- The API Key is valid.
- The API Version is supported.
- Network access to the Azure OpenAI endpoint is available.
- The Azure OpenAI resource is active and accessible.
A successful connection test verifies connectivity and authentication to the Azure OpenAI resource. Individual model operations can still fail if the required model deployment is unavailable or does not support the requested capability.
Used By
The Azure OpenAI connection can be used by IB-X AI activities that support Azure OpenAI as an AI provider.
When configuring a supported activity:
- Select Azure OpenAI as the provider, where applicable.
- Select the required Azure OpenAI connection.
- Select or configure the model required by the activity.
- Configure the remaining model and activity properties.
The models and capabilities available to an activity depend on the models available through the configured Azure OpenAI environment.
Troubleshooting
The following issues typically indicate problems with the Azure OpenAI connection or Azure configuration:
| Issue | Possible Cause |
|---|---|
| Authentication failed | Verify that the API Key is correct and belongs to the configured Azure OpenAI resource. |
| Endpoint cannot be reached | Verify the Endpoint URL and network connectivity to the Azure OpenAI resource. |
| API version error | Verify that the configured API Version is supported by the Azure OpenAI service and required operation. |
| Model not available | Verify that the required model is available in the configured Azure environment. |
| Request rejected by Azure | Verify the model availability, API version, Azure resource configuration, and access permissions. |
When troubleshooting an Azure OpenAI connection, verify the configuration in this order:
Endpoint URL → API Key → API Version → Model availability
This helps distinguish connection and authentication problems from model-specific configuration problems.
Security Considerations
When configuring an Azure OpenAI connection:
- Protect the API Key from unauthorized access.
- Use credentials associated with the intended Azure OpenAI resource.
- Do not expose API keys in Agent instructions, source code, documentation, or screenshots.
- Rotate API keys according to your organization's security policies.
- Ensure that access to the Azure OpenAI resource is restricted according to your organization's Azure security requirements.
- Use only the Azure OpenAI resources and model deployments required by your IB-X Agents.
Additional Resources
For information about creating, editing, testing, cloning, deleting, and auditing connections, see Connections.