virtual_machines

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

Overview

Name	virtual_machines
Type	Resource
Id	azure_isv.avs.virtual_machines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the VM.
folderPath	string	Path to virtual machine's folder starting from datacenter virtual machine folder.
moRefId	string	vCenter managed object reference ID of the virtual machine.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
restrictMovement	string	Whether VM DRS-driven movement is restricted (enabled) or not (disabled). Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the VM.
folderPath	string	Path to virtual machine's folder starting from datacenter virtual machine folder.
moRefId	string	vCenter managed object reference ID of the virtual machine.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
restrictMovement	string	Whether VM DRS-driven movement is restricted (enabled) or not (disabled). Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_cloud_name, cluster_name, virtual_machine_id, subscription_id		Get a VirtualMachine.
list	select	resource_group_name, private_cloud_name, cluster_name, subscription_id		List VirtualMachine resources by Cluster.
restrict_movement	exec	resource_group_name, private_cloud_name, cluster_name, virtual_machine_id, subscription_id		Enable or disable DRS-driven VM movement restriction.

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
cluster_name	string	Name of the cluster. Required.
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_machine_id	string	ID of the virtual machine. Required.

SELECT examples

get

Get a VirtualMachine.

SELECT
id,
name,
displayName,
folderPath,
moRefId,
provisioningState,
restrictMovement,
systemData,
type
FROM azure_isv.avs.virtual_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND virtual_machine_id = '{{ virtual_machine_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List VirtualMachine resources by Cluster.

SELECT
id,
name,
displayName,
folderPath,
moRefId,
provisioningState,
restrictMovement,
systemData,
type
FROM azure_isv.avs.virtual_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

restrict_movement

Enable or disable DRS-driven VM movement restriction.

EXEC azure_isv.avs.virtual_machines.restrict_movement 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@virtual_machine_id='{{ virtual_machine_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"restrictMovement": "{{ restrictMovement }}"
}'
;