Microsoft.DevTestLab labs 2015-05-21-preview

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@2015-05-21-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    artifactsStorageAccount: 'string'
    createdDate: 'string'
    defaultStorageAccount: 'string'
    defaultVirtualNetworkId: 'string'
    labStorageType: 'string'
    provisioningState: 'string'
    storageAccounts: [
      'string'
    ]
    vaultName: 'string'
  }
}

Property values

labs

Name Description Value
name The resource name string (required)

Character limit: 1-50

Valid characters:
Alphanumerics, underscores, and hyphens.
location The location of the resource. string
tags The tags of the resource. Dictionary of tag names and values. See Tags in templates
properties The properties of the resource. LabProperties

LabProperties

Name Description Value
artifactsStorageAccount The artifact storage account of the lab. string
createdDate The creation date of the lab. string
defaultStorageAccount The lab's default storage account. string
defaultVirtualNetworkId The default virtual network identifier of the lab. string
labStorageType The type of the lab storage. 'Premium'
'Standard'
provisioningState The provisioning status of the resource. string
storageAccounts The storage accounts of the lab. string[]
vaultName The name of the key vault of the lab. string

Quickstart templates

The following 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 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
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

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": "2015-05-21-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "artifactsStorageAccount": "string",
    "createdDate": "string",
    "defaultStorageAccount": "string",
    "defaultVirtualNetworkId": "string",
    "labStorageType": "string",
    "provisioningState": "string",
    "storageAccounts": [ "string" ],
    "vaultName": "string"
  }
}

Property values

labs

Name Description Value
type The resource type 'Microsoft.DevTestLab/labs'
apiVersion The resource api version '2015-05-21-preview'
name The resource name string (required)

Character limit: 1-50

Valid characters:
Alphanumerics, underscores, and hyphens.
location The location of the resource. string
tags The tags of the resource. Dictionary of tag names and values. See Tags in templates
properties The properties of the resource. LabProperties

LabProperties

Name Description Value
artifactsStorageAccount The artifact storage account of the lab. string
createdDate The creation date of the lab. string
defaultStorageAccount The lab's default storage account. string
defaultVirtualNetworkId The default virtual network identifier of the lab. string
labStorageType The type of the lab storage. 'Premium'
'Standard'
provisioningState The provisioning status of the resource. string
storageAccounts The storage accounts of the lab. string[]
vaultName The name of the key vault of the lab. string

Quickstart templates

The following 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 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
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

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@2015-05-21-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      artifactsStorageAccount = "string"
      createdDate = "string"
      defaultStorageAccount = "string"
      defaultVirtualNetworkId = "string"
      labStorageType = "string"
      provisioningState = "string"
      storageAccounts = [
        "string"
      ]
      vaultName = "string"
    }
  })
}

Property values

labs

Name Description Value
type The resource type "Microsoft.DevTestLab/labs@2015-05-21-preview"
name The resource name string (required)

Character limit: 1-50

Valid characters:
Alphanumerics, underscores, and hyphens.
location The location of the resource. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags The tags of the resource. Dictionary of tag names and values.
properties The properties of the resource. LabProperties

LabProperties

Name Description Value
artifactsStorageAccount The artifact storage account of the lab. string
createdDate The creation date of the lab. string
defaultStorageAccount The lab's default storage account. string
defaultVirtualNetworkId The default virtual network identifier of the lab. string
labStorageType The type of the lab storage. "Premium"
"Standard"
provisioningState The provisioning status of the resource. string
storageAccounts The storage accounts of the lab. string[]
vaultName The name of the key vault of the lab. string