virtual_machine

Overview

Name	virtual_machine
Type	Resource
Id	azure.compute.virtual_machine

Fields

Name	Datatype	Description
assignedHost	string	Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01.
bootDiagnostics	object	The instance view of a virtual machine boot diagnostics.
computerName	string	The computer name assigned to the virtual machine.
disks	array	The virtual machine disk information.
extensions	array	The extensions information.
hyperVGeneration	string	Specifies the HyperVGeneration Type associated with a resource
isVMInStandbyPool	boolean	[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool.
maintenanceRedeployStatus	object	Maintenance Operation Status.
osName	string	The Operating System running on the virtual machine.
osVersion	string	The version of Operating System running on the virtual machine.
patchStatus	object	The status of virtual machine patch operations.
platformFaultDomain	integer	Specifies the fault domain of the virtual machine.
platformUpdateDomain	integer	Specifies the update domain of the virtual machine.
rdpThumbPrint	string	The Remote desktop certificate thumbprint.
statuses	array	The resource status information.
vmAgent	object	The instance view of the VM Agent running on the virtual machine.
vmHealth	object	The health status of the VM.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, vmName	Retrieves information about the run-time state of a virtual machine.
assess_patches	EXEC	resourceGroupName, subscriptionId, vmName	Assess patches on the VM.
attach_detach_data_disks	EXEC	resourceGroupName, subscriptionId, vmName	Attach and detach data disks to/from the virtual machine.
capture	EXEC	resourceGroupName, subscriptionId, vmName, data__destinationContainerName, data__overwriteVhds, data__vhdPrefix	Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
convert_to_managed_disks	EXEC	resourceGroupName, subscriptionId, vmName	Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
deallocate	EXEC	resourceGroupName, subscriptionId, vmName	Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.
generalize	EXEC	resourceGroupName, subscriptionId, vmName	Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows, please refer to Create a managed image of a generalized VM in Azure. For Linux, please refer to How to create an image of a virtual machine or VHD.
install_patches	EXEC	resourceGroupName, subscriptionId, vmName, data__rebootSetting	Installs patches on the VM.
perform_maintenance	EXEC	resourceGroupName, subscriptionId, vmName	The operation to perform maintenance on a virtual machine.
power_off	EXEC	resourceGroupName, subscriptionId, vmName	The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.
reapply	EXEC	resourceGroupName, subscriptionId, vmName	The operation to reapply a virtual machine's state.
redeploy	EXEC	resourceGroupName, subscriptionId, vmName	Shuts down the virtual machine, moves it to a new node, and powers it back on.
reimage	EXEC	resourceGroupName, subscriptionId, vmName	Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
restart	EXEC	resourceGroupName, subscriptionId, vmName	The operation to restart a virtual machine.
retrieve_boot_diagnostics_data	EXEC	resourceGroupName, subscriptionId, vmName	The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.
run_command	EXEC	resourceGroupName, subscriptionId, vmName, data__commandId	Run command on the VM.
simulate_eviction	EXEC	resourceGroupName, subscriptionId, vmName	The operation to simulate the eviction of spot virtual machine.
start	EXEC	resourceGroupName, subscriptionId, vmName	The operation to start a virtual machine.
update	EXEC	resourceGroupName, subscriptionId, vmName	The operation to update a virtual machine.