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/concept-what-are-team-customizations.md
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ ms.service: dev-box
7
7
ms.custom:
8
8
- ignite-2024
9
9
ms.topic: concept-article
10
-
ms.date: 05/09/2025
10
+
ms.date: 05/10/2025
11
11
12
12
#customer intent: As a Dev Center Admin or Project Admin, I want to understand how to use Dev Box customizations so that I can create efficient, ready-to-code configurations for my development teams.
13
13
---
@@ -41,25 +41,25 @@ Microsoft Dev Box offers two ways to use customizations.
41
41
42
42
## What is a customization file?
43
43
44
-
Dev Box customizations use a YAML-formatted file to specify a list of tasks to apply from the dev center or a catalog when developers are creating a dev box. These tasks identify the catalog task and provide parameters like the name of the software to install. Developers can create their own customization files or use a shared customization file.
44
+
Dev Box customizations use a YAML-formatted file to specify a list of tasks to apply from the dev center or a catalog when developers create a dev box. These tasks identify the catalog task and provide parameters like the name of the software to install. Developers can create their own customization files or use a shared customization file.
45
45
46
46
You can use secrets from your Azure key vault in your customization file to clone private repositories, or with any custom task you author that requires an access token.
47
47
48
-
## What are tasks?
48
+
## What are tasks
49
49
50
-
Dev Box customization tasks are wrappers for PowerShell scripts. You use them to define reusable components that your teams can use in their customizations. WinGet and PowerShell tasks are available through the platform, and new ones can be added through a catalog. Tasks can either be run in a system context, or a user context after login.
51
-
-Team customizations are defined by project admins and can use both custom and built-in tasks.
52
-
- User customizations can only use system tasks if the user is an administrator, or if the tasks are custom tasks pre-approved by through a catalog. Standard dev box users cannot run the built-in PowerShell and WinGet tasks in a system context, ensuring that there is no escalation of privilege.
50
+
Dev Box customization tasks are wrappers for PowerShell scripts. You use them to define reusable components that your teams can use in their customizations. WinGet and PowerShell tasks are available through the platform, and new ones can be added through a catalog. Tasks can run in either a system context or a user context after sign-in.
51
+
-Project admins define team customizations, which can use both custom and built-in tasks.
52
+
- User customizations can only use system tasks if the user is an administrator, or if the tasks are custom tasks preapproved by through a catalog. Standard dev box users can't run built-in PowerShell and WinGet tasks in a system context, which prevents privilege escalation.
53
53
54
-
When you're creating tasks, determine which need to run in a system context and which of them can run in a user context (after sign-in).
54
+
When you create tasks, determine which need to run in a system context and which can run in a user context after sign-in.
55
55
56
56
## Differences between team customizations and user customizations
57
57
58
58
Dev Box team customizations allow developer team leads and IT admins to preconfigure customization files for dev box pools, eliminating the need for developers to go through manual setup.
59
59
60
-
Microsoft recommends using team customizations to secure and standardize dev box deployments across a team. Sharing common YAML files among developer teams can be inefficient and lead to errors, as well as violate compliance policies.
60
+
Microsoft recommends using team customizations to secure and standardize dev box deployments for a team. Sharing common YAML files among developer teams can be inefficient, lead to errors, and violate compliance policies.
61
61
62
-
In addition to team customizations, individual developers can upload a customization file when creating their dev box to control the development environment. Developers should use individual customizations only for personal settings and apps.
62
+
In addition to team customizations, individual developers can upload a customization file when they create their dev box to control the development environment. Developers should use individual customizations for personal settings and apps only.
63
63
64
64
## How do customizations work?
65
65
Team customization and user customizations are both YAML-based files that specify a list of tasks to apply when creating a dev box. Select the appropriate tab to learn more about how each type of customization works.
@@ -69,16 +69,16 @@ Team customization and user customizations are both YAML-based files that specif
69
69
70
70
You can use team customizations to define a shared Dev Box configuration for each of your development teams without having to invest in setting up an imaging solution like Packer or Azure virtual machine (VM) image templates. Team customizations provide a lightweight alternative that allows central platform engineering teams to delegate Dev Box configuration management to the teams that use them.
71
71
72
-
Team customizations also offer an in-built way of optimizing your team's Dev Box customizations by flattening them into a custom image. You use the same customization file, without the need to manage added infrastructure or maintain image templates.
72
+
Team customizations also offer a built-in way to optimize your team's Dev Box customizations by flattening them into a custom image. You use the same customization file, without the need to manage added infrastructure or maintain image templates.
73
73
74
-
When you configure Dev Box team customizations for your organization, careful planning and informed decision-making are essential. The following diagram provides an overview of the process and highlights key decision points.
74
+
Configuring Dev Box team customizations for your organization requires careful planning and informed decision-making. The following diagram provides an overview of the process and highlights key decision points.
75
75
76
76
77
77
:::image type="content" source="media/concept-what-are-team-customizations/dev-box-customizations-workflow.svg" alt-text="Diagram that shows the workflow for Dev Box team customizations, including steps for planning, configuring, and deploying customizations." lightbox="media/concept-what-are-team-customizations/dev-box-customizations-workflow.svg":::
78
78
79
79
#### Configure your Dev Box service for team customizations
80
80
81
-
To set up your Dev Box service to support team customizations, follow these steps:
81
+
Set up your Dev Box service to support team customizations by following these steps:
82
82
83
83
1.**Configure your dev center:**
84
84
1. Enable project-level catalogs.
@@ -90,11 +90,11 @@ To set up your Dev Box service to support team customizations, follow these step
90
90
1. Host in Azure Repos or GitHub.
91
91
1. Add tasks.
92
92
1. Attach to a dev center.
93
-
1.**Create a customization file:**
93
+
1.**Create a YAML customization file:**
94
94
1. Create a customization file called imagedefinition.yaml.
95
95
1.**Specify an image in a dev box pool:**
96
96
1. Create or modify a dev box pool and specify imagedefinition.yaml as the image definition.
97
-
1.**Choose how you'll use the image definition:**
97
+
1.**Choose how to use the image definition:**
98
98
- Run the tasks in the image definition at the time of every dev box creation
99
99
- Optimize your image definition into a custom image.
100
100
1.**Create dev box:**
@@ -125,14 +125,14 @@ To set up your Dev Box service to support user customizations, follow these step
125
125
1.**Create dev box:**
126
126
1. Create your dev box from the configured pool by using the developer portal.
127
127
1. Upload and validate your customization file as you create your dev box.
128
-
1.Dev box is created with customizations.
128
+
1.The dev box is created with customizations.
129
129
130
130
To learn more about user customizations, see [Write a user customization file for a dev box](how-to-write-user-customization-file.md).
131
131
132
132
---
133
133
134
134
## Related content
135
135
136
-
-[Quickstart: Create a dev box by using team customizations](quickstart-team-customizations.md)
137
-
-[Configure imaging for Dev Box team customizations](how-to-configure-customization-imaging.md)
136
+
-[Quickstart: create a dev box by using team customizations](quickstart-team-customizations.md)
137
+
-[Configure imaging for dev box team customizations](how-to-configure-customization-imaging.md)
0 commit comments