Microsoft.DevTestLab labs/virtualmachines 2015-05-21-preview
The labs/virtualmachines resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
For a list of changed properties in each API version, see change log.
Template format
To create a Microsoft.DevTestLab/labs/virtualmachines resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.DevTestLab/labs/virtualmachines@2015-05-21-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
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
labs/virtualmachines
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.DevTestLab/labs/virtualmachines' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2015-05-21-preview' |
| name | The resource name See how to set names and types for child resources in Bicep or JSON ARM templates. |
string (required) Character limit: 1-15 (Windows) 1-64 (Linux) Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. Can't be all numbers. |
| location | The location of the resource. | string |
| tags | The tags of the resource. | Dictionary of tag names and values. See Tags in templates |
| 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 |
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 |
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Creates a lab in Azure DevTest Labs with a Windows Server VM |
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 |
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 |