# Azure OpenAI

Run AI models deployed in Azure. Review required fields, credential setup and how this connector works in Zild.

Source: https://zild.ai/en-US/docs/apps/zild-admin/connector-azure-openai

Run AI models deployed in Azure.

## Where to configure

Open Zild Admin → Integrations → Connectors, find the provider and use Configure or Edit. Enter the data from this guide, enable the connector for the workflow and save.

## Required fields

These requirements are the data needed by the workflow using the connector. Generic saving may accept empty fields that are only required when an operation runs. Saving does not confirm that the provider accepts the credential.



<table class="api-params"><thead><tr><th>Field</th><th>Workflow requirement</th></tr></thead><tbody><tr><td><code>ApiKey</code></td><td>Provider API key.</td></tr><tr><td><code>Url</code></td><td>Azure OpenAI resource HTTPS endpoint.</td></tr><tr><td><code>AssistantId / modelo do agente</code></td><td>Deployment/model name used by the workflow; the agent model may override the connector default.</td></tr></tbody></table>



## How to obtain credentials

- In the Azure portal, create or open the resource for the matching service.
- Open Resource Management → Keys and Endpoint.
- Copy KEY1 or KEY2 into ApiKey and the endpoint from the same resource into Url when requested.
- In Microsoft Foundry, open deployments and copy the deployment name used by the agent. This name is not an API key.

## How it works in Zild

The implementation creates AzureOpenAIClient with Url and ApiKey and selects the deployment. AssistantId acts as a model default in workflows that read it.

## How to verify the configuration

After saving, use the matching workflow (query, agent, call or processing) to verify access. If it fails, check the credential, permissions and selected provider resource. For limited or legacy types, confirm availability with your administrator before use.

When editing, Zild displays protected credentials as asterisks. Preserve the masked value to keep the current credential or paste a new credential to replace it.

## Official documentation

- [Microsoft: resource keys and endpoints](https://learn.microsoft.com/en-us/azure/ai-services/authentication)

[Back to Connectors](/en-US/docs/apps/zild-admin/integration)