Skip to content

Commit 38b401c

Browse files
committed
intial changes for release
1 parent a14e0eb commit 38b401c

File tree

7 files changed

+61
-57
lines changed

7 files changed

+61
-57
lines changed

articles/ai-foundry/how-to/develop/get-started-projects-vs-code.md

Lines changed: 61 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
title: Work with the Azure AI Foundry for Visual Studio Code extension
33
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.
55
manager: mcleans
66
ms.service: azure-ai-foundry
77
content_well_notification:
88
- AI-contribution
99
ms.topic: how-to
10-
ms.date: 04/03/2025
10+
ms.date: 04/21/2025
1111
ms.reviewer: erichen
1212
ms.author: johalexander
1313
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.
1515
---
1616

1717
# 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
8585

8686
1. Under the "Resources" section, select your Azure Subscription and Resource Group.
8787

88-
1. Select **Azure AI Foundry** and open your project.
88+
1. Select **Azure AI Foundry** and right-click your project.
8989

90-
1. The **Agents** and **Models** sections are listed under your project.
90+
1. Select **Open in Azure AI Foundry Extension**.
9191

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":::
9293

93-
### Set the default Azure AI Foundry Project
9494

95-
Set your default Azure AI Foundry Project with the following steps:
95+
### Explore the Azure AI Foundry Extension
9696

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**.
9898

99-
1. Select <kbd>F1</kbd> to open the command palette.
10099

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.
102111

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.
104115

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.
106118
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
108120

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+
109131

110132
## Work with models
111133

@@ -115,7 +137,14 @@ The Azure AI Foundry for Visual Studio Code extension enables you to create, int
115137

116138
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.
117139

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.
119148

120149
1. Select <kbd>F1</kbd> to open the command palette.
121150

@@ -130,6 +159,20 @@ The [model catalog](/azure/ai-foundry/how-to/model-catalog-overview) in Azure AI
130159

131160
1. Search for a specific model using the search bar at the top-center of the page.
132161

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.
133176

134177
#### Deploy a model from the model catalog
135178

@@ -163,47 +206,6 @@ Deploy a selected model in the model catalog using the following steps:
163206

164207
:::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":::
165208

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-
207209
#### View deployed models
208210

209211
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
294296

295297
### Delete your agents
296298

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.
298302

299303
:::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":::
300304

301305
### Delete your models
302306

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.
304308

305309
1. Right-click on your deployed model to delete and select the **Delete** option.
306310

57.2 KB
Loading
-32.9 KB
Loading
-4.88 KB
Loading
83.8 KB
Loading
9.56 KB
Loading
17.4 KB
Loading

0 commit comments

Comments
 (0)