Skip to main content

remote::azure

Description

Azure OpenAI inference provider for accessing GPT models and other Azure services. Provider documentation https://learn.microsoft.com/en-us/azure/ai-foundry/openai/overview

Configuration

FieldTypeRequiredDefaultDescription
allowed_modelslist[str] | NoneNoList of models that should be registered with the model registry. If None, all models are allowed.
refresh_modelsboolNoFalseWhether to refresh models periodically from the provider
api_keySecretStr | NoneNoAuthentication credential for the provider
networkNetworkConfig | NoneNoNetwork configuration including TLS, proxy, and timeout settings.
network.tlsTLSConfig | NoneNoTLS/SSL configuration for secure connections.
network.tls.verifybool | PathNoTrueWhether to verify TLS certificates. Can be a boolean or a path to a CA certificate file.
network.tls.min_versionLiteral[TLSv1.2, TLSv1.3] | NoneNoMinimum TLS version to use. Defaults to system default if not specified.
network.tls.cipherslist[str] | NoneNoList of allowed cipher suites (e.g., ['ECDHE+AESGCM', 'DHE+AESGCM']).
network.tls.client_certPath | NoneNoPath to client certificate file for mTLS authentication.
network.tls.client_keyPath | NoneNoPath to client private key file for mTLS authentication.
network.proxyProxyConfig | NoneNoProxy configuration for HTTP connections.
network.proxy.urlHttpUrl | NoneNoSingle proxy URL for all connections (e.g., 'http://proxy.example.com:8080').
network.proxy.httpHttpUrl | NoneNoProxy URL for HTTP connections.
network.proxy.httpsHttpUrl | NoneNoProxy URL for HTTPS connections.
network.proxy.cacertPath | NoneNoPath to CA certificate file for verifying the proxy's certificate. Required for proxies in interception mode.
network.proxy.no_proxylist[str] | NoneNoList of hosts that should bypass the proxy (e.g., ['localhost', '127.0.0.1', '.internal.corp']).
network.timeoutfloat | TimeoutConfig | NoneNoTimeout configuration. Can be a float (for both connect and read) or a TimeoutConfig object with separate connect and read timeouts.
network.timeout.connectfloat | NoneNoConnection timeout in seconds.
network.timeout.readfloat | NoneNoRead timeout in seconds.
network.headersdict[str, str] | NoneNoAdditional HTTP headers to include in all requests.
base_urlHttpUrl | NoneNoAzure API base for Azure (e.g., https://your-resource-name.openai.azure.com/openai/v1)
api_versionstr | NoneNoAzure API version for Azure (e.g., 2024-12-01-preview)
api_typestr | NoneNoazureAzure API type for Azure (e.g., azure)

Sample Configuration

api_key: ${env.AZURE_API_KEY:=}
base_url: ${env.AZURE_API_BASE:=}
api_version: ${env.AZURE_API_VERSION:=}
api_type: ${env.AZURE_API_TYPE:=}