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/dev-box/how-to-write-individual-customization-file.md
+15-12Lines changed: 15 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,25 @@
1
1
---
2
-
title: Write a Customization File
3
-
description: Learn how to create, test, and edit a customization file for your dev box by using Visual Studio Code.
2
+
title: Write an Individual Customization File for Your Dev Box
3
+
description: Learn how to upload and validate individual customization files for dev boxes directly from your local drive or repository.
4
+
#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.
4
5
author: RoseHJM
5
6
ms.author: rosemalcolm
6
7
ms.service: dev-box
7
8
ms.custom:
8
9
- ignite-2024
10
+
- ai-gen-docs-bap
11
+
- ai-gen-title
12
+
- ai-seo-date:04/19/2025
13
+
- ai-gen-description
9
14
ms.topic: how-to
10
-
ms.date: 02/21/2025
11
-
12
-
#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.
15
+
ms.date: 04/19/2025
13
16
---
14
17
15
18
# Write an individual customization file for a dev box
16
19
17
-
The Dev Box individual customizations feature helps you streamline the setup of your dev boxes. Getting started on a new project or team can be complex and time-consuming. With customizations, you can configure your dev boxes with the applications, tools, repositories, code libraries, packages, and build scripts that you need. This article will guide you through the process of creating, testing, and editing an individual customization file for your dev box using Visual Studio Code (VS Code).
20
+
The Dev Box individual customizations feature helps you streamline the setup of your dev boxes. Starting a new project or joining a team is often complex and timeconsuming. With customizations, you can configure your dev boxes with the applications, tools, repositories, code libraries, packages, and build scripts that you need. This article guides you through the process of creating, testing, and editing an individual customization file for your dev box using Visual Studio Code (VS Code).
18
21
19
-
There are two ways to use customizations in Microsoft Dev Box. Team customizations are used to create a shared configuration for a team of developers. Individual customizations are used to create a personal configuration for an individual developer. The following table summarizes the differences between the two types of customizations.
22
+
You can use customizations in Microsoft Dev Box in two ways. Team customizations are used to create a shared configuration for a team of developers. Individual customizations are used to create a personal configuration for an individual developer. The following table summarizes the differences between the two types of customizations.
20
23
21
24
| Feature | Team customizations | Individual customizations |
@@ -60,15 +63,15 @@ You can create and manage customization files by using VS Code. You can use the
60
63
61
64
:::image type="content" source="media/how-to-write-individual-customization-file/dev-box-command-apply-tasks.png" alt-text="Screenshot of the Dev Box command palette in Visual Studio Code, showing the command for applying customization tasks.":::
62
65
63
-
1. The customization file runs immediately and applies the specified tasks to your test dev box. Inspect the changes, and check the VS Code terminal for any errors or warnings generated during the task execution.
66
+
1. The customization file runs and applies the specified tasks to your test dev box. Inspect the changes, and check the VS Code terminal for any errors or warnings generated during the task execution. Review the VS Code terminal for errors or warnings during task execution.
64
67
65
68
1. When the customization file runs successfully, upload it to your catalog.
66
69
67
70
### Customize your dev box by using existing WinGet Configuration files
68
71
69
72
WinGet configuration takes a config-as-code approach to defining the unique sets of software and configuration settings needed to get your Windows environment in a ready-to-code state. You can also use these configuration files to set up a dev box, by using a WinGet task included in the Microsoft-provided quickstart catalog.
70
73
71
-
The following example shows a dev box customization file that calls an existing WinGet Desired State Configuration (DSC) file:
74
+
This example shows a dev box customization file that uses an existing WinGet Desired State Configuration (DSC) file:
72
75
73
76
```yml
74
77
tasks:
@@ -82,7 +85,7 @@ To learn more, see [WinGet configuration](https://aka.ms/winget-configuration).
82
85
## Create a dev box using an individual customization file
83
86
84
87
You can use an individual customization file by uploading it from a local drive when creating your dev box, or by downloading it from a repository.
85
-
Customization files stored in a repository must be called workload.yaml. Customization files that are stored locally for upload should be called myfilename.yaml.
88
+
Customization files stored in a repository must be called workload.yaml. Customization files that are stored locally for upload should be called myfilename.yaml. Name customization files stored locally for upload as *myfilename.yaml*.
86
89
87
90
### Upload a file
88
91
1. In the [developer portal](https://aka.ms/devbox-portal), select **New** > **New dev box**.
@@ -99,7 +102,7 @@ Customization files stored in a repository must be called workload.yaml. Customi
99
102
100
103
:::image type="content" source="media/how-to-write-individual-customization-file/customize-dev-box-validate.png" alt-text="Screenshot of the Validate button in the developer portal, showing the option to validate the customization file before proceeding.":::
101
104
102
-
1. Check the dev box creation summary and select **Create**.
105
+
1. Review the dev box creation summary, and then select **Create**.
103
106
104
107
:::image type="content" source="media/how-to-write-individual-customization-file/customized-dev-box-create.png" alt-text="Screenshot of the dev box creation summary page in the developer portal, showing the option to create a customized dev box.":::
105
108
@@ -118,7 +121,7 @@ Customization files stored in a repository must be called workload.yaml. Customi
118
121
119
122
:::image type="content" source="media/how-to-write-individual-customization-file/customize-dev-box-validate.png" alt-text="Screenshot of the Validate button in the developer portal, showing the option to validate the customization file before proceeding.":::
120
123
121
-
1. Check the dev box creation summary and select **Create**.
124
+
1. Review the dev box creation summary, and then select **Create**.
122
125
123
126
:::image type="content" source="media/how-to-write-individual-customization-file/customized-dev-box-create.png" alt-text="Screenshot of the dev box creation summary page in the developer portal, showing the option to create a customized dev box.":::
0 commit comments