virtual_machines

Creates, updates, deletes, gets or lists a virtual_machines resource.

Overview

Name	virtual_machines
Type	Resource
Id	azure.lab_services.virtual_machines

Fields

vw_virtual_machines

Name	Datatype	Description
claimed_by_user_id	text	field from the properties object
connection_profile	text	field from the properties object
labName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_operation_error	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
virtualMachineName	text	field from the properties object
vm_type	text	field from the properties object

virtual_machines

Name	Datatype	Description
properties	object	Virtual machine resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	labName, resourceGroupName, subscriptionId, virtualMachineName	Returns the properties for a lab virtual machine.
list_by_lab	SELECT	labName, resourceGroupName, subscriptionId	Returns a list of all virtual machines for a lab.
redeploy	EXEC	labName, resourceGroupName, subscriptionId, virtualMachineName	Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
reimage	EXEC	labName, resourceGroupName, subscriptionId, virtualMachineName	Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.
reset_password	EXEC	labName, resourceGroupName, subscriptionId, virtualMachineName, data__password, data__username	Resets a lab virtual machine password.
start	EXEC	labName, resourceGroupName, subscriptionId, virtualMachineName	Action to start a lab virtual machine.
stop	EXEC	labName, resourceGroupName, subscriptionId, virtualMachineName	Action to stop a lab virtual machine.

SELECT examples

Returns a list of all virtual machines for a lab.

vw_virtual_machines

SELECT
claimed_by_user_id,
connection_profile,
labName,
provisioning_state,
resourceGroupName,
resource_operation_error,
state,
subscriptionId,
system_data,
virtualMachineName,
vm_type
FROM azure.lab_services.vw_virtual_machines
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

virtual_machines

SELECT
properties,
systemData
FROM azure.lab_services.virtual_machines
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';