Struct NamedProviderConfig 

#[non_exhaustive]
pub struct NamedProviderConfig {
    pub name: String,
    pub provider_type: Option<String>,
    pub wire_api: Option<String>,
    pub base_url: String,
    pub api_key: Option<String>,
    pub bearer_token: Option<String>,
    pub azure: Option<AzureProviderOptions>,
    pub headers: Option<HashMap<String, String>>,
}

A named BYOK provider connection in the multi-provider registry.

Experimental. Multi-provider BYOK configuration is part of an experimental surface and may change or be removed in a future release.

Unlike ProviderConfig, which routes the whole session through a single provider, named providers are additive: the session keeps its default Copilot routing and exposes these providers’ models alongside it. Models are attached via ProviderModelConfig, which references a provider by name.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Unique name used by ProviderModelConfig::provider to reference this connection.

provider_type: Option<String>

Provider type: "openai", "azure", or "anthropic". Defaults to "openai" on the CLI.

wire_api: Option<String>

API format (openai/azure only): "completions" or "responses". Defaults to "completions".

base_url: String

API endpoint URL.

api_key: Option<String>

API key. Optional for local providers like Ollama.

bearer_token: Option<String>

Bearer token for authentication. Sets the Authorization header directly. Takes precedence over api_key when both are set.

azure: Option<AzureProviderOptions>

Azure-specific options.

headers: Option<HashMap<String, String>>

Custom HTTP headers included in outbound provider requests.

Implementations

impl NamedProviderConfig

pub fn new(name: impl Into<String>, base_url: impl Into<String>) -> Self

Construct a NamedProviderConfig with the required name and base_url set; all other fields default to unset.

pub fn with_provider_type(self, provider_type: impl Into<String>) -> Self

Set the provider type ("openai", "azure", or "anthropic").

pub fn with_wire_api(self, wire_api: impl Into<String>) -> Self

Set the API format ("completions" or "responses"; openai/azure only).

pub fn with_api_key(self, api_key: impl Into<String>) -> Self

Set the API key. Optional for local providers like Ollama.

pub fn with_bearer_token(self, bearer_token: impl Into<String>) -> Self

Set the bearer token used to populate the Authorization header. Takes precedence over api_key when both are set.

pub fn with_azure(self, azure: AzureProviderOptions) -> Self

Set Azure-specific options.

pub fn with_headers(self, headers: HashMap<String, String>) -> Self

Set the custom HTTP headers attached to outbound provider requests.

Trait Implementations

impl Clone for NamedProviderConfig

fn clone(&self) -> NamedProviderConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NamedProviderConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NamedProviderConfig

fn default() -> NamedProviderConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NamedProviderConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NamedProviderConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.