Skip to content

Commit d02b547

Browse files
Merge pull request #5597 from aahill/enterprise-setup
enivornment setup updates
2 parents a4c419e + 88bc608 commit d02b547

File tree

2 files changed

+86
-44
lines changed

2 files changed

+86
-44
lines changed

articles/ai-foundry/agents/environment-setup.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: aahi
88
ms.reviewer: fosteramanda
99
ms.service: azure-ai-agent-service
1010
ms.topic: how-to
11-
ms.date: 05/09/2025
11+
ms.date: 06/18/2025
1212
ms.custom: azure-ai-agents
1313
---
1414

@@ -25,19 +25,22 @@ Use this article to learn more about setting up your agent environment.
2525
| Action | Required Role |
2626
|------------------------------------------------------------------------|----------------------------------|
2727
| Create an account and project | Azure AI Account Owner |
28-
| **Standard Setup Only:** Assign RBAC for required resources (Cosmos DB, Search, Storage, etc.) | Role Based Access Control Administrator |
28+
| [standard setup](#choose-your-setup) Only: Assign RBAC for required resources (Cosmos DB, Search, Storage, etc.) | Role Based Access Control Administrator |
2929
| Create and edit agents | Azure AI User |
3030

3131
## Set up your agent environment
32-
To get started, you need an account and a project.
33-
Agents are scoped at the project level, which ensures data isolation—agents within the same project share access to the same resources.
32+
To get started, you need an Azure AI Foundry resource and a Foundry project.
33+
Agents are created within a specific project, and each project acts as an isolated workspace. This means:
34+
* All agents in the same project share access to the same file storage, thread storage (conversation history), and search indexes.
35+
* Data is isolated between projects. Agents in one project cannot access resources from another.
36+
Projects are currently the unit of sharing and isolation in Foundry. See the [what is AI foundry](../../ai-foundry/what-is-azure-ai-foundry.md) article for more information on Foundry projects.
3437

3538
### Prerequisites
3639

3740
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
3841
* Ensure that the individual creating the account and project has the **Azure AI Account Owner** role at the subscription scope
39-
* If configuring **Standard Setup**, the same individual must also have permissions to assign roles to required resources (Cosmos DB, Search, Storage).
40-
* The built-in role needed is **Role Based Access Control Administrator**.
42+
* If configuring a [standard setup](#choose-your-setup), the same individual must also have permissions to assign roles to required resources (Cosmos DB, Azure AI Search, Azure Blob Storage). For more information on RBAC roles, specific to Azure AI Foundry Agent Service, see [Azure AI Foundry Agent Service RBAC roles](../concepts/rbac-azure-ai-foundry.md).
43+
* The built-in role needed is **Role Based Access Administrator**.
4144
* Alternatively, having the **Owner** role at the subscription level also satisfies this requirement.
4245
* The key permission needed is: `Microsoft.Authorization/roleAssignments/write`
4346

@@ -76,6 +79,12 @@ If you want support for Private Network Isolation see [network-secured setup](ho
7679
| Deploy a standard agent setup that uses **Managed Identity** for authentication. <br>An account and project are created. <br> A GPT-4o model is deployed. <br> Azure resources for storing customer data - **Azure Storage**, **Azure Cosmos DB**, and **Azure AI Search** - are automatically created if existing resources are't provided. <br> These resources are connected to your project to store files, threads, and vector data. <br> A Microsoft-managed Key Vault is used by default.</li></ul> <br> [![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fazure-ai-foundry%2Ffoundry-samples%2Frefs%2Fheads%2Fmain%2Fsamples%2Fmicrosoft%2Finfrastructure-setup%2F41-standard-agent-setup%2Fazuredeploy.json) | :::image type="content" source="./media\quickstart\standard-agent-setup.png" alt-text="An architecture diagram for standard agent setup." lightbox="./media\quickstart\standard-agent-setup.png"::: |
7780

7881
### [Optional] Model selection in autodeploy template
82+
83+
> [!IMPORTANT]
84+
> **Don't change the modelFormat parameter.**
85+
>
86+
> The templates only support deployment of Azure OpenAI models. See which Azure OpenAI models are supported in the [model support](./concepts/model-region-support.md) article.
87+
7988
You can customize the model used by your agent by editing the model parameters in the autodeploy template. To deploy a different model, you need to update at least the `modelName` and `modelVersion` parameters.
8089

8190
By default, the deployment template is configured with the following values:
@@ -88,12 +97,6 @@ By default, the deployment template is configured with the following values:
8897
| modelSkuName | GlobalStandard |
8998
| modelLocation | eastus |
9099

91-
> [!IMPORTANT]
92-
> **Don't change the modelFormat parameter.**
93-
>
94-
> The templates only support deployment of Azure OpenAI models. See which Azure OpenAI models are supported in the [Azure AI Foundry Agent Service model support](concepts\model-region-support.md) documentation.
95-
96-
97100
### What's next?
98101
* [Create your first agent](quickstart.md)
99102
* Explore more:

articles/ai-foundry/agents/how-to/use-your-own-resources.md

Lines changed: 71 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,104 @@ services: cognitive-services
66
manager: nitinme
77
ms.service: azure-ai-agent-service
88
ms.topic: how-to
9-
ms.date: 01/15/2025
10-
author: fosteramanda
11-
ms.author: fosteramanda
9+
ms.date: 06/18/2025
10+
author: aahill
11+
ms.author: aahi
12+
ms.reviewer: fosteramanda
1213
ms.custom: azure-ai-agents
1314
---
1415

1516
# Use your own resources
1617

17-
Use this article if you want to use the Azure Agent Service with resources you already have.
18+
Use this article if you want to set up your Foundry project with your own resources.
19+
20+
## Limitations
21+
22+
**Use Azure Cosmos DB for NoSQL to store threads**
23+
- Your existing Azure Cosmos DB for NoSQL account used in a [standard setup](#choose-basic-or-standard-agent-setup) must have a total throughput limit of at least 3000 RU/s. Both provisioned throughput and serverless are supported.
24+
- Three containers will be provisioned in your existing Cosmos DB account, each requiring 1000 RU/s
1825

1926
> [!NOTE]
20-
> * If you use an existing AI Services / Azure OpenAI in Azure AI Foundry Models resource, no model will be deployed. You can deploy a model to the resource after the agent setup is complete.
21-
> * Make sure your Azure OpenAI resource and Azure AI Foundry project are in the same region.
27+
> * Make sure your Azure OpenAI resource and Azure AI Foundry account and project are in the same region.
28+
29+
## Prerequisites
30+
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
31+
* Ensure that the individual creating the account and project has the **Azure AI Account Owner** role at the subscription scope
32+
* If configuring a [standard setup](#choose-basic-or-standard-agent-setup), the same individual must also have permissions to assign roles to required resources (Cosmos DB, Search, Storage). For more information about RBAC in Azure AI Foundry, see [RBAC in Azure AI Foundry](../../../ai-foundry/concepts/rbac-azure-ai-foundry.md).
33+
* The built-in role needed is **Role Based Access Administrator**.
34+
* Alternatively, having the **Owner** role at the subscription level also satisfies this requirement.
35+
* The key permission needed is: `Microsoft.Authorization/roleAssignments/write`
36+
37+
* Register providers. The following providers must be registered:
38+
* `Microsoft.KeyVault`
39+
* `Microsoft.CognitiveServices`
40+
* `Microsoft.Storage`
41+
* `Microsoft.MachineLearningServices`
42+
* `Microsoft.Search`
43+
* `Microsoft.App`
44+
* `Microsoft.ContainerService`
45+
* To use the [Grounding with Bing Search tool](./tools/bing-grounding.md): `Microsoft.Bing`
46+
47+
```console
48+
az provider register --namespace 'Microsoft.KeyVault'
49+
az provider register --namespace 'Microsoft.CognitiveServices'
50+
az provider register --namespace 'Microsoft.Storage'
51+
az provider register --namespace 'Microsoft.MachineLearningServices'
52+
az provider register --namespace 'Microsoft.Search'
53+
az provider register --namespace 'Microsoft.App'
54+
az provider register --namespace 'Microsoft.ContainerService'
55+
# only to use Grounding with Bing Search tool
56+
az provider register --namespace 'Microsoft.Bing'
57+
```
2258

2359
## Choose basic or standard agent setup
2460

25-
To use your own resources, you can edit the parameters in the provided deployment templates. To start, determine if you want to edit the [basic agent setup template](https://github.com/Azure-Samples/azureai-samples/tree/main/scenarios/Agents/setup/basic-agent-identity), or the [standard agent setup template](https://github.com/Azure-Samples/azureai-samples/tree/main/scenarios/Agents/setup/standard-agent).
61+
To use your own resources, you can edit the parameters in the provided deployment templates. To start, determine if you want to edit the [basic agent setup template](https://github.com/azure-ai-foundry/foundry-samples/tree/main/samples/microsoft/infrastructure-setup/42-basic-agent-setup-with-customization), or the [standard agent setup template](https://github.com/azure-ai-foundry/foundry-samples/tree/main/samples/microsoft/infrastructure-setup/43-standard-agent-setup-with-customization).
2662
27-
**Basic Setup**: Agents created in a basic project use multitenant search and storage resources fully managed by Microsoft. You don't have visibility or control over these underlying Azure resources. You can only use your own AI services account with this option.
63+
**Basic Setup**
2864

29-
**Standard Setup**: Agents created in a standard project use customer-owned, single-tenant search and storage resources. With this setup, you have full control and visibility over these resources, but you incur costs based on your usage. You can use your own AI services account, Azure Storage account, Cosmos DB for NoSQL account and/or Azure AI Search resource with this option.
65+
This setup is compatible with OpenAI Assistants and manages agent states using the platform's built-in storage. It includes the same tools and capabilities as the Assistants API, with added support for non-OpenAI models and tools such as Azure AI Search, and Bing.
3066

31-
## Basic agent setup: Use an existing AI Services/Azure OpenAI resource
67+
**Standard Setup**
3268

33-
Replace the parameter value for `aiServiceAccountResourceId` with the full arm resource ID of the AI Services or Azure OpenAI resource you want to use.
69+
Includes everything in the basic setup and fine-grained control over your data by allowing you to use your own Azure resources. All customer data—including files, threads, and vector stores are stored in your own Azure resources, giving you full ownership and control.
3470

35-
1. To get the AI Services account resource ID, sign in to the Azure CLI and select the subscription with your AI Services account:
36-
37-
```az login```
38-
2. Replace `<your-resource-group>` with the resource group containing your resource and `your-ai-service-resource-name` with the name of your AI Service resource, and run:
39-
40-
```az cognitiveservices account show --resource-group <your-resource-group> --name <your-ai-service-resource-name> --query "id" --output tsv```
71+
## Basic agent setup: Use an existing Azure OpenAI resource
4172

42-
The value returned is the `aiServiceAccountResourceId` you need to use in the template.
73+
Replace the parameter value for `existingAoaiResourceId` with the full arm resource ID of the Azure OpenAI resource you want to use.
4374

44-
3. In the basic agent template file, replace the following placeholders:
45-
46-
```
47-
aiServiceAccountResourceId:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{serviceName}
75+
1. To get the Azure OpenAI account resource ID, sign in to the Azure CLI and select the subscription with your AI Services account:
76+
77+
```console
78+
az login
79+
```
4880

49-
[Azure OpenAI Only] aiServiceKind: AzureOpenAI
81+
2. Replace `<your-resource-group>` with the resource group containing your resource and `your-azure-openai-resource-name` with the name of your AI Service resource, and run:
82+
83+
```console
84+
az cognitiveservices account show --resource-group <your-resource-group> --name <your-ai-service-resource-name> --query "id" --output tsv
5085
```
5186

52-
If you want to use an existing Azure OpenAI resource, you will need to update the `aiServiceAccountResourceId` and the `aiServiceKind` parameters in the parameter file. The aiServiceKind parameter should be set to AzureOpenAI.
87+
The value returned is the `existingAoaiResourceId` you need to use in the template.
5388

89+
3. In the [basic agent template file](https://github.com/azure-ai-foundry/foundry-samples/blob/main/samples/microsoft/infrastructure-setup/42-basic-agent-setup-with-customization/main.bicep), replace the following placeholder:
90+
91+
```console
92+
existingAoaiResourceId:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{serviceName}
93+
```
5494

55-
## Standard agent setup: Use an existing AI Services/Azure OpenAI, Azure Storage account, Azure Cosmos DB for NoSQL account, and/or Azure AI Search resource
95+
## Standard agent setup: Use existing service resources and storage accounts
5696

57-
Use an existing AI Services / Azure OpenAI, Azure Storage account, Azure Cosmos DB for NoSQL account and/or Azure AI Search resource by providing the full ARM resource ID in the standard agent template file.
97+
Use an existing Azure OpenAI, Azure Storage account, Azure Cosmos DB for NoSQL account and/or Azure AI Search resource by providing the full ARM resource ID in the [standard agent template file](https://github.com/azure-ai-foundry/foundry-samples/blob/main/samples/microsoft/infrastructure-setup/43-standard-agent-setup-with-customization/main.bicep).
5898

59-
### Use an existing AI Services or Azure OpenAI resource
99+
### Use an existing Azure OpenAI resource
60100

61101
1. Follow the steps in basic agent setup to get the AI Services account resource ID.
62102
2. In the standard agent template file, replace the following placeholders:
63103
64-
```
65-
aiServiceAccountResourceId:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{serviceName}
66-
67-
[Azure OpenAI Only] aiServiceKind: AzureOpenAI
104+
```console
105+
existingAoaiResourceId:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{serviceName}
106+
68107
```
69108

70109
### Use an existing Azure Storage account for file storage
@@ -86,7 +125,7 @@ Use an existing AI Services / Azure OpenAI, Azure Storage account, Azure Cosmos
86125

87126
### Use an existing Azure Cosmos DB for NoSQL account for thread storage
88127
**Azure Cosmos DB for NoSQL**
89-
- Your existing Azure Cosmos DB for NoSQL Account used in standard setup must have at least a total throughput limit of at least 3000 RU/s. Both Provisioned Thoughtput and Serverless are supported.
128+
- Your existing Azure Cosmos DB for NoSQL Account used in standard setup must have at least a total throughput limit of at least 3000 RU/s. Both Provisioned Throughput and Serverless are supported.
90129
- 3 containers will be provisioned in your existing Cosmos DB account and each need 1000 RU/s
91130

92131
1. To get your Azure Cosmos DB account resource ID, sign in to the Azure CLI and select the subscription with your account:

0 commit comments

Comments
 (0)