Skip to content

Commit 429ff3d

Browse files
committed
Dev Box: improve team customizations how-to with verification steps and example catalog
- Adds ai-usage: ai-assisted and updates ms.date to 02/06/2026 - Replaces detailed catalog enable/sync steps with link to catalog how-to - Adds explicit 'verify image definitions synced' steps - Adds 'Create a dev box and verify customizations' section - Adds 'Try it: Use the example catalog' section
1 parent c21e7f2 commit 429ff3d

1 file changed

Lines changed: 89 additions & 35 deletions

File tree

articles/dev-box/how-to-configure-team-customizations.md

Lines changed: 89 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ ms.custom:
99
- ai-gen-docs-bap
1010
- ai-gen-description
1111
- ai-seo-date:04/18/2025
12+
- ai-usage: ai-assisted
1213
ms.topic: how-to
13-
ms.date: 08/14/2025
14+
ms.date: 02/06/2026
1415

1516
#customer intent: As a Dev Center admin or project admin, I want to create image definition files so that my development teams can create customized dev boxes.
1617
---
@@ -172,45 +173,23 @@ Once you have an image definition file that you want to use, upload it to a cata
172173
173174
Projects help you manage Dev Box resources efficiently. You can assign each developer team its own project to organize resources effectively. Create multiple image definitions in your catalog repository, each in its own folder to target different developer teams under your project.
174175
175-
### Enable project-level catalogs
176+
### Enable project-level catalogs and sync settings
176177
177-
Enable project-level catalogs at the dev center level before you add a catalog to a project.
178-
To enable project-level catalogs at the dev center level:
178+
Before you can use image definitions from a catalog, you must enable project-level catalogs at the dev center level and configure sync settings for image definitions.
179179
180-
1. In the [Azure portal](https://portal.azure.com/), go to your dev center.
181-
1. In the left menu, under **Settings**, select **Dev center settings**.
182-
1. Under **Project level catalogs**, select **Enable catalogs per project**, and then select **Apply**.
183-
184-
185-
:::image type="content" source="media/how-to-configure-team-customizations/dev-center-settings-project-catalog.png" alt-text="Screenshot of the Dev center settings page with the Project level catalogs pane open and the Enable catalogs per project option selected.":::
186-
187-
For more information about how to add catalogs to projects, see [Add and configure a catalog from GitHub or Azure Repos](./how-to-configure-catalog.md).
188-
189-
### Configure catalog sync settings for the project
190-
191-
Set up your project to sync image definitions from the catalog. This setting lets you use the image definitions in the catalog to create dev box pools.
192-
193-
1. Sign in to the [Azure portal](https://portal.azure.com).
194-
1. In the search box, enter *projects*. From the list of results, select **Projects**.
195-
1. Open the Dev Box project where you want to set up catalog sync settings.
196-
1. Select **Catalogs**.
197-
1. Select **Sync settings**.
198-
199-
:::image type="content" source="./media/how-to-configure-team-customizations/customizations-project-sync-settings-small.png" alt-text="Screenshot of the Catalogs pane in the Azure portal, with the button for sync settings highlighted.":::
200-
201-
1. On the **Sync settings** pane, select **Image definitions**, then select **Save**.
202-
203-
:::image type="content" source="./media/how-to-configure-team-customizations/customizations-project-sync-image-definitions.png" alt-text="Screenshot of the sync settings pane in the Azure portal, with the checkbox for image definitions highlighted.":::
180+
For detailed steps, see [Configure project-level catalogs](./how-to-configure-catalog.md#configure-project-level-catalogs).
204181
205182
### Attach the catalog that contains the image definition file
206183
207-
To use an image definition file, attach the catalog containing the file to your project. This makes the image definition available for selection when configuring your dev box pools.
184+
To use an image definition file, attach the catalog containing the file to your project. For detailed steps on attaching catalogs using GitHub or Azure Repos, see [Add a catalog](./how-to-configure-catalog.md#add-a-catalog).
208185
209-
The **Image definitions** pane shows the image definitions your project can use.
186+
After you attach the catalog, verify the image definitions synced successfully:
210187
211-
:::image type="content" source="media/how-to-configure-team-customizations/team-customizations-image-definitions-small.png" alt-text="Screenshot of the Azure portal pane showing image definitions available for a project.":::
188+
1. In the Azure portal, navigate to your project.
189+
1. In the left menu, select **Manage** > **Image definitions**.
190+
1. Verify your image definitions appear in the list.
212191
213-
To learn how to attach catalogs, see [Add and configure a catalog from GitHub or Azure Repos](./how-to-configure-catalog.md).
192+
:::image type="content" source="media/how-to-configure-team-customizations/team-customizations-image-definitions-small.png" alt-text="Screenshot of the Azure portal pane showing image definitions available for a project.":::
214193
215194
## Configure a dev box pool to use an image definition
216195
@@ -241,11 +220,86 @@ Follow these steps to create a dev box pool and specify an image definition:
241220
1. Select **Create**.
242221
1. Check that the new dev box pool appears in the list. You might need to refresh the screen.
243222
244-
## Create a dev box using the developer portal
223+
## Create a dev box and verify customizations
224+
225+
To verify that customizations from the image definition file are applied correctly, create a dev box and check the results.
226+
227+
### Create a dev box in the developer portal
228+
229+
1. Sign in to the [Microsoft Dev Box developer portal](https://aka.ms/devbox-portal).
230+
231+
1. Select **New** > **New dev box**.
232+
233+
1. In **Add a dev box**, enter the following values:
234+
235+
| Setting | Value |
236+
|---|---|
237+
| **Name** | Enter a name for your dev box. Dev box names must be unique within a project. |
238+
| **Project** | Select the project that contains your customized pool. |
239+
| **Dev box pool** | Select the pool that uses your image definition. Choose a pool near you for the lowest latency. |
240+
| **Apply customizations** | Leave this checkbox cleared. Team customizations are applied automatically from the pool's image definition. |
241+
242+
1. Select **Create** to begin creating your dev box.
243+
244+
1. Track the progress on the dev box tile in the developer portal. Dev box creation can take 25 minutes or longer.
245+
246+
### Verify customizations are applied
247+
248+
Dev Box applies customizations as the final stage of creation. You receive an email when the dev box is ready.
249+
250+
1. In the developer portal, on the dev box tile, select **Actions** > **Customizations**.
251+
252+
1. On the **Customization details** pane, confirm the customizations that were applied to the dev box.
253+
254+
If the customizations aren't applied as expected, make changes to your image definition file and create a new dev box to test them. When the customizations are correct, [build a reusable image](how-to-configure-dev-center-imaging.md) to optimize dev box creation time.
255+
256+
## Try it: Use the example catalog
257+
258+
To quickly try team customizations, use the Microsoft-provided example catalog that contains sample image definitions for a frontend and backend development environment.
259+
260+
### Fork the example repository
261+
262+
1. Open the [example catalog repository](https://aka.ms/devcenter/preview/imaging/examples/repo).
263+
264+
1. Select **Fork** > **Create a new fork** to fork the repository to your GitHub organization.
265+
266+
### Add the example catalog to your project
267+
268+
1. In the [Azure portal](https://portal.azure.com), navigate to your project and select **Catalogs** > **Add**.
269+
270+
1. On the **Add catalog** pane:
271+
272+
| Field | Value |
273+
|-----|-----|
274+
| **Name** | Enter a name for the catalog (for example, *example-catalog*). |
275+
| **Catalog source** | Select **GitHub**. |
276+
| **Authentication type** | Select **GitHub app**. |
277+
278+
1. Select the **configure your repositories** link and authenticate to GitHub if prompted.
279+
280+
1. On the **Microsoft DevCenter** page, select **Configure**, then select your GitHub organization.
281+
282+
1. Select **Only select repositories**, choose your forked repository, and select **Save**.
283+
284+
1. Back in the Azure portal, select **Sign in with GitHub**.
285+
286+
1. Complete the catalog configuration:
287+
288+
| Field | Value |
289+
| ----- | ----- |
290+
| **Repo** | Select your forked repository. |
291+
| **Branch** | Select *main*. |
292+
| **Folder path** | Enter the path to image definitions (for example, *.devcenter/catalog/image-definitions*). |
293+
294+
1. Select **Add**.
295+
296+
1. Verify the catalog shows **Sync successful** status, then check **Image definitions** to see the available definitions.
297+
298+
### Create a pool and dev box from the example
245299
246-
To check that customizations from the image definition file are applied, create a dev box in the Dev Box developer portal. Follow the steps in [Quickstart: Create and connect to a dev box by using the Dev Box developer portal](quickstart-create-dev-box.md). Then connect to the new dev box and check that the customizations work as you expect.
300+
1. Create a dev box pool using one of the example image definitions (such as *frontend-dev* or *backend-dev*).
247301
248-
Make changes to the image definition file and create a new dev box to test them. When you're sure the customizations are correct, build a reusable image.
302+
1. Create a dev box from the pool and verify the customizations are applied.
249303
250304
[!INCLUDE [customizations-modular-scripts](includes/customizations-modular-scripts.md)]
251305

0 commit comments

Comments
 (0)