Manage a dev box definition
In this article, you learn how to manage a dev box definition by using the Azure portal. A dev box definition is a Microsoft Dev Box resource that specifies the source image, compute size, and storage size for a dev box.
Depending on their task, development teams have different software, configuration, compute, and storage requirements. You can create a new dev box definition to fulfill each team's needs. There's no limit to the number of dev box definitions that you can create, and you can use dev box definitions across multiple projects in a dev center.
Permissions
To manage a dev box definition, you need the following permissions:
| Action | Permissions required |
|---|---|
| Create, delete, or update a dev box definition | Owner, Contributor, or Write permissions on the dev center in which you want to create the dev box definition. |
Sources of images
When you create a dev box definition, you need to select a virtual machine image. Microsoft Dev Box supports the following types of images:
- Preconfigured images from Azure Marketplace
- Custom images stored in an Azure compute gallery
Azure Marketplace
Azure Marketplace gives you quick access to various images, including images that are preconfigured with productivity tools like Microsoft Teams and provide optimal performance.
When you're selecting an Azure Marketplace image, consider using an image that has the latest version of Windows 11 Enterprise and the Microsoft 365 apps installed.
Azure Compute Gallery
Azure Compute Gallery enables you to store and manage a collection of custom images. You can build an image to your dev team's exact requirements and store it in a compute gallery.
To use the custom image while creating a dev box definition, attach the compute gallery to your dev center in Microsoft Dev Box. Follow these steps to attach a compute gallery to a dev center.
Image versions
When you select an image to use in your dev box definition, you must specify which version of the image you want to use:
- Numbered image versions: If you want a consistent dev box definition in which the base image doesn't change, use a specific, numbered version of the image. Using a numbered version ensures that all the dev boxes in the pool always use the same version of the image.
- Latest image versions: If you want a flexible dev box definition in which you can update the base image as requirements change, use the latest version of the image. This choice ensures that new dev boxes use the most recent version of the image. Existing dev boxes aren't modified when an image version is updated.
Create a dev box definition
In Microsoft Dev Box, you can create multiple dev box definitions to meet the needs of your developer teams. You associate dev box definitions with a dev center.
The following steps show you how to create a dev box definition by using an existing dev center. If you don't have an available dev center, follow the steps in Quickstart: Configure Microsoft Dev Box to create one.
Sign in to the Azure portal.
In the search box, enter dev center. In the list of results, select Dev centers.
Open the dev center in which you want to create the dev box definition, and then select Dev box definitions.
On the Dev box definitions page, select Create.
On the Create dev box definition pane, enter the following values:
Setting Value Note Name Enter a descriptive name for your dev box definition. You can't change the dev box definition name after creation. Image Select the base operating system for the dev box. You can select an image from Azure Marketplace or from Azure Compute Gallery.
If you're creating a dev box definition for testing purposes, consider using the Visual Studio 2022 Enterprise on Windows 11 Enterprise + Microsoft 365 Apps 22H2 image or Visual Studio 2022 Pro on Windows 11 Enterprise + Microsoft 365 Apps 22H2 image.To access custom images when you create a dev box definition, you can use Azure Compute Gallery. For more information, see Configure Azure Compute Gallery. Image version Select a specific, numbered version to ensure that all the dev boxes in the pool always use the same version of the image. Select Latest to ensure that new dev boxes use the latest image available. Selecting the Latest image version enables the dev box pool to use the most recent version of your chosen image from the gallery. This approach ensures the created dev boxes stay up to date with the latest tools and code for your image. Existing dev boxes aren't modified when an image version is updated. Compute Select the compute combination for your dev box definition. Dev boxes use Dsv5-series virtual machines for compute. Storage Select the amount of storage for your dev box definition. Dev boxes use Azure Premium SSDs for storage. Enable hibernation Leave this checkbox unselected. 
Select Create.
Note
Microsoft Dev Box doesn't support:
- Preview builds from the Windows Insider Program.
- Dev box definitions with 4 core SKUs.
Update a dev box definition
Over time, your needs for dev boxes can change. You might want to move from a Windows 10 base operating system to a Windows 11 base operating system, or increase the default compute specification for your dev boxes. Your initial dev box definitions might no longer be appropriate for your needs. You can update a dev box definition so new dev boxes use the new configuration.
When you update the image used in a dev box definition, you must ensure that you have sufficient IP addresses available in your virtual network. Additional free IP addresses are necessary for the Azure Network connection health check. If the health check fails the dev box definition will not update. You need 1 additional IP address per dev box, and two IP addresses for the health check and Dev Box infrastructure.
You can update the image, image version, compute, and storage settings for a dev box definition:
Sign in to the Azure portal.
In the search box, enter dev center. In the list of results, select Dev centers.
Open the dev center that contains the dev box definition that you want to update, and then select Dev box definitions.
Select the dev box definitions that you want to update, and then select the edit (pencil) button.
On the page for editing a dev box definition, you can select a new image, change the image version, change the compute, or modify the available storage.
Select Save.
Delete a dev box definition
You can delete a dev box definition when you no longer want to use it. Deleting a dev box definition is permanent and can't be undone. Dev box definitions can't be deleted if one or more dev box pools are using them.
To delete a dev box definition in the Azure portal:
Sign in to the Azure portal.
In the search box, enter dev center. In the list of results, select Dev centers.
Open the dev center from which you want to delete the dev box definition, and then select Dev box definitions.
Select the dev box definition that you want to delete, and then select Delete.
In the warning message, select OK.
