Skip to content

create-lab-windows-vm-bicep.md

Latest commit

 

History

History
128 lines (83 loc) · 4.78 KB

create-lab-windows-vm-bicep.md

File metadata and controls

128 lines (83 loc) · 4.78 KB
title Create a lab in Azure DevTest Labs using Bicep
description Use Bicep to create a lab that has a virtual machine in Azure DevTest Labs.
ms.author rosemalcolm
author RoseHJM
ms.topic quickstart
ms.custom subject-armqs, mode-arm, devx-track-bicep, UpdateFrequency2
ms.date 12/15/2025

Quickstart: Use Bicep to create a lab in DevTest Labs

This quickstart uses Bicep to create a lab in Azure DevTest Labs that has one Windows Server 2019 Datacenter virtual machine (VM) in it.

[!INCLUDE About Bicep]

In this quickstart, you:

[!div class="checklist"]

  • Review the Bicep file.
  • Deploy the Bicep file to create a lab and VM.
  • Verify the deployment.
  • Clean up resources.

Prerequisites

  • An Azure subscription where you have permissions to create and manage resources. If you don't have one, create a free account.

Azure CLI

Azure PowerShell

Review the Bicep file

Review the Bicep file. The file uses the following resource types to take the following actions:

:::code language="bicep" source="~/quickstart-templates/quickstarts/microsoft.devtestlab/dtl-create-lab-windows-vm-claimed/main.bicep":::

Deploy the Bicep file

  1. Save the Bicep file as main.bicep to your local computer.

  2. Run the following commands using either Azure CLI or Azure PowerShell from the folder where you saved the Bicep file. In the commands, replace the following placeholders:

    • <location>: Azure region you want to use.
    • <lab-name>: Name for the new lab.
    • <vm-name>: Name for the new VM.
    • <user-name>: Username of a local account to create on the new VM. You're prompted to enter a password for the local account. Be sure not to use any disallowed usernames or passwords listed in the OSProfile section of Virtual Machines - Create or Update.

    Azure CLI

    az group create --name exampleRG --location <location>
az deployment group create --resource-group exampleRG --template-file main.bicep --parameters labName=<lab-name> vmName=<vm-name> userName=<user-name>

    Azure PowerShell

    New-AzResourceGroup -Name exampleRG -Location <location>
New-AzResourceGroupDeployment -ResourceGroupName exampleRG -TemplateFile ./main.bicep -labName "<lab-name>" -vmName "<vm-name>" -userName "<user-name>"

The deployment also creates a resource group for the VM named <lab-name>-<vm-name>-<numerical-string>. This resource group contains VM resources like the IP address, network interface, and disk.

When the deployment completes, the output shows data about the resources and the deployment.

Validate the deployment

Use Azure CLI or Azure PowerShell to list the deployed resources in the resource group. You can also use the Azure portal.

Azure CLI

az resource list --resource-group exampleRG

Azure PowerShell

Get-AzResource -ResourceGroupName exampleRG

Clean up resources

You can use Azure CLI or Azure PowerShell to delete the resource group and all of its resources when you don't need them anymore. You can also use the Azure portal.

If you want to manually delete the lab's resource group, you must delete the lab first. You can't delete a resource group that has a lab in it.

CLI

az group delete --name exampleRG

PowerShell

Remove-AzResourceGroup -Name exampleRG

Next step

To connect to lab VMs, see the next tutorial.

[!div class="nextstepaction"] Access, claim, and connect to a DevTest Labs VM

Related content