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

The following fields are returned by SELECT queries:

get

The request was successful; response contains the lab virtual machine.

Name	Datatype	Description
properties	object	Virtual machine resource properties
systemData	object	System data of the Lab virtual machine.

list_by_lab

The request was successful; response contains all virtual machines for the given lab.

Name	Datatype	Description
properties	object	Virtual machine resource properties
systemData	object	System data of the Lab virtual machine.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Returns the properties for a lab virtual machine.
list_by_lab	select			Returns a list of all virtual machines for a lab.
start	exec			Action to start a lab virtual machine.
stop	exec			Action to stop a lab virtual machine.
reimage	exec			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.
redeploy	exec			Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
reset_password	exec	username, password		Resets a lab virtual machine password.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

SELECT examples

get

Returns the properties for a lab virtual machine.

SELECT
properties,
systemData
FROM azure.lab_services.virtual_machines
;

list_by_lab

Returns a list of all virtual machines for a lab.

SELECT
properties,
systemData
FROM azure.lab_services.virtual_machines
;

Lifecycle Methods

start

Action to start a lab virtual machine.

EXEC azure.lab_services.virtual_machines.start 

;

stop

Action to stop a lab virtual machine.

EXEC azure.lab_services.virtual_machines.stop 

;

reimage

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.

EXEC azure.lab_services.virtual_machines.reimage 

;

redeploy

Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.

EXEC azure.lab_services.virtual_machines.redeploy 

;

reset_password

Resets a lab virtual machine password.

EXEC azure.lab_services.virtual_machines.reset_password 
@@json=
'{
"username": "{{ username }}", 
"password": "{{ password }}"
}'
;