Skip to content

Commit 9a902e5

Browse files
authored
Merge pull request #5 from aahill/patch-14
Update capability-hosts.md
2 parents 095ee41 + b1662ff commit 9a902e5

File tree

2 files changed

+30
-27
lines changed

2 files changed

+30
-27
lines changed

articles/ai-foundry/agents/concepts/capability-hosts.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ services: cognitive-services
66
manager: nitinme
77
ms.service: azure-ai-agent-service
88
ms.topic: conceptual
9-
ms.date: 07/7/2025
9+
ms.date: 07/07/2025
1010
author: fosteramanda
1111
ms.author: fosteramanda
1212
---
1313

14-
# Capability Hosts
14+
# Capability hosts
1515

1616
> [!NOTE]
1717
> Updating capability hosts is not supported. To modify a capability host, you must delete the existing one and recreate it with the new configuration.
@@ -21,55 +21,55 @@ Capability hosts are sub-resources that you define at both the Azure AI Foundry
2121
- **File uploads**
2222
- **Vector stores**
2323

24-
## Why use Capability Hosts?
24+
## Why use capability hosts?
2525

26-
Capability hosts allow you to **bring your own Azure resources** instead of using the default on Microsoft-managed platform resources. This gives you:
26+
Capability hosts allow you to **bring your own Azure resources** instead of using the default Microsoft-managed platform resources. This gives you:
2727

28-
- **Data sovereignty** - Keep all agent data within your Azure subscription
29-
- **Security control** - Use your own storage accounts, databases, and search services
30-
- **Compliance** - Meet specific regulatory or organizational requirements
28+
- **Data sovereignty** - Keep all agent data within your Azure subscription.
29+
- **Security control** - Use your own storage accounts, databases, and search services.
30+
- **Compliance** - Meet specific regulatory or organizational requirements.
3131

32-
## How do Capability Hosts work?
32+
## How do capability hosts work?
3333

3434
Creating capability hosts is not required. However if you do want agents to use your own resources, you must create a capability host on both the account and project.
3535

36-
#### Default behavior (Microsoft-managed resources)
37-
If you don't create an account-level and project-level capability host, the Agent Service automatically uses Microsoft-managed Azure resources for:
36+
### Default behavior (Microsoft-managed resources)
37+
If you don't create an account-level and project-level capability host, the Azure AI Foundry Agent Service automatically uses Microsoft-managed Azure resources for:
3838
- Thread storage (conversation history)
3939
- File storage (uploaded documents)
4040
- Vector search (embeddings and retrieval)
4141

42-
#### Bring-your-own resources
43-
When you create capability hosts at both the Account and Project levels, all agent data is stored and processed using your own Azure resources within your subscription. This configuration is called the **Standard Agent Setup**.
42+
### Bring-your-own resources
43+
When you create capability hosts at both the account and project levels, all agent data is stored and processed using your own Azure resources within your subscription. This configuration is called a **standard agent setup**.
4444

4545
#### Configuration hierarchy
4646

4747
Capability hosts follow a hierarchy where more specific configurations override broader ones:
4848

49-
1. **Service defaults** (Microsoft-managed search and storage) - Used when no capability host is configured
50-
2. **Account-level capability host** - Provides shared defaults for all projects under the account
51-
3. **Project-level capability host** - Overrides account-level and service defaults for that specific project
49+
1. **Service defaults** (Microsoft-managed search and storage) - Used when no capability host is configured.
50+
2. **Account-level capability host** - Provides shared defaults for all projects under the account.
51+
3. **Project-level capability host** - Overrides account-level and service defaults for that specific project.
5252

5353

54-
## Recommended Setup
54+
## Recommended setup
5555

56-
#### Required properties
56+
### Required properties
5757

5858
A capability host must be configured with the following three properties at either the account or project level:
5959

60-
| Property | Purpose | Required Azure Resource | Example Connection Name |
60+
| Property | Purpose | Required Azure resource | Example connection name |
6161
|----------|---------|------------------------|------------------------|
6262
| `threadStorageConnections` | Stores conversation history and chat threads | Azure Cosmos DB | `"my-cosmosdb-connection"` |
6363
| `vectorStoreConnections` | Handles vector storage for retrieval and search | Azure AI Search | `"my-ai-search-connection"` |
6464
| `storageConnections` | Manages file uploads and blob storage | Azure Storage Account | `"my-storage-connection"` |
6565

66-
#### Optional property
66+
### Optional property
6767

68-
| Property | Purpose | Required Azure Resource | When to use |
68+
| Property | Purpose | Required Azure resource | When to use |
6969
|----------|---------|------------------------|-------------|
70-
| `aiServicesConnections` | Use your own model deployments | Azure OpenAI | When you want to use models from your existing Azure OpenAI resource instead of the built-in account level ones |
70+
| `aiServicesConnections` | Use your own model deployments | Azure OpenAI | When you want to use models from your existing Azure OpenAI resource instead of the built-in account level ones. |
7171

72-
**Account Capability Host**
72+
**Account capability host**
7373
```http
7474
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts/{name}?api-version=2025-06-01
7575
@@ -79,7 +79,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{
7979
}
8080
}
8181
```
82-
**Project Capability Host**
82+
**Project capability host**
8383

8484
This configuration overrides service defaults and any account-level settings. All agents in this project will use your specified resources:
8585
```http
@@ -91,12 +91,12 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{
9191
"threadStorageConnections": ["my-cosmos-db-connection"],
9292
"vectorStoreConnections": ["my-ai-search-connection"],
9393
"storageConnections": ["my-storage-account-connection"],
94-
"aiServicesConnections": ["my-aoai-connection"] // Optional
94+
"aiServicesConnections": ["my-azure-openai-connection"] // Optional
9595
}
9696
}
9797
```
9898

99-
### Optional: Account-level defaults with project overrides
99+
### Optional: account-level defaults with project overrides
100100

101101
Set shared defaults at the account level that apply to all projects:
102102

@@ -114,7 +114,8 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{
114114
}
115115
}
116116
```
117-
Note: all Foundry projects will inherit these setting. Then override specific settings at the project level as needed.
117+
> [!NOTE]
118+
> All Azure AI Foundry projects will inherit these setting. Then override specific settings at the project level as needed.
118119
119120
## Deleting capability hosts
120121

@@ -135,4 +136,4 @@ DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroup
135136

136137
## Next steps
137138
- Learn more about the [Standard Agent Setup](standard-agent-setup.md)
138-
- Get started wth [Agent Service](../environment-setup.md)
139+
- Get started with [Agent Service](../environment-setup.md)

articles/ai-foundry/agents/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ items:
122122
href: ../../ai-services/openai/how-to/content-filters.md?context=/azure/ai-services/agents/context/context
123123
- name: Use virtual networks
124124
href: how-to/virtual-networks.md
125+
- name: Capability hosts
126+
href: concepts/capability-hosts.md
125127
- name: Multi-agent workflows
126128
items:
127129
- name: Connected agents

0 commit comments

Comments
 (0)