managed, workload, and entraFederated are only available on hybrid deployments. entraFederated requires Node.js runtime.API key
The default mode. Provide the Azure resource’s API key along with the resource name, deployment, and API version.Entra ID (service principal)
Exchange a client ID + secret for an Entra access token. Tokens are cached for 15 minutes.azureEntraScope to override the default scope (https://cognitiveservices.azure.com/.default).
Managed identity
Use the Azure IMDS endpoint to get a token for the identity attached to the host.azureManagedClientId is only required when the host has multiple user-assigned identities. Omit it to use the system-assigned identity.
Workload identity (AKS)
Federates an AKS service-account token into an Entra access token. Requires these environment variables on the gateway pod — typically injected automatically by the Azure Workload Identity mutating webhook:Workload identity is supported on both Azure OpenAI and Azure AI Foundry integrations. The management-plane schema for
workload mode (and entraFederated for Azure AI Foundry) requires Backend v1.16.0+.AWS federated (Entra ID)
Exchanges an AWS STS web-identity token for an Entra access token — enabling keyless Azure access from workloads running on AWS (e.g. EKS with IRSA, or any host with standard AWS credentials). The gateway callssts:GetWebIdentityToken with audience api://AzureADTokenExchange, then exchanges that token at the Entra token endpoint. On the Azure side, register a federated credential on your app registration with:
- Issuer:
https://sts.<region>.amazonaws.com - Subject: the AWS principal (role ARN) assumed by the gateway
- Audience:
api://AzureADTokenExchange
AWS_ROLE_ARN + AWS_WEB_IDENTITY_TOKEN_FILE, instance profile, or static creds).
