You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-foundry/how-to/develop/get-started-projects-vs-code.md
+61-57Lines changed: 61 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
---
2
2
title: Work with the Azure AI Foundry for Visual Studio Code extension
3
3
titleSuffix: Azure AI Foundry
4
-
description: Use this article to learn how to deploy Large Language Models and develop AI agents using Azure AI Foundry capabilities directly in VS Code.
4
+
description: Use this article to learn how to deploy Large Language Models using Azure AI Foundry capabilities directly in VS Code.
5
5
manager: mcleans
6
6
ms.service: azure-ai-foundry
7
7
content_well_notification:
8
8
- AI-contribution
9
9
ms.topic: how-to
10
-
ms.date: 04/03/2025
10
+
ms.date: 04/21/2025
11
11
ms.reviewer: erichen
12
12
ms.author: johalexander
13
13
author: ms-johnalex
14
-
# customer intent: As an AI app developer, I want to learn how to use the Azure AI Foundry for Visual Studio Code extension so that I can deploy Large Language Models and develop AI agents using Azure AI Foundry capabilities directly in VS Code.
14
+
# customer intent: As an AI app developer, I want to learn how to use the Azure AI Foundry for Visual Studio Code extension so that I can deploy Large Language Models using Azure AI Foundry capabilities directly in VS Code.
15
15
---
16
16
17
17
# Work with the Azure AI Foundry for Visual Studio Code extension (Preview)
@@ -85,27 +85,49 @@ Sign in to your Azure subscription to access your resources with the following s
85
85
86
86
1. Under the "Resources" section, select your Azure Subscription and Resource Group.
87
87
88
-
1. Select **Azure AI Foundry** and open your project.
88
+
1. Select **Azure AI Foundry** and right-click your project.
89
89
90
-
1.The**Agents** and **Models** sections are listed under your project.
90
+
1.Select**Open in Azure AI Foundry Extension**.
91
91
92
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/open-aif-extension.png" alt-text="A screenshot of the Open in Azure AI Foundry Extension option." lightbox="../../media/how-to/get-started-projects-vs-code/open-aif-extension.png":::
92
93
93
-
### Set the default Azure AI Foundry Project
94
94
95
-
Set your default Azure AI Foundry Project with the following steps:
95
+
### Explore the Azure AI Foundry Extension
96
96
97
-
1. Open a new Visual Studio Code window.
97
+
The Azure AI Foundry Extension opens in its' own view, with the Azure AI Foundry Icon now displayed on the VS Code Navbar. The extension has three main sections: **Resources**, **Tools**, and **Help and Feedback**.
98
98
99
-
1. Select <kbd>F1</kbd> to open the command palette.
100
99
101
-
1. Enter **Azure AI Foundry: Select Default Project** and press Enter.
100
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/aif-ext-initial-view.png" alt-text="A screenshot of the Azure AI Foundry Extension with highlighted sections.":::
101
+
102
+
-**Resources**: This section contains the resources you have access to in your Azure AI Foundry project. The **Resources** section is the main view for interacting with your Azure AI Foundry resources. It contains the following subsections:
103
+
-**Models**: This section contains the models you can use to build and deploy your AI applications. The **Models** view is where you can find your deployed models in your Azure AI Foundry project.
104
+
-**Agents**: This section contains your deployed agents in your Azure AI Foundry project.
105
+
-**Threads**: This section contains the threads and runs from a deployed agent in your Azure AI Foundry project.
106
+
107
+
-**Tools**: This section contains the tools you can use to build and deploy your AI applications. The **Tools** view is where you can find the tools available to deploy and then work with your deployed models and agents. It contains the following subsections:
108
+
-**Model Catalog**: The link to the model catalog you can use to discover and deploy models.
109
+
-**Model Playground**: The link to the model playground for interacting with your deployed models in your Azure AI Foundry project.
110
+
-**Agent Playground**: The link to the agent playground for interacting with your deployed agents in your Azure AI Foundry project.
102
111
103
-
1. Select the Azure AI Foundry Project you want to use from the list of available projects and press Enter.
112
+
-**Help and Feedback**: This section contains links to the Azure AI Foundry documentation, feedback, and support. It contains the following subsections:
113
+
-**Documentation**: This is the link to the Azure AI Foundry Extension documentation.
114
+
-**GitHub**: This is the link to the Azure AI Foundry extension GitHub repository.
104
115
105
-
Your selected project will now display **Default** after the project name.
116
+
>[!NOTE]
117
+
> To learn more about working with Agents and Threads in the Azure AI Foundry Extension, see the [Work with Azure AI Agent Service in Visual Studio Code](./vs-code-agents.md) article.
106
118
107
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/default-project.png" alt-text="A screenshot of the designated default project." lightbox="../../media/how-to/get-started-projects-vs-code/default-project.png":::
119
+
### The default Azure AI Foundry Project
108
120
121
+
When you open a project in the Azure AI Foundry Extension, that project is set as your default project. Switch your default project by following these steps:
122
+
123
+
1. Right-click on your deployed model and select the **Switch Default Project in Azure Extension** option.
124
+
125
+
1. In the top center, select the Azure AI Foundry Project you want to use from the list of available projects and press Enter.
126
+
127
+
Your selected project will now display **Default** after the project name.
128
+
129
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/default-project.png" alt-text="A screenshot of the designated default project." lightbox="../../media/how-to/get-started-projects-vs-code/default-project.png":::
130
+
109
131
110
132
## Work with models
111
133
@@ -115,7 +137,14 @@ The Azure AI Foundry for Visual Studio Code extension enables you to create, int
115
137
116
138
The [model catalog](/azure/ai-foundry/how-to/model-catalog-overview) in Azure AI Foundry portal is the hub to discover and use a wide range of models for building generative AI applications.
117
139
118
-
Access the model catalog from the command palette to explore and deploy a curated selection of models available in Azure AI Foundry, right from inside VS Code.
140
+
Access the model catalog from several different ways:
141
+
- The **Azure AI Foundry: Open Model Catalog** command palette command.
142
+
- Select the **plus** icon next to **Models** in the **Resources** section of the Azure AI Foundry Extension view.
143
+
- Click on the **Model Catalog** link in the **Tools** section of the Azure AI Foundry Extension view.
144
+
145
+
#### Open the model catalog from the command palette
146
+
147
+
Access the model catalog from the command palette to explore and deploy a curated selection of models available in Azure AI Foundry, right from inside VS Code.
119
148
120
149
1. Select <kbd>F1</kbd> to open the command palette.
121
150
@@ -130,6 +159,20 @@ The [model catalog](/azure/ai-foundry/how-to/model-catalog-overview) in Azure AI
130
159
131
160
1. Search for a specific model using the search bar at the top-center of the page.
132
161
162
+
#### Open the model catalog from the Resources section
163
+
164
+
The **Model Catalog** is also available in the **Resources** section of the Azure AI Foundry Extension view.
165
+
166
+
-1. In the Azure AI Foundry Extension view, select the **plus** icon next to **Models** to open the Model Catalog.
167
+
168
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-model-plus-expanded.png" alt-text="Screenshot of the plus sign next to models with the list of models expanded." lightbox="../../media/how-to/get-started-projects-vs-code/select-model-plus-expanded.png":::
169
+
170
+
> [!TIP]
171
+
> You can also right-click on **Models** and select the **Deploy new AI model** option to open the Model Catalog to start the deployment process.
172
+
173
+
#### Open the model catalog from the Tools section
174
+
175
+
The **Model Catalog** is also available in the **Tools** section of the Azure AI Foundry Extension view. Double click on the **Model Catalog** link to open the Model Catalog.
133
176
134
177
#### Deploy a model from the model catalog
135
178
@@ -163,47 +206,6 @@ Deploy a selected model in the model catalog using the following steps:
163
206
164
207
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/deployed-model.png" alt-text="Screenshot of the newly deployed model under the Models section." lightbox="../../media/how-to/get-started-projects-vs-code/deployed-model.png":::
165
208
166
-
### Deploy, view, and update models
167
-
168
-
#### Deploy a model
169
-
170
-
You can also deploy a model directly from your Azure AI Foundry project.
171
-
172
-
1. In the Azure Resources Extension view, select the **plus** icon next to **Models** to start the deployment process.
173
-
174
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-model-plus-expanded.png" alt-text="Screenshot of the plus sign next to models with the list of models expanded." lightbox="../../media/how-to/get-started-projects-vs-code/select-model-plus-expanded.png":::
175
-
176
-
> [!TIP]
177
-
> You can also right-click on **Models** and select the **Deploy new AI model** option to start the deployment process.
178
-
179
-
1. In the top center, select the AI service to use in the **Choose an AI service** dropdown and press Enter.
180
-
181
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/choose-ai-service.png" alt-text="Screenshot of the Choose AI service dropdown for model deployment." lightbox="../../media/how-to/get-started-projects-vs-code/choose-ai-service.png":::
182
-
183
-
1. In the top center, select the model to deploy in the **Choose a model to deploy** dropdown and press Enter.
184
-
185
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-deployment-model.png" alt-text="Screenshot of the Choose a model to deploy dropdown." lightbox="../../media/how-to/get-started-projects-vs-code/select-deployment-model.png":::
186
-
187
-
1. In the top center, select the model version to use in the **Choose model version** dropdown and press Enter.
188
-
189
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-model-version-2.png" alt-text="Screenshot of the Choose model version dropdown for model deployment." lightbox="../../media/how-to/get-started-projects-vs-code/select-model-version-2.png":::
190
-
191
-
1. In the top center, select the deployment type to use in the **Choose deployment type** dropdown and press Enter.
192
-
193
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-deployment-type.png" alt-text="Screenshot of the Choose deployment type dropdown for model deployment." lightbox="../../media/how-to/get-started-projects-vs-code/select-deployment-type.png":::
194
-
195
-
1. In the top center, enter the model deployment name to use in the **Enter deployment name** textbox and press Enter.
196
-
197
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/enter-deployment-name-2.png" alt-text="Screenshot of the Enter deployment name textbox for model deployment." lightbox="../../media/how-to/get-started-projects-vs-code/enter-deployment-name-2.png":::
198
-
199
-
1. A confirmation dialog box appears. Select the **Deploy** button to deploy the model to your project.
200
-
201
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/deploy-model-popup-2.png" alt-text="Screenshot of the model deployment confirmation dialog box with the Deploy button highlighted." lightbox="../../media/how-to/get-started-projects-vs-code/deploy-model-popup-2.png":::
202
-
203
-
1. After a successful deployment, your model will be listed with your other deployed models under the **Models** section in your project.
204
-
205
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/deployed-model-2.png" alt-text="Screenshot of the deployed model under the Models section." lightbox="../../media/how-to/get-started-projects-vs-code/deployed-model-2.png":::
206
-
207
209
#### View deployed models
208
210
209
211
In the Azure Resources Extension view, select the **caret** icon in front of the **Models** section to view the list of deployed models.
@@ -294,13 +296,15 @@ The Azure resources that you created in this article are billed to your Azure su
294
296
295
297
### Delete your agents
296
298
297
-
Delete the deployed agent in the [online AI Foundry portal](https://ai.azure.com). Select **Agents** from the navigation menu on the left, select your agent, then select the **Delete** button.
299
+
1. In the VS Code navbar, refresh the **Azure AI Foundry Extension**. In the **Resources** section, expand the **Agents** subsection to display the list of deployed agents.
300
+
301
+
1. Right-click on your deployed agent to delete and select the **Delete** option.
298
302
299
303
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/delete-agent.png" alt-text="Screenshot of the AI Foundry portal with 'Agents' from the navigation menu on the left and the **Delete** button highlighted." lightbox="../../media/how-to/get-started-projects-vs-code/delete-agent.png":::
300
304
301
305
### Delete your models
302
306
303
-
1. In the VS Code navbar, refresh the **Azure Resources**view. Expand the **Models** subsection to display the list of deployed models.
307
+
1. In the VS Code navbar, refresh the **Azure AI Foundry Extension**. In the **Resources**section, expand the **Models** subsection to display the list of deployed models.
304
308
305
309
1. Right-click on your deployed model to delete and select the **Delete** option.
0 commit comments