LabVirtualMachineCreationParameter interface
Properties for creating a virtual machine.
Properties
allow |
Indicates whether another user can take ownership of the virtual machine |
artifacts | The artifacts to be installed on the virtual machine. |
bulk |
The number of virtual machine instances to create. |
created |
The creation date of the virtual machine. |
custom |
The custom image identifier of the virtual machine. |
data |
New or existing data disks to attach to the virtual machine after creation |
disallow |
Indicates whether the virtual machine is to be created without a public IP address. |
environment |
The resource ID of the environment that contains this virtual machine, if any. |
expiration |
The expiration date for VM. |
gallery |
The Microsoft Azure Marketplace image reference of the virtual machine. |
is |
Indicates whether this virtual machine uses an SSH key for authentication. |
lab |
The lab subnet name of the virtual machine. |
lab |
The lab virtual network identifier of the virtual machine. |
location | The location of the new virtual machine or environment |
name | The name of the virtual machine or environment |
network |
The network interface properties. |
notes | The notes of the virtual machine. |
owner |
The object identifier of the owner of the virtual machine. |
owner |
The user principal name of the virtual machine owner. |
password | The password of the virtual machine administrator. |
plan |
The id of the plan associated with the virtual machine image |
schedule |
Virtual Machine schedules to be created |
size | The size of the virtual machine. |
ssh |
The SSH key of the virtual machine administrator. |
storage |
Storage type to use for virtual machine (i.e. Standard, Premium). |
tags | The tags of the resource. |
user |
The user name of the virtual machine. |
Property Details
allowClaim
Indicates whether another user can take ownership of the virtual machine
allowClaim?: boolean
Property Value
boolean
artifacts
The artifacts to be installed on the virtual machine.
artifacts?: ArtifactInstallProperties[]
Property Value
bulkCreationParameters
The number of virtual machine instances to create.
bulkCreationParameters?: BulkCreationParameters
Property Value
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
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
galleryImageReference
The Microsoft Azure Marketplace image reference of the virtual machine.
galleryImageReference?: GalleryImageReference
Property Value
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
location
The location of the new virtual machine or environment
location?: string
Property Value
string
name
The name of the virtual machine or environment
name?: string
Property Value
string
networkInterface
The network interface properties.
networkInterface?: NetworkInterfaceProperties
Property Value
notes
The notes of the virtual machine.
notes?: 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
scheduleParameters
Virtual Machine schedules to be created
scheduleParameters?: ScheduleCreationParameter[]
Property Value
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
tags
The tags of the resource.
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
userName
The user name of the virtual machine.
userName?: string
Property Value
string