Share via

Microsoft.DevTestLab labs/virtualmachines 2015-05-21-preview

  • Article

Bicep resource definition

The labs/virtualmachines 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/virtualmachines resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevTestLab/labs/virtualmachines@2015-05-21-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    artifactDeploymentStatus: {
      artifactsApplied: int
      deploymentStatus: 'string'
      totalArtifacts: int
    }
    artifacts: [
      {
        artifactId: 'string'
        parameters: [
          {
            name: 'string'
            value: 'string'
          }
        ]
      }
    ]
    computeId: 'string'
    createdByUser: 'string'
    createdByUserId: 'string'
    customImageId: 'string'
    disallowPublicIpAddress: bool
    fqdn: 'string'
    galleryImageReference: {
      offer: 'string'
      osType: 'string'
      publisher: 'string'
      sku: 'string'
      version: 'string'
    }
    isAuthenticationWithSshKey: bool
    labSubnetName: 'string'
    labVirtualNetworkId: 'string'
    notes: 'string'
    osType: 'string'
    ownerObjectId: 'string'
    password: 'string'
    provisioningState: 'string'
    size: 'string'
    sshKey: 'string'
    userName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ArtifactDeploymentStatusProperties

Name Description Value
artifactsApplied The total count of the artifacts that were successfully applied. int
deploymentStatus The deployment status of the artifact. string
totalArtifacts The total count of the artifacts that were tentatively applied. int

ArtifactInstallProperties

Name Description Value
artifactId The artifact's identifier. string
parameters The parameters of the artifact. ArtifactParameterProperties[]

ArtifactParameterProperties

Name Description Value
name The name of the artifact parameter. string
value The value of the artifact parameter. string

GalleryImageReference

Name Description Value
offer The offer of the gallery image. string
osType The OS type of the gallery image. string
publisher The publisher of the gallery image. string
sku The SKU of the gallery image. string
version The version of the gallery image. string

LabVirtualMachineProperties

Name Description Value
artifactDeploymentStatus The artifact deployment status for the virtual machine. ArtifactDeploymentStatusProperties
artifacts The artifacts to be installed on the virtual machine. ArtifactInstallProperties[]
computeId The resource identifier (Microsoft.Compute) of the virtual machine. string
createdByUser The email address of creator of the virtual machine. string
createdByUserId The object identifier of the creator of the virtual machine. string
customImageId The custom image identifier of the virtual machine. string
disallowPublicIpAddress Indicates whether the virtual machine is to be created without a public IP address. bool
fqdn The fully-qualified domain name of the virtual machine. string
galleryImageReference The Microsoft Azure Marketplace image reference of the virtual machine. GalleryImageReference
isAuthenticationWithSshKey A value indicating whether this virtual machine uses an SSH key for authentication. bool
labSubnetName The lab subnet name of the virtual machine. string
labVirtualNetworkId The lab virtual network identifier of the virtual machine. string
notes The notes of the virtual machine. string
osType The OS type of the virtual machine. string
ownerObjectId The object identifier of the owner of the virtual machine. string
password The password of the virtual machine administrator. string
provisioningState The provisioning status of the resource. string
size The size of the virtual machine. string
sshKey The SSH key of the virtual machine administrator. string
userName The user name of the virtual machine. string

LabVirtualMachineTags

Name Description Value

Microsoft.DevTestLab/labs/virtualmachines

Name Description Value
location The location of the resource. string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: labs
properties The properties of the resource. LabVirtualMachineProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

Quickstart samples

The following quickstart samples deploy 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/virtualmachines 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/virtualmachines resource, add the following JSON to your template.

{
  "type": "Microsoft.DevTestLab/labs/virtualmachines",
  "apiVersion": "2015-05-21-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "artifactDeploymentStatus": {
      "artifactsApplied": "int",
      "deploymentStatus": "string",
      "totalArtifacts": "int"
    },
    "artifacts": [
      {
        "artifactId": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "computeId": "string",
    "createdByUser": "string",
    "createdByUserId": "string",
    "customImageId": "string",
    "disallowPublicIpAddress": "bool",
    "fqdn": "string",
    "galleryImageReference": {
      "offer": "string",
      "osType": "string",
      "publisher": "string",
      "sku": "string",
      "version": "string"
    },
    "isAuthenticationWithSshKey": "bool",
    "labSubnetName": "string",
    "labVirtualNetworkId": "string",
    "notes": "string",
    "osType": "string",
    "ownerObjectId": "string",
    "password": "string",
    "provisioningState": "string",
    "size": "string",
    "sshKey": "string",
    "userName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ArtifactDeploymentStatusProperties

Name Description Value
artifactsApplied The total count of the artifacts that were successfully applied. int
deploymentStatus The deployment status of the artifact. string
totalArtifacts The total count of the artifacts that were tentatively applied. int

ArtifactInstallProperties

Name Description Value
artifactId The artifact's identifier. string
parameters The parameters of the artifact. ArtifactParameterProperties[]

ArtifactParameterProperties

Name Description Value
name The name of the artifact parameter. string
value The value of the artifact parameter. string

GalleryImageReference

Name Description Value
offer The offer of the gallery image. string
osType The OS type of the gallery image. string
publisher The publisher of the gallery image. string
sku The SKU of the gallery image. string
version The version of the gallery image. string

LabVirtualMachineProperties

Name Description Value
artifactDeploymentStatus The artifact deployment status for the virtual machine. ArtifactDeploymentStatusProperties
artifacts The artifacts to be installed on the virtual machine. ArtifactInstallProperties[]
computeId The resource identifier (Microsoft.Compute) of the virtual machine. string
createdByUser The email address of creator of the virtual machine. string
createdByUserId The object identifier of the creator of the virtual machine. string
customImageId The custom image identifier of the virtual machine. string
disallowPublicIpAddress Indicates whether the virtual machine is to be created without a public IP address. bool
fqdn The fully-qualified domain name of the virtual machine. string
galleryImageReference The Microsoft Azure Marketplace image reference of the virtual machine. GalleryImageReference
isAuthenticationWithSshKey A value indicating whether this virtual machine uses an SSH key for authentication. bool
labSubnetName The lab subnet name of the virtual machine. string
labVirtualNetworkId The lab virtual network identifier of the virtual machine. string
notes The notes of the virtual machine. string
osType The OS type of the virtual machine. string
ownerObjectId The object identifier of the owner of the virtual machine. string
password The password of the virtual machine administrator. string
provisioningState The provisioning status of the resource. string
size The size of the virtual machine. string
sshKey The SSH key of the virtual machine administrator. string
userName The user name of the virtual machine. string

LabVirtualMachineTags

Name Description Value

Microsoft.DevTestLab/labs/virtualmachines

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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/virtualmachines 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/virtualmachines resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/virtualmachines@2015-05-21-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      artifactDeploymentStatus = {
        artifactsApplied = int
        deploymentStatus = "string"
        totalArtifacts = int
      }
      artifacts = [
        {
          artifactId = "string"
          parameters = [
            {
              name = "string"
              value = "string"
            }
          ]
        }
      ]
      computeId = "string"
      createdByUser = "string"
      createdByUserId = "string"
      customImageId = "string"
      disallowPublicIpAddress = bool
      fqdn = "string"
      galleryImageReference = {
        offer = "string"
        osType = "string"
        publisher = "string"
        sku = "string"
        version = "string"
      }
      isAuthenticationWithSshKey = bool
      labSubnetName = "string"
      labVirtualNetworkId = "string"
      notes = "string"
      osType = "string"
      ownerObjectId = "string"
      password = "string"
      provisioningState = "string"
      size = "string"
      sshKey = "string"
      userName = "string"
    }
  })
}

Property values

ArtifactDeploymentStatusProperties

Name Description Value
artifactsApplied The total count of the artifacts that were successfully applied. int
deploymentStatus The deployment status of the artifact. string
totalArtifacts The total count of the artifacts that were tentatively applied. int

ArtifactInstallProperties

Name Description Value
artifactId The artifact's identifier. string
parameters The parameters of the artifact. ArtifactParameterProperties[]

ArtifactParameterProperties

Name Description Value
name The name of the artifact parameter. string
value The value of the artifact parameter. string

GalleryImageReference

Name Description Value
offer The offer of the gallery image. string
osType The OS type of the gallery image. string
publisher The publisher of the gallery image. string
sku The SKU of the gallery image. string
version The version of the gallery image. string

LabVirtualMachineProperties

Name Description Value
artifactDeploymentStatus The artifact deployment status for the virtual machine. ArtifactDeploymentStatusProperties
artifacts The artifacts to be installed on the virtual machine. ArtifactInstallProperties[]
computeId The resource identifier (Microsoft.Compute) of the virtual machine. string
createdByUser The email address of creator of the virtual machine. string
createdByUserId The object identifier of the creator of the virtual machine. string
customImageId The custom image identifier of the virtual machine. string
disallowPublicIpAddress Indicates whether the virtual machine is to be created without a public IP address. bool
fqdn The fully-qualified domain name of the virtual machine. string
galleryImageReference The Microsoft Azure Marketplace image reference of the virtual machine. GalleryImageReference
isAuthenticationWithSshKey A value indicating whether this virtual machine uses an SSH key for authentication. bool
labSubnetName The lab subnet name of the virtual machine. string
labVirtualNetworkId The lab virtual network identifier of the virtual machine. string
notes The notes of the virtual machine. string
osType The OS type of the virtual machine. string
ownerObjectId The object identifier of the owner of the virtual machine. string
password The password of the virtual machine administrator. string
provisioningState The provisioning status of the resource. string
size The size of the virtual machine. string
sshKey The SSH key of the virtual machine administrator. string
userName The user name of the virtual machine. string

LabVirtualMachineTags

Name Description Value

Microsoft.DevTestLab/labs/virtualmachines

Name Description Value
location The location of the resource. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: labs
properties The properties of the resource. LabVirtualMachineProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevTestLab/labs/virtualmachines@2015-05-21-preview"