Skip to content

Commit 8a60139

Browse files
authored
Merge pull request #6794 from jonburchel/2025-08-27-golden-paths-454639
2025 08 27 Golden Paths Plan Phase | Substep First run experience - DevOps 454639
2 parents 2a13aba + 1891bcc commit 8a60139

File tree

15 files changed

+210
-30
lines changed

15 files changed

+210
-30
lines changed
Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
title: Set Up Azure Key Vault Connection in AI Foundry
3+
description: Learn how to securely connect your Azure Key Vault to AI Foundry. Follow step-by-step instructions to manage secrets and ensure seamless integration.
4+
author: jonburchel
5+
ms.author: jburchel
6+
ms.reviewer: andyaviles
7+
ms.date: 08/27/2025
8+
ms.topic: how-to
9+
ms.service: azure-ai-foundry
10+
ai.usage: ai-assisted
11+
zone_pivot_groups: set-up-key-vault
12+
---
13+
14+
# Set up a Key Vault connection in Azure AI Foundry
15+
16+
Azure Key Vault is a service for securely storing and accessing secrets.
17+
If you don't create a Key Vault connection, Azure AI Foundry stores connection details in a Microsoft-managed Azure Key Vault. The managed Key Vault doesn't appear in your Azure subscription. If you prefer to manage
18+
secrets, connect your own Azure Key Vault.
19+
20+
> [!NOTE]
21+
> Review limitations before you set up your Key Vault connection.
22+
23+
## Limitations
24+
25+
Create Azure Key Vault connections only when needed.
26+
27+
If you bring your own Azure Key Vault, review these limitations:
28+
29+
- One Azure Key Vault connection per AI Foundry resource is allowed. Delete an Azure Key Vault connection only if no other connections exist at the AI Foundry resource or project level. AI Foundry doesn't support secret migration, so remove and recreate connections yourself.
30+
- Deleting the underlying Azure Key Vault breaks the AI Foundry resource. Key Vault stores secrets for connections that don't use Entra ID, so any AI Foundry feature that depends on those connections stops working.
31+
- Deleting the AI Foundry resource's connection secrets stored in your bring-your-own (BYO) Azure Key Vault can break connections to other services. It may break connections to other services.
32+
33+
::: zone pivot="ai-foundry-portal"
34+
35+
## Create an Azure Key Vault connection
36+
37+
Follow these steps to create a new connection to Azure Key Vault.
38+
39+
1. Go to your project in the Azure AI Foundry portal. If you don't have a project, create a new project.
40+
41+
1. Make sure no connections exist in the **Resource** or **Project** sections. If any exist, **Azure Key Vault** isn't available as an option.
42+
43+
1. In the **Resource** section, select **Connected resources**.
44+
45+
1. In the **Connected resources** section, select **+ New connection**.
46+
47+
:::image type="content" source="../media/setup-key-vault-connection/select-azure-key-vault.jpeg" alt-text="Screenshot of the Connected resources section with the + New connection button selected, showing Azure Key Vault as an available option.":::
48+
49+
1. Select **Azure Key Vault**.
50+
51+
:::image type="content" source="../media/setup-key-vault-connection/azure-key-vault-connection.jpeg" alt-text="Screenshot of the Azure Key Vault selection dialog with Azure Key Vault selected.":::
52+
53+
1. Select your **Azure Key Vault**, and then select **Connect**.
54+
55+
::: zone-end
56+
::: zone pivot="bicep"
57+
58+
## Create a Key Vault connection
59+
60+
<!-- Pull this content from the [foundry-samples repository (keyvaultconnection branch)](https://github.com/andyaviles121/foundry-samples/tree/keyvaultconnection) after it's merged.
61+
62+
TBD - DO NOT PUBLISH WITHOUT UPDATING THIS WITH THE REAL CODE FOR THE SAMPLE.
63+
-->
64+
65+
66+
::: zone-end
67+
68+
## Key Vault connection management
69+
70+
### Creation
71+
72+
Create a Key Vault connection only when it's the only connection.
73+
Make sure no other connections exist at the Foundry resource or project level.
74+
The service blocks Key Vault connection creation if other connections are present.
75+
If the UI doesn't show a Key Vault connection category when you choose a connection,
76+
this can be the reason. Delete other connections, and then try again.
77+
78+
When you create a Key Vault connection, the managed Key Vault in Azure isn't used.
79+
80+
### Deletion
81+
82+
Before you delete an Azure Key Vault connection from AI Foundry, remove all other connections.
83+
After you remove all other connections at the Foundry resource and project levels,
84+
delete the Key Vault connection. Foundry doesn't support secret migration.
85+
86+
### Update or change
87+
88+
To switch from Azure Key Vault 1 to Azure Key Vault 2, delete the Azure Key Vault 1 connection, and then create the Azure Key Vault 2 connection. Follow the deletion and creation steps, and migrate any connection secrets.
89+
90+
### Key Vault secret lifecycle
91+
92+
When you delete connections from your managed Key Vault, the corresponding secrets are deleted.
93+
Deleting a Key Vault connection also deletes its secrets.
94+
95+
### Granting AI Foundry access to your key vault
96+
97+
Depending on how your key vault is provisioned, you might need to apply additional permissions.
98+
Check whether your Azure Key Vault uses role-based access control (RBAC) or access policies, and then continue.
99+
100+
#### Role-based access control (RBAC)
101+
102+
After you create the Key Vault connection, assign an appropriate RBAC role in the Azure portal. Key Vault Contributor or Key Vault Administrator are two roles that work. For minimal permissions, use the [Key Vault Secrets
103+
Officer](/azure/role-based-access-control/built-in-roles/security#key-vault-secrets-officer).
104+
105+
#### Access policies
106+
107+
Similar to RBAC roles, assign the appropriate key vault access policy (if applicable) to the Foundry resource's managed identity.
108+
109+
## Infrastructure as code templates
110+
111+
As a best practice, when setting up ARM, Bicep, or Terraform templates to create resources, make sure the Azure Key Vault connection is the first connection you create, and make all other connections depend on the Key Vault connection succeeding. This order helps reduce Key Vault connection failures. If you don't follow this best practice, your templates can encounter race conditions across your connections. As a result, deployments can work sometimes and fail at other times because Foundry doesn't support secret migration.
112+
113+
After you create the Foundry resource and the Key Vault connection, assign the appropriate RBAC roles to the Foundry resource. Make all other connections depend on this role assignment succeeding. The same applies if your Key Vault uses access policies instead of RBAC.
114+
115+
### Follow this order in your infrastructure as code templates
116+
117+
1. Create the Foundry resource.
118+
1. Create a Foundry project.
119+
1. Create the Azure Key Vault connection.
120+
1. Assign the appropriate RBAC role on the Key Vault for the Foundry resource.
121+
1. (Optional) Validate that the RBAC role has taken effect.
122+
1. Create any other connections at the resource or project level, and set the `dependsOn` field for steps 3 and 4.
123+
124+
#### Deletion
125+
126+
For cleanup, if you automate resource deletion by using templates, follow the creation steps in reverse:
127+
128+
1. Delete all connections at the Foundry resource or project level.
129+
1. Delete the Azure Key Vault connection.
130+
1. Delete all Foundry projects.
131+
1. Delete the Foundry resource.
132+
133+
## Related content
134+
135+
- [Azure Key Vault documentation](/azure/key-vault/)
136+
- [AI Foundry documentation](/azure/ai-foundry/)
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Include file
3+
description: Include file
4+
author: jonburchel
5+
ms.reviewer: jburchel
6+
ms.author: jburchel
7+
ms.service: azure-ai-foundry
8+
ms.topic: include
9+
ms.date: 08/27/2025
10+
ms.custom: include
11+
---
12+
## First run experience
13+
14+
Use this fast path when you don't have any projects yet. Pick what you want to do and we create the project and get you into the right playground. It is suggested to start with an agent but you can also explore models through the Foundry portal or model catalog.
15+
16+
# [Agent (_recommended_)](#tab/azure-ai-foundry)
17+
18+
To start with an agent, use the following steps:
19+
20+
1. In the top breadcrumb, select **Azure AI Foundry**, then select **Create an agent**.
21+
22+
1. Enter a project name. Confirm your directory and subscription. Select **Create**.
23+
24+
:::image type="content" source="../media/quickstarts/create-agent.png" alt-text="Screenshot of Agents playground showing a default agent loaded with GPT-4o deployed. Chat interface and agent details panel are visible." lightbox="../media/quickstarts/create-agent.png":::
25+
26+
1. When prompted, choose a model. We recommend **gpt-4o** for best quality, or **gpt-4o-mini** for lower cost.
27+
28+
:::image type="content" source="../media/quickstarts/agent-model-selection.png" alt-text="Screenshot showing the model selection dialog during agent deployment.":::
29+
30+
1. Select **Deploy** on the final confirmation page after selecting a deployment type, and you see the Agents playground with your agent ready to chat.
31+
32+
:::image type="content" source="../media/quickstarts/deploy-agent-model.png" alt-text="Screenshot of Agents playground showing a default agent loaded with GPT-4o deployed. The chat interface and agent details panel are visible." lightbox="../media/quickstarts/deploy-agent-model.png":::
33+
34+
1. You see the Agents playground with your agent ready to chat.
35+
36+
:::image type="content" source="../media/quickstarts/agents-playground.png" alt-text="Screenshot of the Agents playground using gpt-4o." lightbox="../media/quickstarts/agents-playground.png":::
37+
38+
# [Model](#tab/azure-ai-foundry-model)
39+
40+
In the portal, you can explore a rich catalog of cutting-edge models from Microsoft, OpenAI, DeepSeek, Hugging Face, Meta, and more. For this tutorial, search and then select the **gpt-4o** model.
41+
42+
1. From the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) or **[Model catalog](https://ai.azure.com/explore/models)**, select **gpt-4o** (or **gpt-4o-mini**).
43+
44+
:::image type="content" source="../media/quickstarts/start-building.png" alt-text="Screenshot shows how to start building an Agent in Azure AI Foundry portal.":::
45+
46+
1. Select **Use this model**. When prompted, enter a project name and select **Create**.
47+
1. Review the deployment name and select **Create**.
48+
49+
:::image type="content" source="../media/quickstarts/create-foundry-model.png" alt-text="Screenshot showing how to create a model from the AI Foundry Model Catalog.":::
50+
51+
1. Then select **Connect and deploy** after selecting a deployment type.
52+
53+
:::image type="content" source="../media/quickstarts/deploy-foundry-model.png" alt-text="Screenshot showing how to deploy a model from the AI Foundry model catalog.":::
54+
55+
1. Select **Open in playground** from the deployment page after it's deployed.
56+
57+
1. You land in the Chat playground with the model pre-deployed and ready to use.
58+
59+
:::image type="content" source="../media/quickstarts/model-chat-playground.png" alt-text="Screenshot showing the model chat playground after deploying an Azure AI Foundry model from the model catalog.":::
60+
61+
---

articles/ai-foundry/includes/get-started-fdp.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,7 @@ The Azure AI Foundry SDK is available in multiple languages, including Python, J
3434

3535
[!INCLUDE [feature-preview](feature-preview.md)]
3636

37-
## Start with a project and model
38-
39-
1. Sign in to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs).
40-
1. In the portal, you can explore a rich catalog of cutting-edge models from Microsoft, OpenAI, DeepSeek, Hugging Face, Meta, and more. For this tutorial, search and then
41-
select the **gpt-4o** model.
42-
43-
:::image type="content" source="../media/quickstarts/start-building.png" alt-text="Screenshot shows how to start building an Agent in Azure AI Foundry portal.":::
44-
45-
> [!NOTE]
46-
> You can check out the [model catalog](https://ai.azure.com/explore/models) to confirm pricing on individual models.
47-
48-
1. On the model details page, select **Use this model**.
49-
1. Fill in a name to use for your project and select **Create**.
50-
1. Review the deployment information then select **Deploy**.
51-
1. Once your resources are created, you are in the chat playground.
37+
[!INCLUDE [feature-preview](first-run-experience.md)]
5238

5339
## Set up your environment
5440

126 KB
Loading
60.3 KB
Loading
250 KB
Loading
91.7 KB
Loading
53.5 KB
Loading
62.6 KB
Loading
69.5 KB
Loading

0 commit comments

Comments
 (0)