• Reference: imagedefinition.yaml files
  • name
  • image
  • tasks

Reference: imagedefinition.yaml files

A Dev Box yaml allows you to define customization Tasks that ought to run during Dev Box creation. A devbox.yaml file may live in the same repository as the primary source code being used by the dev team, or in a centralized repository of configurations.

Example Image Definition yaml:

$schema: 1.0
name: project-sample-1
image: MicrosoftWindowsDesktop_windows-ent-cpc_win11-21h2-ent-cpc-m365
tasks:
  - task: "powershell"
    inputs:
      command: 

name

Required

A friendly name for the image definition associated with this devbox.yaml. This controls the name of theimage definition available when creating and updating pools.

name: myVSDevBox

image

Required

The image you would like to use as the base image for your image definition.

image: MicrosoftWindowsDesktop_windows-ent-cpc_win11-21h2-ent-cpc-m365

To get a list of images that your DevCenter has access to, use this az cli command

az devcenter admin image list --dev-center-name CustomizationsImagingHQ --resource-group TeamCustomizationsImagingRG --query "[].name"

You would need the DevCenter az cli extension: az extension add --name devcenter

Custom images from an Azure Compute Gallery are not supported until the end of Aug 24.

tasks

Required

An object collection of Dev Box customization tasks to be executed when provisioning a Dev Box. The specific inputs provided to a task varies by task.

Example:

tasks:
    - name: winget
      parameters:
        package:  GitHub.GitHubDesktop