LabVirtualMachine Class

A virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

LabVirtualMachine(*, location: str | None = None, tags: dict[str, str] | None = None, notes: str | None = None, owner_object_id: str = 'dynamicValue', owner_user_principal_name: str | None = None, created_date: datetime | None = None, custom_image_id: str | None = None, size: str | None = None, user_name: str | None = None, password: str | None = None, ssh_key: str | None = None, is_authentication_with_ssh_key: bool | None = None, lab_subnet_name: str | None = None, lab_virtual_network_id: str | None = None, disallow_public_ip_address: bool = False, artifacts: list['_models.ArtifactInstallProperties'] | None = None, gallery_image_reference: _models.GalleryImageReference | None = None, plan_id: str | None = None, network_interface: _models.NetworkInterfaceProperties | None = None, expiration_date: datetime | None = None, allow_claim: bool = False, storage_type: str = 'labStorageType', environment_id: str | None = None, data_disk_parameters: list['_models.DataDiskProperties'] | None = None, schedule_parameters: list['_models.ScheduleCreationParameter'] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str The location of the resource. Default value: None
tags	dict[str, str] The tags of the resource. Default value: None
notes	str The notes of the virtual machine. Default value: None
owner_object_id	str The object identifier of the owner of the virtual machine. Default value: dynamicValue
owner_user_principal_name	str The user principal name of the virtual machine owner. Default value: None
created_date	datetime The creation date of the virtual machine. Default value: None
custom_image_id	str The custom image identifier of the virtual machine. Default value: None
size	str The size of the virtual machine. Default value: None
user_name	str The user name of the virtual machine. Default value: None
password	str The password of the virtual machine administrator. Default value: None
ssh_key	str The SSH key of the virtual machine administrator. Default value: None
is_authentication_with_ssh_key	bool Indicates whether this virtual machine uses an SSH key for authentication. Default value: None
lab_subnet_name	str The lab subnet name of the virtual machine. Default value: None
lab_virtual_network_id	str The lab virtual network identifier of the virtual machine. Default value: None
disallow_public_ip_address	bool Indicates whether the virtual machine is to be created without a public IP address. Default value: False
artifacts	list[ArtifactInstallProperties] The artifacts to be installed on the virtual machine. Default value: None
gallery_image_reference	GalleryImageReference The Microsoft Azure Marketplace image reference of the virtual machine. Default value: None
plan_id	str The id of the plan associated with the virtual machine image. Default value: None
network_interface	NetworkInterfaceProperties The network interface properties. Default value: None
expiration_date	datetime The expiration date for VM. Default value: None
allow_claim	bool Indicates whether another user can take ownership of the virtual machine. Default value: False
storage_type	str Storage type to use for virtual machine (i.e. Standard, Premium). Default value: labStorageType
environment_id	str The resource ID of the environment that contains this virtual machine, if any. Default value: None
data_disk_parameters	list[DataDiskProperties] New or existing data disks to attach to the virtual machine after creation. Default value: None
schedule_parameters	list[ScheduleCreationParameter] Virtual Machine schedules to be created. Default value: None

Variables

Name	Description
id	str The identifier of the resource.
name	str The name of the resource.
type	str The type of the resource.
location	str The location of the resource.
tags	dict[str, str] The tags of the resource.
notes	str The notes of the virtual machine.
owner_object_id	str The object identifier of the owner of the virtual machine.
owner_user_principal_name	str The user principal name of the virtual machine owner.
created_by_user_id	str The object identifier of the creator of the virtual machine.
created_by_user	str The email address of creator of the virtual machine.
created_date	datetime The creation date of the virtual machine.
compute_id	str The resource identifier (Microsoft.Compute) of the virtual machine.
custom_image_id	str The custom image identifier of the virtual machine.
os_type	str The OS type of the virtual machine.
size	str The size of the virtual machine.
user_name	str The user name of the virtual machine.
password	str The password of the virtual machine administrator.
ssh_key	str The SSH key of the virtual machine administrator.
is_authentication_with_ssh_key	bool Indicates whether this virtual machine uses an SSH key for authentication.
fqdn	str The fully-qualified domain name of the virtual machine.
lab_subnet_name	str The lab subnet name of the virtual machine.
lab_virtual_network_id	str The lab virtual network identifier of the virtual machine.
disallow_public_ip_address	bool Indicates whether the virtual machine is to be created without a public IP address.
artifacts	list[ArtifactInstallProperties] The artifacts to be installed on the virtual machine.
artifact_deployment_status	ArtifactDeploymentStatusProperties The artifact deployment status for the virtual machine.
gallery_image_reference	GalleryImageReference The Microsoft Azure Marketplace image reference of the virtual machine.
plan_id	str The id of the plan associated with the virtual machine image.
compute_vm	ComputeVmProperties The compute virtual machine properties.
network_interface	NetworkInterfaceProperties The network interface properties.
applicable_schedule	ApplicableSchedule The applicable schedule for the virtual machine.
expiration_date	datetime The expiration date for VM.
allow_claim	bool Indicates whether another user can take ownership of the virtual machine.
storage_type	str Storage type to use for virtual machine (i.e. Standard, Premium).
virtual_machine_creation_source	str or VirtualMachineCreationSource Tells source of creation of lab virtual machine. Output property only. Known values are: "FromCustomImage", "FromGalleryImage", and "FromSharedGalleryImage".
environment_id	str The resource ID of the environment that contains this virtual machine, if any.
data_disk_parameters	list[DataDiskProperties] New or existing data disks to attach to the virtual machine after creation.
schedule_parameters	list[ScheduleCreationParameter] Virtual Machine schedules to be created.
last_known_power_state	str Last known compute power state captured in DTL.
provisioning_state	str The provisioning status of the resource.
unique_identifier	str The unique immutable identifier of a resource (Guid).