Share via

Microsoft.DevTestLab labs 2016-05-15

  • Article

Bicep resource definition

The labs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevTestLab/labs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevTestLab/labs@2016-05-15' = {
  location: 'string'
  name: 'string'
  properties: {
    labStorageType: 'string'
    premiumDataDisks: 'string'
    provisioningState: 'string'
    uniqueIdentifier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

LabProperties

Name Description Value
labStorageType Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. 'Premium'
'Standard'
premiumDataDisks The setting to enable usage of premium data disks.
When its value is 'Enabled', creation of standard or premium data disks is allowed.
When its value is 'Disabled', only creation of standard data disks is allowed.		 'Disabled'
'Enabled'
provisioningState The provisioning status of the resource. string
uniqueIdentifier The unique immutable identifier of a resource (Guid). string

Microsoft.DevTestLab/labs

Name Description Value
location The location of the resource. string
name The resource name string (required)
properties The properties of the resource. LabProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
DevTest Lab AVM Resource Module for DevTest Lab

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Creates a lab in Azure DevTest Labs with a claimed VM This template creates a new DevTest Lab / DTL instance with a claimed Windows Server 2019 Datacenter VM in it. More Azure Resource Manager Quickstart Templates for Azure DevTest Labs available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

ARM template resource definition

The labs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevTestLab/labs resource, add the following JSON to your template.

{
  "type": "Microsoft.DevTestLab/labs",
  "apiVersion": "2016-05-15",
  "name": "string",
  "location": "string",
  "properties": {
    "labStorageType": "string",
    "premiumDataDisks": "string",
    "provisioningState": "string",
    "uniqueIdentifier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

LabProperties

Name Description Value
labStorageType Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. 'Premium'
'Standard'
premiumDataDisks The setting to enable usage of premium data disks.
When its value is 'Enabled', creation of standard or premium data disks is allowed.
When its value is 'Disabled', only creation of standard data disks is allowed.		 'Disabled'
'Enabled'
provisioningState The provisioning status of the resource. string
uniqueIdentifier The unique immutable identifier of a resource (Guid). string

Microsoft.DevTestLab/labs

Name Description Value
apiVersion The api version '2016-05-15'
location The location of the resource. string
name The resource name string (required)
properties The properties of the resource. LabProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevTestLab/labs'

ResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create a new lab in Azure DevTest Labs

Deploy to Azure		 This template creates a new DevTest Lab / DTL instance. More Azure Resource Manager Quickstart Templates for Azure DevTestlab available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates
Creates a lab in Azure DevTest Labs with a claimed VM

Deploy to Azure		 This template creates a new DevTest Lab / DTL instance with a claimed Windows Server 2019 Datacenter VM in it. More Azure Resource Manager Quickstart Templates for Azure DevTest Labs available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates
Creates a lab in Azure DevTest Labs with a Windows Server VM

Deploy to Azure		 This template creates a new DevTest Lab / DTL instance with a Windows Server 2019 Datacenter VM in it. More Azure Resource Manager Quickstart Templates for Azure DevTest Labs available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Terraform (AzAPI provider) resource definition

The labs resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevTestLab/labs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs@2016-05-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      labStorageType = "string"
      premiumDataDisks = "string"
      provisioningState = "string"
      uniqueIdentifier = "string"
    }
  })
}

Property Values

LabProperties

Name Description Value
labStorageType Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. 'Premium'
'Standard'
premiumDataDisks The setting to enable usage of premium data disks.
When its value is 'Enabled', creation of standard or premium data disks is allowed.
When its value is 'Disabled', only creation of standard data disks is allowed.		 'Disabled'
'Enabled'
provisioningState The provisioning status of the resource. string
uniqueIdentifier The unique immutable identifier of a resource (Guid). string

Microsoft.DevTestLab/labs

Name Description Value
location The location of the resource. string
name The resource name string (required)
properties The properties of the resource. LabProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevTestLab/labs@2016-05-15"

ResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
DevTest Lab AVM Resource Module for DevTest Lab