Configure Azure Compute Gallery for Microsoft Dev Box

In this article, you learn how to configure and attach an Azure compute gallery to a dev center in Microsoft Dev Box. With Azure Compute Gallery, you can give developers customized images for their dev box.

Azure Compute Gallery is a service for managing and sharing images. A gallery is a repository that's stored in your Azure subscription and helps you build structure and organization around your image resources.

After you attach a compute gallery to a dev center in Microsoft Dev Box, you can create dev box definitions based on images stored in the compute gallery.

Advantages of using a gallery include:

  • You maintain the images in a single location and use them across dev centers, projects, and pools.
  • Development teams can use the latest version of an image definition to ensure they always receive the most recent image when creating dev boxes.
  • Development teams can standardize on a supported image version until a newer version is validated.

To learn more about Azure Compute Gallery and how to create galleries, see:

Prerequisites

  • A dev center. If you don't have one available, follow the steps in Create a dev center.
  • A compute gallery. Images stored in a compute gallery can be used in a dev box definition, provided they meet the requirements listed in the Compute gallery image requirements section.

Note

Microsoft Dev Box doesn't support community galleries.

A gallery used to configure dev box definitions must have at least one image definition and one image version.

When you create a virtual machine (VM) image, select an image from the Azure Marketplace that's compatible with Microsoft Dev Box. The following are examples of compatible images:

The image version must meet the following requirements:

  • Generation 2

  • Hyper-V v2

  • Windows OS

    • Windows 10 Enterprise version 20H2 or later
    • Windows 11 Enterprise 21H2 or later
  • Generalized VM image

    • You must create the image by using these three sysprep options: /generalize /oobe /mode:vm. For more information, see Sysprep Command-Line Options.
    • To speed up the dev box creation time:
      • Disable the reserved storage state feature in the image by using the following command: DISM.exe /Online /Set-ReservedStorageState /State:Disabled. For more information, see DISM Storage reserve command-line options.
      • Run defrag and chkdsk during image creation, wait for them to finish. And disable chkdisk and defrag scheduled task.
  • Single-session VM images (Multiple-session VM images aren't supported.)

  • No recovery partition For information about how to remove a recovery partition, see the Windows Server command: delete partition.

  • Default 64-GB OS disk size The OS disk size is automatically adjusted to the size specified in the SKU description of the Windows 365 license.

  • The image definition must have trusted launch enabled as the security type. You configure the security type when you create the image definition.

    Screenshot that shows Windows 365 image requirement settings.

Note

  • Microsoft Dev Box image requirements exceed Windows 365 image requirements and include settings to optimize dev box creation time and performance.
  • Any image that doesn't meet Windows 365 requirements isn't shown in the list of images that are available for creation.

When you use an Azure Compute Gallery image to create a dev box definition, the Windows 365 service validates the image to ensure that it meets the requirements to be provisioned for a dev box. Microsoft Dev Box replicates the image to the regions specified in the attached network connections, so the images are present in the region required for dev box creation.

To allow the services to perform these actions, you must provide permissions to your gallery as follows.

Add a user-assigned identity to the dev center

  1. Follow the steps to create a user-assigned managed identity.

  2. Sign in to the Azure portal.

  3. In the search box, enter dev box. In the list of results, select Dev centers.

  4. Open your dev center. On the left menu, select Identity.

  5. On the User assigned tab, select + Add.

  6. In the Add user assigned managed identity pane, select the user-assigned managed identity that you created in step 1, and then select Add.

    Screenshot that shows the pane for adding a user-assigned managed identity.

Assign roles

Microsoft Dev Box behaves differently depending how you attach your gallery:

  • When you use the Azure portal to attach the gallery to your dev center, the Dev Box service creates the necessary role assignments automatically after you attach the gallery.
  • When you use the Azure CLI to attach the gallery to your dev center, you must manually create the Windows 365 service principal and the dev center's managed identity role assignments before you attach the gallery.

Use the following steps to manually assign each role.

Windows 365 service principal

  1. Sign in to the Azure portal.

  2. In the search box, enter Azure Compute Gallery. In the list of results, select the gallery that you want to attach to the dev center.

  3. On the left menu, select Access Control (IAM).

  4. Select Add > Add role assignment.

  5. Assign the following role. For detailed steps, see Assign Azure roles using the Azure portal.

    Setting Value
    Role Select Reader.
    Assign access to Select User, group, or service principal.
    Members Search for and select Windows 365.

Managed identity for the dev center

  1. In the Azure portal, open the gallery that you want to attach to the dev center. You can also search for Azure Compute Gallery to find your gallery.

  2. On the left menu, select Access Control (IAM).

  3. Select Add > Add role assignment.

  4. Assign the following role. For detailed steps, see Assign Azure roles using the Azure portal.

    Setting Value
    Role Select Contributor.
    Assign access to Select Managed Identity.
    Members Search for and select the user-assigned managed identity that you created when you added a user-assigned identity to the dev center.

You can use the same managed identity in multiple dev centers and compute galleries. Any dev center with the managed identity added has the necessary permissions to the images in the gallery that has the Owner role assignment added.

To use the images from a compute gallery in dev box definitions, you must first associate the gallery with the dev center by attaching it:

  1. Sign in to the Azure portal.

  2. In the search box, enter dev box. In the list of results, select Dev centers.

  3. Select the dev center that you want to attach the gallery to.

    Screenshot that shows a list of existing dev centers.

  4. On the left menu, select Azure compute galleries to list the galleries that are attached to this dev center.

    Screenshot that shows the page for compute galleries, with no galleries listed.

  5. Select + Add to select a gallery to attach.

  6. In Add Azure compute gallery, select your gallery. If you have access to more than one gallery that has the same name, the subscription name appears in parentheses.

    Screenshot that shows the area for selecting a gallery.

  7. If there's a name conflict in the dev center, you must provide a unique name to use for this gallery.

  8. Select Add.

  9. Confirm your gallery now appears on the Azure compute galleries page.

    Screenshot that shows the page for compute galleries page with example galleries listed.

After you successfully add a gallery, the images in the gallery are available to select when you create and update dev box definitions.

You can detach galleries from dev centers so their images can no longer be used to create dev box definitions.

Note

You can't remove galleries that are being actively used in dev box definitions. Before you can remove such a gallery, you must delete the associated dev box definition or update the definition to use an image from a different gallery.

  1. Sign in to the Azure portal.

  2. In the search box, enter dev box. In the list of results, select Dev centers.

  3. Select the dev center that you want to remove the gallery from.

  4. On the left menu, select Azure compute galleries to list the galleries that are attached to this dev center.

  5. Select the gallery that you want to remove, and then select Remove.

    Screenshot that shows the page for compute galleries, a selected gallery, and the Remove button.

  6. In the confirmation dialog, select Continue.

The gallery is detached from the dev center. The gallery and its images aren't deleted, and you can reattach it if necessary.