LabVirtualMachine Class
A virtual machine.
Variables are only populated by the server, and will be ignored when sending a request.
- Inheritance
-
azure.mgmt.devtestlabs.models._models_py3.ResourceLabVirtualMachine
Constructor
LabVirtualMachine(*, location: str | None = None, tags: Dict[str, str] | None = None, notes: str | None = None, owner_object_id: str | None = None, owner_user_principal_name: str | None = None, created_by_user_id: str | None = None, created_by_user: str | None = None, created_date: datetime | None = None, compute_id: str | None = None, custom_image_id: str | None = None, os_type: 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, fqdn: str | None = None, lab_subnet_name: str | None = None, lab_virtual_network_id: str | None = None, disallow_public_ip_address: bool | None = None, artifacts: List[ArtifactInstallProperties] | None = None, artifact_deployment_status: ArtifactDeploymentStatusProperties | None = None, gallery_image_reference: GalleryImageReference | None = None, plan_id: str | None = None, network_interface: NetworkInterfaceProperties | None = None, expiration_date: datetime | None = None, allow_claim: bool | None = None, storage_type: str | None = None, virtual_machine_creation_source: str | VirtualMachineCreationSource | None = None, environment_id: str | None = None, data_disk_parameters: List[DataDiskProperties] | None = None, schedule_parameters: List[ScheduleCreationParameter] | None = None, last_known_power_state: str | None = None, **kwargs)
Parameters
Name | Description |
---|---|
location
Required
|
The location of the resource. |
tags
Required
|
A set of tags. The tags of the resource. |
notes
Required
|
The notes of the virtual machine. |
owner_object_id
Required
|
The object identifier of the owner of the virtual machine. |
owner_user_principal_name
Required
|
The user principal name of the virtual machine owner. |
created_by_user_id
Required
|
The object identifier of the creator of the virtual machine. |
created_by_user
Required
|
The email address of creator of the virtual machine. |
created_date
Required
|
The creation date of the virtual machine. |
compute_id
Required
|
The resource identifier (Microsoft.Compute) of the virtual machine. |
custom_image_id
Required
|
The custom image identifier of the virtual machine. |
os_type
Required
|
The OS type of the virtual machine. |
size
Required
|
The size of the virtual machine. |
user_name
Required
|
The user name of the virtual machine. |
password
Required
|
The password of the virtual machine administrator. |
ssh_key
Required
|
The SSH key of the virtual machine administrator. |
is_authentication_with_ssh_key
Required
|
Indicates whether this virtual machine uses an SSH key for authentication. |
fqdn
Required
|
The fully-qualified domain name of the virtual machine. |
lab_subnet_name
Required
|
The lab subnet name of the virtual machine. |
lab_virtual_network_id
Required
|
The lab virtual network identifier of the virtual machine. |
disallow_public_ip_address
Required
|
Indicates whether the virtual machine is to be created without a public IP address. |
artifacts
Required
|
The artifacts to be installed on the virtual machine. |
artifact_deployment_status
Required
|
The artifact deployment status for the virtual machine. |
gallery_image_reference
Required
|
The Microsoft Azure Marketplace image reference of the virtual machine. |
plan_id
Required
|
The id of the plan associated with the virtual machine image. |
network_interface
Required
|
The network interface properties. |
expiration_date
Required
|
The expiration date for VM. |
allow_claim
Required
|
Indicates whether another user can take ownership of the virtual machine. |
storage_type
Required
|
Storage type to use for virtual machine (i.e. Standard, Premium). |
virtual_machine_creation_source
Required
|
Tells source of creation of lab virtual machine. Output property only. Possible values include: "FromCustomImage", "FromGalleryImage", "FromSharedGalleryImage". |
environment_id
Required
|
The resource ID of the environment that contains this virtual machine, if any. |
data_disk_parameters
Required
|
New or existing data disks to attach to the virtual machine after creation. |
schedule_parameters
Required
|
Virtual Machine schedules to be created. |
last_known_power_state
Required
|
Last known compute power state captured in DTL. |
Keyword-Only Parameters
Name | Description |
---|---|
location
Required
|
|
tags
Required
|
|
notes
Required
|
|
owner_object_id
Required
|
|
owner_user_principal_name
Required
|
|
created_by_user_id
Required
|
|
created_by_user
Required
|
|
created_date
Required
|
|
compute_id
Required
|
|
custom_image_id
Required
|
|
os_type
Required
|
|
size
Required
|
|
user_name
Required
|
|
password
Required
|
|
ssh_key
Required
|
|
is_authentication_with_ssh_key
Required
|
|
fqdn
Required
|
|
lab_subnet_name
Required
|
|
lab_virtual_network_id
Required
|
|
disallow_public_ip_address
Required
|
|
artifacts
Required
|
|
artifact_deployment_status
Required
|
|
gallery_image_reference
Required
|
|
plan_id
Required
|
|
network_interface
Required
|
|
expiration_date
Required
|
|
allow_claim
Required
|
|
storage_type
Required
|
|
virtual_machine_creation_source
Required
|
|
environment_id
Required
|
|
data_disk_parameters
Required
|
|
schedule_parameters
Required
|
|
last_known_power_state
Required
|
|
Variables
Name | Description |
---|---|
id
|
The identifier of the resource. |
name
|
The name of the resource. |
type
|
The type of the resource. |
compute_vm
|
The compute virtual machine properties. |
applicable_schedule
|
The applicable schedule for the virtual machine. |
provisioning_state
|
The provisioning status of the resource. |
unique_identifier
|
The unique immutable identifier of a resource (Guid). |
Azure SDK for Python