llm4s-docs/org.llm4s/org.llm4s.llmconnect/org.llm4s.llmconnect.provider/AzureProvider

AzureProvider

org.llm4s.llmconnect.provider.AzureProvider

@Stable

object AzureProvider extends ProviderDescriptor

Registration for Azure OpenAI deployments.

Azure reuses OpenAIClient but not OpenAIConfig: its endpoint is per-deployment and it requires an apiVersion, which AzureConfig carries.

Both are provider-specific keys of the section - endpoint (required) and apiVersion (default org.llm4s.llmconnect.config.AzureConfig.DEFAULT_API_VERSION) - rather than fields of NamedProviderConfig, which they were until #1133; the HOCON is unchanged:

azure-main {
 provider   = "azure"
 model      = "gpt-4o"
 endpoint   = "https://my-resource.openai.azure.com/"
 apiVersion = "2025-01-01-preview"
}

A resource that forbids keys authenticates with Microsoft Entra ID instead (#2274): authentication = "entra-id" takes tokens from Azure's DefaultAzureCredential - a managed identity, workload identity, the Azure CLI's login - through llm4s-azure-identity, which must then be on the classpath. Such a section takes no apiKey, its own or the shared AZURE_OPENAI_API_KEY; clientId picks a user-assigned managed identity:

azure-prod {
 provider       = "azure"
 model          = "gpt-4o"
 endpoint       = "https://my-resource.openai.azure.com"
 authentication = "entra-id"
 clientId       = ${?AZURE_CLIENT_ID}
}

Attributes

Graph
Supertypes: trait ProviderDescriptor

class Object

trait Matchable

class Any
Self type: AzureProvider.type

Members list

Value members

Concrete methods

Constructs the client for a ProviderConfig this provider produced.

config is whatever the caller passed, so implementations must check the type rather than cast — ProviderDescriptor.expectConfig does that and produces the standard mismatch error.

Attributes

Turns a validated config section into the runtime ProviderConfig for this provider.

The section has already been checked against configSpec, so required fields are present and section.extras holds exactly the declared provider-specific keys that have a value (defaults applied, deprecated aliases resolved). A Left here means something configSpec cannot express (a malformed value, say).

Value parameters

providerName: the user's instance name (llm4s.providers.<name>), for error messages.

Attributes

Inherited methods

Alternative spellings accepted in provider = "...", folded onto id.

For example Gemini accepts "google". Aliases are matched after the same trim/lowercase canonicalisation as id itself.

Attributes

Inherited from:: ProviderDescriptor

What this provider's client implements. Defaults to the full interface.

Attributes

Inherited from:: ProviderDescriptor

Live model discovery, when the provider's API offers it.

Attributes

Inherited from:: ProviderDescriptor

Concrete fields

authentication = "api-key": the section's apiKey, or the shared AZURE_OPENAI_API_KEY.

Attributes

The key naming the Azure OpenAI API version.

Attributes

The key choosing how a section authenticates: ApiKeyAuthentication (the default) or EntraIdAuthentication.

Attributes

The client id of the user-assigned managed identity (or workload identity) Entra ID authentication uses.

Attributes

The key naming the Azure OpenAI deployment endpoint.

Attributes

authentication = "entra-id": Microsoft Entra ID tokens from llm4s-azure-identity, no API key.

Attributes

The key falls back to llm4s.credentials.azure.apiKey, bound to AZURE_OPENAI_API_KEY; a section with authentication = "entra-id" needs none.

Attributes

Canonical id, e.g. ProviderId("openai"). Must be unique within a registry.

Attributes

In this article

Generated with