Skip to content

Commit d40ddf6

Browse files
Merge pull request #311572 from RoseHJM/devbox-team-howto-tryit-verify
Dev Box: improve team customizations how-to with verification steps and example catalog
2 parents 8e97fb9 + 4e9e381 commit d40ddf6

4 files changed

Lines changed: 45 additions & 39 deletions

File tree

articles/dev-box/how-to-configure-catalog.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ To enable the use of image definitions in the project:
5353

5454
:::image type="content" source="media/how-to-configure-catalog/project-overview.png" alt-text="Screenshot showing the Overview page for a project with Catalogs highlighted." lightbox="media/how-to-configure-catalog/project-overview.png":::
5555

56-
1. On the **Catalogs** page, select **Catalog item permissions**.
56+
1. On the **Catalogs** page, select **Sync settings**.
5757

58-
:::image type="content" source="media/how-to-configure-catalog/project-catalog-item-permissions.png" alt-text="Screenshot showing the Catalogs pane with Catalog item permissions highlighted." lightbox="media/how-to-configure-catalog/project-catalog-item-permissions.png":::
58+
:::image type="content" source="media/how-to-configure-catalog/project-catalogs-sync-settings.png" alt-text="Screenshot showing the Catalogs pane with Sync settings highlighted." lightbox="media/how-to-configure-catalog/project-catalogs-sync-settings.png":::
5959

60-
1. In the **Catalog item settings** pane, select **Azure deployment image definitions** to enable the use of image definitions at the project level.
60+
1. In the **Sync settings** pane, select **Image definitions** to enable the use of image definitions at the project level.
6161

62-
:::image type="content" source="media/how-to-configure-catalog/project-enable-environment-definitions.png" alt-text="Screenshot showing the Catalog item settings pane with Azure deployment image definitions selected." lightbox="media/how-to-configure-catalog/project-enable-environment-definitions.png":::
62+
:::image type="content" source="media/how-to-configure-catalog/project-catalogs-sync-settings-pane.png" alt-text="Screenshot showing the Sync settings pane with Image definitions selected." lightbox="media/how-to-configure-catalog/project-catalogs-sync-settings-pane.png":::
6363

6464
Now, you can add a catalog to the project.
6565

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

Lines changed: 41 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/11/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,49 +173,27 @@ 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).
185+
186+
After you attach the catalog, verify the image definitions synced successfully:
208187
209188
> [!NOTE]
210189
> Image definitions are only supported at the project level. You must attach catalogs containing image definitions to a project, not to a dev center.
211190
212-
The **Image definitions** pane shows the image definitions your project can use.
191+
1. In the Azure portal, navigate to your project.
192+
1. In the left menu, select **Manage** > **Image definitions**.
193+
1. Verify your image definitions appear in the list.
213194
214195
:::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.":::
215196
216-
To learn how to attach catalogs, see [Add and configure a catalog from GitHub or Azure Repos](./how-to-configure-catalog.md).
217-
218197
## Configure a dev box pool to use an image definition
219198
220199
Let your development team use customizations by setting up a dev box pool with an image definition file. Store the image definition file in a repository linked to your project as a catalog. Specify this file as the image definition for the pool, and the customizations apply to new dev boxes.
@@ -244,11 +223,38 @@ Follow these steps to create a dev box pool and specify an image definition:
244223
1. Select **Create**.
245224
1. Check that the new dev box pool appears in the list. You might need to refresh the screen.
246225
247-
## Create a dev box using the developer portal
226+
## Create a dev box and verify customizations
227+
228+
To verify that customizations from the image definition file are applied correctly, create a dev box and check the results.
229+
230+
### Create a dev box in the developer portal
231+
232+
1. Sign in to the [Microsoft Dev Box developer portal](https://aka.ms/devbox-portal).
233+
234+
1. Select **New** > **New dev box**.
235+
236+
1. In **Add a dev box**, enter the following values:
237+
238+
| Setting | Value |
239+
|---|---|
240+
| **Name** | Enter a name for your dev box. Dev box names must be unique within a project. |
241+
| **Project** | Select the project that contains your customized pool. |
242+
| **Dev box pool** | Select the pool that uses your image definition. Choose a pool near you for the lowest latency. |
243+
| **Apply customizations** | Leave this checkbox cleared. Team customizations are applied automatically from the pool's image definition. |
244+
245+
1. Select **Create** to begin creating your dev box.
246+
247+
1. Track the progress on the dev box tile in the developer portal. Dev box creation can take 25 minutes or longer.
248+
249+
### Verify customizations are applied
250+
251+
Dev Box applies customizations as the final stage of creation. You receive an email when the dev box is ready.
252+
253+
1. In the developer portal, on the dev box tile, select **Actions** > **Customizations**.
248254
249-
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.
255+
1. On the **Customization details** pane, confirm the customizations that were applied to the dev box.
250256
251-
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.
257+
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.
252258
253259
[!INCLUDE [customizations-modular-scripts](includes/customizations-modular-scripts.md)]
254260
25.2 KB
Loading
105 KB
Loading

0 commit comments

Comments
 (0)