Skip to content

docs: rename Azure AI Foundry to Microsoft Foundry in BYOK guide #2097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteveSandersonMS merged 6 commits into from
Jul 28, 2026
+8 −17
Merged

docs: rename Azure AI Foundry to Microsoft Foundry in BYOK guide #2097

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
46d42a6
docs: rename Azure AI Foundry to Microsoft Foundry in BYOK doc
scottaddie Jul 27, 2026
7785fc6
docs: remove parenthetical from Microsoft Foundry intro sentence
scottaddie Jul 27, 2026
4ca63fb
docs: update Microsoft Foundry limitations to None
scottaddie Jul 27, 2026
058d308
docs: refine BYOK limitations section\n\nKeep feature and provider-sp…
scottaddie Jul 27, 2026
3731c03
Potential fix for pull request finding
scottaddie Jul 27, 2026
113d524
Potential fix for pull request finding
scottaddie Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 8 additions & 17 deletions docs/auth/byok.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ BYOK allows you to use the Copilot SDK with your own API keys from model provide
| Provider | Type Value | Notes |
|----------|------------|-------|
| OpenAI | `"openai"` | OpenAI API and OpenAI-compatible endpoints |
| Azure OpenAI / Azure AI Foundry | `"azure"` | Azure-hosted models |
| Microsoft Foundry / Azure OpenAI | `"openai"` or `"azure"` | Use `"openai"` for `/openai/v1/`; use `"azure"` for native Azure endpoints |
| Anthropic | `"anthropic"` | Claude models |
| Ollama | `"openai"` | Local models via OpenAI-compatible API |
| Microsoft Foundry Local | `"openai"` | Run AI models locally on your device via OpenAI-compatible API |
| Other OpenAI-compatible | `"openai"` | vLLM, LiteLLM, etc. |

## Quick start: Azure AI Foundry
## Quick start: Microsoft Foundry

Azure AI Foundry (formerly Azure OpenAI) is a common BYOK deployment target for enterprises. Here's a complete example:
Microsoft Foundry is a common BYOK deployment target for enterprises. Here's a complete example:

<details open>
<summary><strong>Python</strong></summary>
Expand Down Expand Up @@ -260,9 +260,9 @@ provider: {
}
```

### Azure AI Foundry (OpenAI-compatible endpoint)
### Microsoft Foundry (OpenAI-compatible endpoint)

For Azure AI Foundry deployments with `/openai/v1/` endpoints, use `type: "openai"`:
For Microsoft Foundry deployments with `/openai/v1/` endpoints, use `type: "openai"`:

```typescript
provider: {
Expand Down Expand Up @@ -493,14 +493,6 @@ Results are cached after the first call, just like the default behavior. The han

## Limitations

When using BYOK, be aware of these limitations:

### Identity limitations

BYOK authentication uses **static credentials only**.

You must use an API key or static bearer token that you manage yourself.

### Feature limitations

Some Copilot features may behave differently with BYOK:
Expand All @@ -514,9 +506,8 @@ Some Copilot features may behave differently with BYOK:

| Provider | Limitations |
|----------|-------------|
| Azure AI Foundry | No Entra ID auth; must use API keys |
| Ollama | No API key; local only; model support varies |
| [Microsoft Foundry Local](https://foundrylocal.ai) | Local only; model availability depends on device hardware; no API key required |
| Ollama | No API key; local only; model support varies |
| OpenAI | Subject to OpenAI rate limits and quotas |

## Troubleshooting
Expand Down Expand Up @@ -571,7 +562,7 @@ provider: {
}
```

However, if your Azure AI Foundry deployment provides an OpenAI-compatible endpoint path (e.g., `/openai/v1/`), use `type: "openai"`:
However, if your Microsoft Foundry deployment provides an OpenAI-compatible endpoint path (for example, `/openai/v1/`), use `type: "openai"`:

<!-- docs-validate: hidden -->
```typescript
Expand All @@ -589,7 +580,7 @@ const session = await client.createSession({
<!-- /docs-validate: hidden -->

```typescript
// ✅ Correct: OpenAI-compatible Azure AI Foundry endpoint
// ✅ Correct: OpenAI-compatible Microsoft Foundry endpoint
provider: {
type: "openai",
baseUrl: "https://your-resource.openai.azure.com/openai/v1/",
Expand Down
Loading