virtual_machines

Overview

Name	virtual_machines
Type	Resource
Id	azure.azurefleet.virtual_machines

Fields

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
etag	string	Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates.
extendedLocation	object	The complex type of the extended location.
identity	object	Identity for the virtual machine.
location	string	Resource location
managedBy	string	ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization.
plan	object	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
properties	object	Describes the properties of a Virtual Machine.
resources	array	The virtual machine child extension resources.
tags	object	Resource tags
type	string	Resource type
zones	array	The virtual machine zones.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, vmName	Retrieves information about the model view or the instance view of a virtual machine.
list	SELECT	resourceGroupName, subscriptionId	Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.
list_by_location	SELECT	location, subscriptionId	Gets all the virtual machines under the specified subscription for the specified location.
create_or_update	INSERT	resourceGroupName, subscriptionId, vmName	The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.
delete	DELETE	resourceGroupName, subscriptionId, vmName	The operation to delete 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.
instance_view	EXEC	resourceGroupName, subscriptionId, vmName	Retrieves information about the run-time state of a virtual machine.
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.
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.