Add a VM to a lab in Azure DevTest Labs

If you have already created your first VM, you likely did so from a pre-loaded marketplace image. Now, if you want to add subsequent VMs to your lab, you can also choose a base that is either a custom image or a formula. This tutorial walks you through using the Azure portal to add a VM to a lab in DevTest Labs.

This article also shows you how to manage the artifacts for a VM in your lab.

Steps to add a VM to a lab in Azure DevTest Labs

  1. Sign in to the Azure portal.
  2. Select All Services, and then select DevTest Labs from the list.
  3. From the list of labs, select the lab in which you want to create the VM.
  4. On the lab's Overview pane, select + Add.

    Add VM button

  5. On the Choose a base pane, select a base for the VM.

  6. On the Virtual machine pane, enter a name for the new virtual machine in the Virtual machine name text box.

    Lab VM pane

  7. Enter a User Name that is granted administrator privileges on the virtual machine.

  8. If you want to use a password stored in an Azure key vault, select Use a saved secret, and specify a key value that corresponds to your secret (password). Otherwise, enter a password in the text field labeled Type a value. To learn about saving secrets in a key vault and using them when creating lab resources, see Store secrets in Azure Key Vault.
  9. The Virtual machine disk type determines which storage disk type is allowed for the virtual machines in the lab.
  10. Select Virtual machine size and select one of the predefined items that specify the processor cores, RAM size, and the hard drive size of the VM to create.
  11. Select Artifacts and - from the list of artifacts - select and configure the artifacts that you want to add to the base image. Note: If you're new to DevTest Labs or configuring artifacts, refer to the Add an existing artifact to a VM section, and then return here when finished.
  12. Select Advanced settings to configure the VM's network options and expiration options.

    To set an expiration option, choose the calendar icon to specify a date on which the VM will be automatically deleted. By default, the VM will never expire.

  13. If you want to view or copy the Azure Resource Manager template, refer to the Save Azure Resource Manager template section, and return here when finished.
  14. Select Create to add the specified VM to the lab.
  15. The lab pane displays the status of the VM's creation - first as Creating, then as Running after the VM has been started.

Note

Add a claimable VM shows you how to make the VM claimable so that it is available for use by any user in the lab.

Add an existing artifact to a VM

While creating a VM, you can add existing artifacts. Each lab includes artifacts from the Public DevTest Labs Artifact Repository as well as artifacts that you've created and added to your own Artifact Repository.

  • Azure DevTest Labs artifacts let you specify actions that are performed when the VM is provisioned, such as running Windows PowerShell scripts, running Bash commands, and installing software.
  • Artifact parameters let you customize the artifact for your particular scenario

To discover how to create artifacts, see the article, Learn how to author your own artifacts for use with DevTest Labs.

  1. Sign in to the Azure portal.
  2. Select All Services, and then select DevTest Labs from the list.
  3. From the list of labs, select the lab containing the VM with which you want to work.
  4. Select My virtual machines.
  5. Select the desired VM.
  6. Select Manage artifacts.
  7. Select Apply artifacts.
  8. On the Apply artifacts pane, select the artifact you wish to add to the VM.
  9. On the Add artifact pane, enter the required parameter values and any optional parameters that you need.
  10. Select Add to add the artifact and return to the Apply artifacts pane.
  11. Continue adding artifacts as needed for your VM.
  12. Once you've added your artifacts, you can change the order in which the artifacts are run. You can also go back to view or modify an artifact.
  13. When you're done adding artifacts, select Apply

Change the order in which artifacts are run

By default, the actions of the artifacts are executed in the order in which they are added to the VM. The following steps illustrate how to change the order in which the artifacts are run.

  1. At the top of the Apply artifacts pane, select the link indicating the number of artifacts that have been added to the VM.

    Number of artifacts added to VM

  2. On the Selected artifacts pane, drag and drop the artifacts into the desired order. Note: If you have trouble dragging the artifact, make sure that you are dragging from the left side of the artifact.
  3. Select OK when done.

View or modify an artifact

The following steps illustrate how to view or modify the parameters of an artifact:

  1. At the top of the Apply artifacts pane, select the link indicating the number of artifacts that have been added to the VM.

    Number of artifacts added to VM

  2. On the Selected artifacts pane, select the artifact that you want to view or edit.
  3. On the Add artifact pane, make any needed changes, and select OK to close the Add artifact pane.
  4. Select OK to close the Selected artifacts pane.

Save Azure Resource Manager template

An Azure Resource Manager template provides a declarative way to define a repeatable deployment. The following steps explain how to save the Azure Resource Manager template for the VM being created. Once saved, you can use the Azure Resource Manager template to deploy new VMs with Azure PowerShell.

  1. On the Virtual machine pane, select View ARM Template.
  2. On the View Azure Resource Manager template pane, select the template text.
  3. Copy the selected text to the clipboard.
  4. Select OK to close the View Azure Resource Manager Template pane.
  5. Open a text editor.
  6. Paste in the template text from the clipboard.
  7. Save the file for later use.

Get started with Azure DevTest Labs

New to Azure? Create a free Azure account.

Already on Azure? Get started with your first lab in DevTest Labs.

Get started with Azure DevTest Labs in minutes

Next steps