Share via

LabVirtualMachine interface

  • Reference
Package:
@azure/arm-devtestlabs

A virtual machine.

Extends
Resource

Properties

allowClaim

Indicates whether another user can take ownership of the virtual machine
applicableSchedule

The applicable schedule for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
artifactDeploymentStatus

The artifact deployment status for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
artifacts

The artifacts to be installed on the virtual machine.
computeId

The resource identifier (Microsoft.Compute) of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
computeVm

The compute virtual machine properties. NOTE: This property will not be serialized. It can only be populated by the server.
createdByUser

The email address of creator of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
createdByUserId

The object identifier of the creator of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
createdDate

The creation date of the virtual machine.
customImageId

The custom image identifier of the virtual machine.
dataDiskParameters

New or existing data disks to attach to the virtual machine after creation
disallowPublicIpAddress

Indicates whether the virtual machine is to be created without a public IP address.
environmentId

The resource ID of the environment that contains this virtual machine, if any.
expirationDate

The expiration date for VM.
fqdn

The fully-qualified domain name of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
galleryImageReference

The Microsoft Azure Marketplace image reference of the virtual machine.
isAuthenticationWithSshKey

Indicates whether this virtual machine uses an SSH key for authentication.
labSubnetName

The lab subnet name of the virtual machine.
labVirtualNetworkId

The lab virtual network identifier of the virtual machine.
lastKnownPowerState

Last known compute power state captured in DTL NOTE: This property will not be serialized. It can only be populated by the server.
networkInterface

The network interface properties.
notes

The notes of the virtual machine.
osType

The OS type of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
ownerObjectId

The object identifier of the owner of the virtual machine.
ownerUserPrincipalName

The user principal name of the virtual machine owner.
password

The password of the virtual machine administrator.
planId

The id of the plan associated with the virtual machine image
provisioningState

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
scheduleParameters

Virtual Machine schedules to be created
size

The size of the virtual machine.
sshKey

The SSH key of the virtual machine administrator.
storageType

Storage type to use for virtual machine (i.e. Standard, Premium).
uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.
userName

The user name of the virtual machine.
virtualMachineCreationSource

Tells source of creation of lab virtual machine. Output property only. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
location

The location of the resource.
name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags

The tags of the resource.
type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowClaim

Indicates whether another user can take ownership of the virtual machine

allowClaim?: boolean

Property Value

boolean

applicableSchedule

The applicable schedule for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

applicableSchedule?: ApplicableSchedule

Property Value

ApplicableSchedule

artifactDeploymentStatus

The artifact deployment status for the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

artifactDeploymentStatus?: ArtifactDeploymentStatusProperties

Property Value

ArtifactDeploymentStatusProperties

artifacts

The artifacts to be installed on the virtual machine.

artifacts?: ArtifactInstallProperties[]

Property Value

ArtifactInstallProperties[]

computeId

The resource identifier (Microsoft.Compute) of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

computeId?: string

Property Value

string

computeVm

The compute virtual machine properties. NOTE: This property will not be serialized. It can only be populated by the server.

computeVm?: ComputeVmProperties

Property Value

ComputeVmProperties

createdByUser

The email address of creator of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

createdByUser?: string

Property Value

string

createdByUserId

The object identifier of the creator of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

createdByUserId?: string

Property Value

string

createdDate

The creation date of the virtual machine.

createdDate?: Date

Property Value

Date

customImageId

The custom image identifier of the virtual machine.

customImageId?: string

Property Value

string

dataDiskParameters

New or existing data disks to attach to the virtual machine after creation

dataDiskParameters?: DataDiskProperties[]

Property Value

DataDiskProperties[]

disallowPublicIpAddress

Indicates whether the virtual machine is to be created without a public IP address.

disallowPublicIpAddress?: boolean

Property Value

boolean

environmentId

The resource ID of the environment that contains this virtual machine, if any.

environmentId?: string

Property Value

string

expirationDate

The expiration date for VM.

expirationDate?: Date

Property Value

Date

fqdn

The fully-qualified domain name of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

fqdn?: string

Property Value

string

galleryImageReference

The Microsoft Azure Marketplace image reference of the virtual machine.

galleryImageReference?: GalleryImageReference

Property Value

GalleryImageReference

isAuthenticationWithSshKey

Indicates whether this virtual machine uses an SSH key for authentication.

isAuthenticationWithSshKey?: boolean

Property Value

boolean

labSubnetName

The lab subnet name of the virtual machine.

labSubnetName?: string

Property Value

string

labVirtualNetworkId

The lab virtual network identifier of the virtual machine.

labVirtualNetworkId?: string

Property Value

string

lastKnownPowerState

Last known compute power state captured in DTL NOTE: This property will not be serialized. It can only be populated by the server.

lastKnownPowerState?: string

Property Value

string

networkInterface

The network interface properties.

networkInterface?: NetworkInterfaceProperties

Property Value

NetworkInterfaceProperties

notes

The notes of the virtual machine.

notes?: string

Property Value

string

osType

The OS type of the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

osType?: string

Property Value

string

ownerObjectId

The object identifier of the owner of the virtual machine.

ownerObjectId?: string

Property Value

string

ownerUserPrincipalName

The user principal name of the virtual machine owner.

ownerUserPrincipalName?: string

Property Value

string

password

The password of the virtual machine administrator.

password?: string

Property Value

string

planId

The id of the plan associated with the virtual machine image

planId?: string

Property Value

string

provisioningState

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

scheduleParameters

Virtual Machine schedules to be created

scheduleParameters?: ScheduleCreationParameter[]

Property Value

ScheduleCreationParameter[]

size

The size of the virtual machine.

size?: string

Property Value

string

sshKey

The SSH key of the virtual machine administrator.

sshKey?: string

Property Value

string

storageType

Storage type to use for virtual machine (i.e. Standard, Premium).

storageType?: string

Property Value

string

uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

uniqueIdentifier?: string

Property Value

string

userName

The user name of the virtual machine.

userName?: string

Property Value

string

virtualMachineCreationSource

Tells source of creation of lab virtual machine. Output property only. NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachineCreationSource?: string

Property Value

string

Inherited Property Details

id

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

The location of the resource.

location?: string

Property Value

string

Inherited From Resource.location

name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

The tags of the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type