Skip to content

Commit c17ba61

Browse files
Merge pull request #4812 from aahill/amandabuild-4
Environment setup
2 parents 208f28f + 78f3353 commit c17ba61

13 files changed

+132
-149
lines changed
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: Set up your environment for Azure AI Foundry Agent Service
3+
titleSuffix: Azure AI Foundry
4+
description: Use this guide to set up your agent environment
5+
manager: nitinme
6+
author: aahill
7+
ms.author: aahi
8+
ms.reviewer: fosteramanda
9+
ms.service: azure-ai-agent-service
10+
ms.topic: how-to
11+
ms.date: 05/09/2025
12+
ms.custom: azure-ai-agents
13+
---
14+
15+
# Set up your environment
16+
17+
Creating your first agent with Azure AI Agent Service is a two-step process:
18+
1. Set up your agent environment.
19+
1. Create and configure your agent using either the SDK of your choice or the Azure Foundry Portal.
20+
21+
Use this article to learn more about setting up your agents.
22+
23+
### Required permissions
24+
25+
| Action | Required Role |
26+
|------------------------------------------------------------------------|----------------------------------|
27+
| 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 Administrator |
29+
| Create and edit agents | Azure AI User |
30+
31+
## 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.
34+
35+
### Prerequisites
36+
37+
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
38+
* 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 Administrator**.
41+
* Alternatively, having the **Owner** role at the subscription level also satisfies this requirement.
42+
* The key permission needed is: `Microsoft.Authorization/roleAssignments/write`
43+
44+
### Choose your setup
45+
Azure AI Foundry Agent Service offers three environment configuration modes to suit different needs:
46+
47+
- **Basic Setup**:
48+
49+
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, Bing, and SharePoint.
50+
51+
- **Standard Setup**:
52+
53+
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.
54+
55+
- **Standard Setup with Bring Your Own (BYO) Virtual Network**:
56+
57+
Includes everything in the Standard Setup, with the added ability to operate entirely within your own virtual network. This setup supports Bring Your Own Virtual Network (BYO virtual network), allowing for strict control over data movement and helping prevent data exfiltration by keeping traffic confined to your network environment.
58+
59+
### Compare setup options
60+
61+
| Use Cases | Basic Setup | Standard Setup with Public Networking | Standard Setup with Private Networking |
62+
|--------------------------------------------------------------------------|-------------|----------------------------------------|----------------------------------------|
63+
| Get started quickly without managing resources || | |
64+
| All conversation history, file, and vector stores are stored in your own resources | |||
65+
| Support for Customer Managed Keys (CMK) | |||
66+
| Private Network Isolation (Bring your own virtual network) | | ||
67+
68+
### Deployment options
69+
To customize these templates, see [use your own resources](./how-to/use-your-own-resources.md).
70+
71+
If you want support for Private Network Isolation see [network-secured setup](./how-to/virtual-networks.md) for more information on how to bring your own virtual network.
72+
73+
| Description and Autodeploy | Diagram (click to zoom in) |
74+
|-----------------------------|------------------------------|
75+
| Deploy a basic agent setup that uses **Managed Identity** for authentication. <br> An account and project are created. <br> A GPT-4o model is deployed. <br> A Microsoft-managed Key Vault is used by default. <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%2F40-basic-agent-setup%2Fbasic-setup.json) | :::image type="content" source="./media/quickstart/basic-setup-resources-foundry.png" alt-text="An architecture diagram for basic agent setup." lightbox="./media/quickstart/basic-setup-resources-foundry.png"::: |
76+
| 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"::: |
77+
78+
### [Optional] Model selection in autodeploy template
79+
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.
80+
81+
By default, the deployment template is configured with the following values:
82+
83+
| Model Parameter | Default Value |
84+
|------------------|----------------|
85+
| modelName | gpt-4o |
86+
| modelFormat | OpenAI (for Azure OpenAI) |
87+
| modelVersion | 2024-11-20 |
88+
| modelSkuName | GlobalStandard |
89+
| modelLocation | eastus |
90+
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+
97+
### What's next?
98+
* [Create your first agent](./quickstart.md)
99+
* Explore more:
100+
* [Use your existing resources](./how-to/use-your-own-resources.md)
101+
* [Network secured agent setup](./how-to/virtual-networks.md)

articles/ai-services/agents/how-to/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.service: azure-ai-agent-service
1313

1414
[!INCLUDE [horz-monitor-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-intro.md)]
1515

16-
Monitoring is available for agents in a [standard agent setup](../quickstart.md?pivots=programming-language-csharp#choose-basic-or-standard-agent-setup).
16+
Monitoring is available for agents in a [standard agent setup](../concepts/standard-agent-setup.md).
1717

1818
## Dashboards
1919

articles/ai-services/agents/includes/bicep-setup.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

articles/ai-services/agents/includes/quickstart-csharp.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,7 @@ ms.date: 03/28/2025
1111

1212
## Prerequisites
1313

14-
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
15-
* [The latest version of .NET](https://dotnet.microsoft.com/en-us/download)
16-
* Ensure that the individual deploying the template has the **Azure AI Developer** role assigned at the resource group level where the template is being deployed.
17-
* Additionally, to deploy the template, you need to have the preset **Role Based Access Administrator** role at the subscription level.
18-
* The **Owner** role at the subscription level satisfies this requirement.
19-
* The specific admin role that is needed is `Microsoft.Authorization/roleAssignments/write`
20-
* Ensure that each team member who wants to use the Agent Playground or SDK to create or edit agents has been assigned the built-in **Azure AI Developer** [RBAC role](../../../ai-foundry/concepts/rbac-azure-ai-foundry.md) for the project.
21-
* Note: assign these roles after the template has been deployed
22-
* The minimum set of permissions required is: **agents/*/read**, **agents/*/action**, **agents/*/delete**
23-
* Install [the Azure CLI and the machine learning extension](/azure/machine-learning/how-to-configure-cli). If you have the CLI already installed, make sure it's updated to the latest version.
24-
25-
[!INCLUDE [bicep-setup](bicep-setup.md)]
14+
[!INCLUDE [universal-prerequisites](universal-prerequisites.md)]
2615

2716
## Configure and run an agent
2817

articles/ai-services/agents/includes/quickstart-javascript.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,9 @@ ms.custom: devx-track-js
1313

1414
## Prerequisites
1515

16-
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
17-
* [Node.js LTS](https://nodejs.org/)
18-
* Ensure that the individual deploying the template has the **Azure AI Developer** role assigned at the resource group level where the template is being deployed.
19-
* Additionally, to deploy the template, you need to have the preset **Role Based Access Administrator** role at the subscription level.
20-
* The **Owner** role at the subscription level satisfies this requirement.
21-
* The specific admin role that is needed is `Microsoft.Authorization/roleAssignments/write`
22-
* Ensure that each team member who wants to use the Agent Playground or Agent SDK to create or edit agents has been assigned the built-in **Azure AI Developer** [RBAC role](../../../ai-foundry/concepts/rbac-azure-ai-foundry.md) for the project.
23-
* Note: assign these roles after the template has been deployed
24-
* The minimum set of permissions required is: **agents/*/read**, **agents/*/action**, **agents/*/delete**
25-
* Install [the Azure CLI and the machine learning extension](/azure/machine-learning/how-to-configure-cli). If you have the CLI already installed, make sure it's updated to the latest version.
26-
27-
[!INCLUDE [bicep-setup](bicep-setup.md)]
16+
[!INCLUDE [universal-prerequisites](universal-prerequisites.md)]
17+
18+
2819

2920
## Configure and run an agent
3021

articles/ai-services/agents/includes/quickstart-python-openai.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,9 @@ ms.date: 11/13/2024
1212

1313
## Prerequisites
1414

15-
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
16-
* [Python 3.8 or later](https://www.python.org/)
17-
* Ensure that the individual deploying the template has the **Azure AI Developer** role assigned at the resource group level where the template is being deployed.
18-
* Additionally, to deploy the template, you need to have the preset **Role Based Access Administrator** role at the subscription level.
19-
* The **Owner** role at the subscription level satisfies this requirement.
20-
* The specific admin role that is needed is `Microsoft.Authorization/roleAssignments/write`
21-
* Make sure you have the **Azure AI Developer** [RBAC role](../../../ai-foundry/concepts/rbac-azure-ai-foundry.md) assigned at the appropriate level.
22-
* You need the **Cognitive Services OpenAI User** role assigned to use the Azure AI Services resource.
23-
* Install [the Azure CLI and the machine learning extension](/azure/machine-learning/how-to-configure-cli). If you have the CLI already installed, make sure it's updated to the latest version.
24-
25-
[!INCLUDE [bicep-setup](bicep-setup.md)]
15+
[!INCLUDE [universal-prerequisites](universal-prerequisites.md)]
16+
17+
2618

2719
## Configure and run an agent
2820

0 commit comments

Comments
 (0)