Skip to content

Commit 591275d

Browse files
committed
Dev Box: de-duplicate how-to content and link to authoritative sources
- Removes duplicated permissions/comparison content from how-tos - Links to concept-what-are-dev-box-customizations.md#permissions-for-customizations - Updates catalog and Key Vault guidance links - Adds ai-usage metadata where applicable
1 parent c21e7f2 commit 591275d

4 files changed

Lines changed: 30 additions & 140 deletions

articles/dev-box/how-to-configure-customization-tasks.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ ms.author: rosemalcolm
66
ms.service: dev-box
77
ms.custom:
88
- ignite-2024
9+
- ai-usage: ai-assisted
910
ms.topic: how-to
10-
ms.date: 11/05/2024
11+
ms.date: 02/06/2026
1112

1213
#customer intent: As a Dev Center Admin or Project Admin, I want to create additional tasks in a catalog so that I can create a specific customization in a customization or image definition file.
1314
---
@@ -23,9 +24,7 @@ To complete the steps in this article, you must have:
2324
- A dev center configured with a dev box project.
2425
- An existing catalog in GitHub or Azure Repos.
2526

26-
## Permissions required to configure customizations
27-
28-
[!INCLUDE [permissions-for-customizations](includes/permissions-for-customizations.md)]
27+
For permissions required to configure customizations, see [Permissions for customizations](concept-what-are-dev-box-customizations.md#permissions-for-customizations).
2928

3029
## What are tasks?
3130

@@ -57,27 +56,18 @@ To create and manage tasks for Dev Box team customizations, follow these steps:
5756

5857
1. Attach your repository to your dev center as a catalog.
5958

60-
1. Create a configuration file for those tasks by following the steps in [Write a customization file](./how-to-write-customization-file.md).
59+
1. Create a configuration file for those tasks by following the steps in [Configure team customizations](how-to-configure-team-customizations.md).
6160

6261
### Use secrets from an Azure key vault
6362

64-
You can use secrets from your Azure key vault in your YAML configurations to clone private repositories, or with any custom task you author that requires an access token.
65-
66-
Your dev center needs access to your key vault. DevCenter doesn't support service tags, so if your key vault is kept private, you must allow trusted Microsoft services to bypass the firewall.
67-
68-
To configure your key vault secrets for use in your YAML configurations:
69-
70-
1. Ensure that your dev center project's managed identity has the Key Vault Reader role and Key Vault Secrets User role on your key vault.
71-
72-
1. Grant the Key Vault Secrets User role for the key vault secret to each user or user group that should be able to consume the secret during the customization of a dev box. The user or group granted the role must include the managed identity for the dev center, your own user account, and any user or group that needs the secret during the customization of a dev box.
73-
74-
For more information on using key vault secrets in a customization file, see [Clone a private repository by using a customization file](how-to-customizations-connect-resource-repository.md#use-key-vault-secrets-in-customization-files).
63+
You can use secrets from your Azure key vault in your YAML configurations to clone private repositories or run tasks that require an access token. For detailed configuration steps and examples, see [Connect to Azure resources or clone private repositories](how-to-customizations-connect-resource-repository.md).
7564

7665
## Attach a catalog
7766

78-
You can attach a catalog to a project to make tasks accessible to the developer team. To attach a catalog to a project, follow the steps in [Add and configure a catalog from GitHub or Azure Repos](../deployment-environments/how-to-configure-catalog.md).
67+
You can attach a catalog to a project to make tasks accessible to the developer team. To attach a catalog to a project, follow the steps in [Add and manage catalogs in Microsoft Dev Box](how-to-configure-catalog.md).
7968

8069
## Related content
8170

8271
- [Microsoft Dev Box customizations](concept-what-are-dev-box-customizations.md)
83-
- [Write a customization file for a dev box](./how-to-write-customization-file.md)
72+
- [Configure team customizations](how-to-configure-team-customizations.md)
73+
- [Customizations schema reference](reference-dev-box-customizations.md)

articles/dev-box/how-to-configure-dev-center-imaging.md

Lines changed: 12 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ ms.reviewer: rosemalcolm
77
ms.service: dev-box
88
ms.custom:
99
- ignite-2024
10+
- ai-usage: ai-assisted
1011
ms.topic: how-to
11-
ms.date: 11/11/2025
12+
ms.date: 02/06/2026
1213

1314
#customer intent: As a Dev Center Admin or Project Admin, I want to configure dev box pools to use image definition files so that my development teams can create customized dev boxes.
1415
---
@@ -25,53 +26,11 @@ In this article, you learn how to configure dev center imaging for your developm
2526

2627
To complete the steps in this article, you need:
2728

28-
- A team customization file that you want to use to create a dev box. If you don't have a customization file, see [Configure team customizations](how-to-configure-team-customizations.md).
29+
- A dev center with a project and dev box pool. If you don't have one, see [Configure Microsoft Dev Box](quickstart-configure-dev-box-service.md).
30+
- A catalog attached to your project with image definitions. If you don't have a catalog, see [Add and manage catalogs](how-to-configure-catalog.md).
31+
- A team customization file (image definition) in your catalog. If you don't have one, see [Configure team customizations](how-to-configure-team-customizations.md).
2932

30-
## Permissions required to configure customizations
31-
32-
To perform the required actions for creating and applying customizations to a dev box, you need the following permissions:
33-
34-
| Action | Permission/Role |
35-
| --- | --- |
36-
| Enable project-level catalogs for a dev center. | Platform engineer with write access on the subscription. |
37-
| Enable catalog sync settings for a project. | Platform engineer with write access on the subscription. |
38-
| Attach a catalog to a project. | Project Admin or Contributor permissions on the project. |
39-
| Add tasks to a catalog. | Permission to add to the repository that hosts the catalog. |
40-
41-
To manage a dev box pool, you need the following permissions:
42-
43-
| Action | Permission |
44-
|---|---|
45-
| Create, delete, or update a dev box pool. | - Owner or Contributor permissions on an Azure subscription or a specific resource group. </br>- DevCenter Owner permissions on the dev center. </br>- DevCenter Project Admin permissions for the project. |
46-
47-
## Enable project-level catalogs
48-
49-
To attach a catalog to a project, you must enable project-level catalogs. For more information, see [Add and manage catalogs in Microsoft Dev Box](how-to-configure-catalog.md).
50-
51-
## Configure catalog sync settings for the project
52-
53-
1. Sign in to the [Azure portal](https://portal.azure.com).
54-
1. In the search box, enter **projects**. In the list of results, select **Projects**.
55-
1. Open the Dev Box project for which you want to configure catalog sync settings.
56-
1. Select **Catalogs**.
57-
1. Select **Sync settings**.
58-
59-
:::image type="content" source="./media/how-to-configure-dev-center-imaging/customizations-project-sync-settings-small.png" alt-text="Screenshot of the Catalogs pane in the Azure portal, with the button for sync settings highlighted." lightbox="./media/how-to-configure-dev-center-imaging/customizations-project-sync-settings.png":::
60-
61-
1. On the **Sync settings** pane, select **Image definitions**, then select **Save**.
62-
63-
:::image type="content" source="./media/how-to-configure-dev-center-imaging/customizations-project-sync-image-definitions.png" alt-text="Screenshot of the pane for sync settings in the Azure portal, with the checkbox for image definitions highlighted." lightbox="./media/how-to-configure-dev-center-imaging/customizations-project-sync-image-definitions.png":::
64-
65-
## Attach a catalog that contains the definition file
66-
67-
Before you can use a customization file as an image definition, attach a catalog that contains the definition file to your project. The catalog can be from GitHub or Azure Repos. For more information, see [Add and configure a catalog from GitHub or Azure Repos](../dev-box/how-to-configure-catalog.md).
68-
69-
> [!NOTE]
70-
> Image definitions are only supported at the project level. You must attach catalogs containing image definitions to a project, not to a dev center.
71-
72-
The **Image definitions** pane lists the image definitions that your project can access.
73-
74-
:::image type="content" source="media/how-to-configure-dev-center-imaging/team-customizations-image-definitions-small.png" alt-text="Screenshot of the Azure portal pane that lists accessible image definitions for a project." lightbox="media/how-to-configure-dev-center-imaging/team-customizations-image-definitions.png":::
33+
For permissions required to configure customizations, see [Permissions for customizations](concept-what-are-dev-box-customizations.md#permissions-for-customizations).
7534

7635
## Build a reusable image
7736

@@ -170,63 +129,20 @@ During the image build process, Dev Box creates a temporary storage account in y
170129
171130
## Configure a dev box pool to use an image definition
172131

173-
To make customizations available to your development teams, configure a dev box pool to use an image definition. Store the customization file (imagedefinition.yaml) in a repository linked to a catalog in your project. When you specify the image definition for the pool, the customizations are applied to new dev boxes.
174-
175-
### Create a dev box pool
132+
To use an image definition, you must configure a dev box pool to reference it. When developers create dev boxes from the pool, the customizations from the image definition are applied automatically.
176133

177-
In Microsoft Dev Box, a dev box pool is a collection of dev boxes that you manage together. You must have at least one dev box pool before users can create a dev box.
134+
For detailed steps on creating a dev box pool with an image definition, see [Configure a dev box pool to use an image definition](how-to-configure-team-customizations.md#configure-a-dev-box-pool-to-use-an-image-definition).
178135

179-
The following steps show you how to create a dev box pool in a project.
180-
181-
If you don't have an available dev center and project, follow the steps in [Quickstart: Configure Microsoft Dev Box](quickstart-configure-dev-box-service.md) to create them.
182-
183-
1. Sign in to the [Azure portal](https://portal.azure.com).
184-
185-
1. In the search box, enter **projects**. In the list of results, select **Projects**.
186-
187-
1. Open the project where you want to create the dev box pool.
188-
189-
:::image type="content" source="./media/quickstart-configure-dev-box-service/select-project.png" alt-text="Screenshot that shows the list of existing projects." lightbox="./media/quickstart-configure-dev-box-service/select-project.png":::
190-
191-
1. Select **Dev box pools**, then select **Create**.
192-
193-
:::image type="content" source="./media/quickstart-configure-dev-box-service/create-pool.png" alt-text="Screenshot of an empty list of dev box pools within a project, along with selections to start creating a pool." lightbox="./media/quickstart-configure-dev-box-service/create-pool.png":::
194-
195-
1. On the **Create a dev box pool** pane, on the **Basics** tab, enter the following values:
196-
197-
| Setting | Value |
198-
|---|---|
199-
| **Name** | Enter a name for the pool. The pool name is visible to developers to select when they're creating dev boxes. The name must be unique within a project. |
200-
| **Definition** | Select an **Image definition**. |
201-
| **Compute** | Select the virtual machine size for the dev boxes in this pool. |
202-
| **Storage** | Select the storage size for the dev boxes in this pool. |
203-
| **Hibernation** | Shows whether hibernation is supported or not. |
204-
| **Region** | |
205-
| **Network connection** | 1. Select **Deploy to a Microsoft hosted network**. </br>2. Select your desired deployment region for the dev boxes. Choose a region close to your expected dev box users for the optimal user experience. |
206-
| **Licensing** | Select this checkbox to confirm that your organization has Azure Hybrid Benefit licenses that you want to apply to the dev boxes in this pool. |
207-
208-
:::image type="content" source="./media/how-to-configure-dev-center-imaging/dev-box-pool-create-basics-hibernation-image.png" alt-text="Screenshot of the Basics pane for creating a dev box pool." lightbox="./media/how-to-configure-dev-center-imaging/dev-box-pool-create-basics-hibernation-image.png":::
209-
210-
1. Select **Create**.
211-
212-
#### Hibernation support for dev boxes
136+
### Hibernation support
213137

214138
Dev Box supports hibernation when both these conditions are met:
215139
- The source image defined in the image definition supports hibernation.
216140
- The compute resources of the dev box pool support hibernation.
217141

218-
If either the image or the pool doesn't support hibernation, the feature isn't available for dev boxes in that pool. If hibernation isn't supported, verify that the base image specified in your image definition is created with hibernation support and that the pool uses that image definition.
219-
220-
For more information about Dev Box support for hibernation, see [Configure hibernation in Microsoft Dev Box](how-to-configure-dev-box-hibernation.md).
221-
222-
### Create a dev box by using the developer portal
223-
224-
To verify that customizations are applied correctly, create a dev box in the Microsoft Dev Box developer portal. Follow the steps in [Quickstart: Create and connect to a dev box by using the Microsoft Dev Box developer portal](quickstart-create-dev-box.md), then connect to the newly created dev box and verify that the customizations work as expected.
225-
226-
You can make adjustments to the image definition and create a new dev box to test the changes. When the customizations are correct, you can build a reusable image from the image definition.
142+
For more information, see [Configure hibernation in Microsoft Dev Box](how-to-configure-dev-box-hibernation.md).
227143

228144
## Related content
229145

230146
- [Microsoft Dev Box customizations](concept-what-are-dev-box-customizations.md)
231-
- [Write a customization file for a dev box](./how-to-write-customization-file.md)
232-
- [Add and configure a catalog from GitHub or Azure Repos](../deployment-environments/how-to-configure-catalog.md)
147+
- [Configure team customizations](how-to-configure-team-customizations.md)
148+
- [Add and configure a catalog from GitHub or Azure Repos](how-to-configure-catalog.md)

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

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,19 @@ ms.custom:
1111
- ai-gen-title
1212
- ai-seo-date:04/19/2025
1313
- ai-gen-description
14+
- ai-usage: ai-assisted
1415
ms.topic: how-to
15-
ms.date: 08/15/2025
16+
ms.date: 02/06/2026
1617
---
1718

1819

1920
# Configure user customizations for dev boxes
2021

2122
You can personalize your Microsoft Dev Box by uploading a user customization file. User customization files let you configure your dev box with your preferred personal settings and apps, so you can start coding faster. This article explains how to create, test, and upload a user customization file from your local drive or repository using Visual Studio (VS) Code. You also learn how to validate your file and manage customization settings for projects.
2223

23-
Use customizations in Microsoft Dev Box in two ways: team customizations create a shared configuration for a team, and user customizations create a personal configuration for an individual developer. The following table shows the differences between the two types of customizations.
24+
Dev Box customizations work in two ways: team customizations create shared configurations for teams, and user customizations create personal configurations for individual developers. For a detailed comparison, see [Microsoft Dev Box customizations](concept-what-are-dev-box-customizations.md).
2425

25-
| Feature | Team customizations | User customizations |
26-
|-----------------------------|---------------------------|--------------------------------------|
27-
| Set up on | Dev box pool | Dev box |
28-
| Customizations apply to | All dev boxes in pool | Individual dev box |
29-
| Easily shareable | Yes | No |
30-
| Customizations file name | Imagedefinition.yaml | *myfilename.yaml* or *workload.yaml* |
31-
| Source | Catalog | Upload or personal repository |
32-
| Supports key vault secrets | Yes | Yes |
33-
34-
User customizations help ensure that developers comply with company guardrails; only tasks custom tasks preapproved through a catalog are available to developers to use in their customization files. Standard dev box users can't run built-in PowerShell and WinGet tasks in a system context, which prevents privilege escalation.
26+
User customizations help ensure that developers comply with company guardrails; only tasks preapproved through a catalog are available to developers. Standard dev box users can't run built-in PowerShell and WinGet tasks in a system context, which prevents privilege escalation.
3527

3628
User customizations can be enabled or disabled at the project level. When you create a project, user customizations are on by default.
3729

@@ -42,18 +34,9 @@ To complete the steps in this article:
4234

4335
- Set up a [dev center with a dev box definition, dev box pool, and dev box project](./quickstart-configure-dev-box-service.md) so you can create a dev box.
4436
- Join the Dev Box Users security group for at least one project.
45-
- Attach a catalog to the dev center with tasks you use in your customization file. If you don't have a catalog, see [Add and configure a catalog from GitHub or Azure Repos](../deployment-environments/how-to-configure-catalog.md).
46-
47-
48-
## Permissions required to set up customizations
49-
50-
To create and apply customizations to a dev box, you need the following permissions:
37+
- Attach a catalog to the dev center with tasks you use in your customization file. If you don't have a catalog, see [Add and manage catalogs in Microsoft Dev Box](how-to-configure-catalog.md).
5138

52-
| Action | Permission or role |
53-
|----------------------------------------------------|-------------------------|
54-
| Enable or disable user customizations on a project | Write permission on the project. |
55-
| Create a customization file | None specified. Anyone can create a customization file. |
56-
| Use the developer portal to upload and apply a YAML file during dev box creation | Dev Box User |
39+
For permissions required to configure customizations, see [Permissions for customizations](concept-what-are-dev-box-customizations.md#permissions-for-customizations).
5740

5841
## Create a user customization file
5942

@@ -186,4 +169,4 @@ If you create a dev box with user customizations in a project where user customi
186169
187170
- [Microsoft Dev Box customizations](concept-what-are-dev-box-customizations.md)
188171
- [Configure dev center imaging](how-to-configure-dev-center-imaging.md)
189-
- [Add and configure a catalog from GitHub or Azure Repos](../deployment-environments/how-to-configure-catalog.md)
172+
- [Add and manage catalogs in Microsoft Dev Box](how-to-configure-catalog.md)

articles/dev-box/how-to-customizations-connect-resource-repository.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ ms.custom:
1111
- ai-gen-title
1212
- ai-seo-date:05/10/2025
1313
- ai-gen-description
14+
- ai-usage: ai-assisted
1415
ms.topic: how-to
15-
ms.date: 09/26/2025
16+
ms.date: 02/06/2026
1617
---
1718

1819
# Securely connect to Azure resources or clone private repositories
@@ -207,5 +208,5 @@ For details on how to add users to DevOps organizations, see [Add organization u
207208
## Related content
208209

209210
- Learn how to [Set and retrieve a secret from Azure Key Vault using the Azure portal](/azure/key-vault/secrets/quick-create-portal).
210-
- Learn how to [Add and configure a catalog from GitHub or Azure Repos](../deployment-environments/how-to-configure-catalog.md).
211+
- Learn how to [Add and manage catalogs in Microsoft Dev Box](how-to-configure-catalog.md).
211212
- Learn how to [Use service principals & managed identities in Azure DevOps](/azure/devops/integrate/get-started/authentication/service-principal-managed-identity).

0 commit comments

Comments
 (0)