Virtual Machine Instance

This table represents the Virtual Machine Instance resource from Microsoft Azure.

azure.virtual_machine_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
availability_setcorejsonSpecifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
diagnostics_profilecorejsonSpecifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
hardware_profilecorejsonSpecifies the hardware settings for the virtual machine.
idcorestringResource Id
identitycorejsonThe identity of the virtual machine, if configured.
instance_viewcorejsonThe virtual machine instance view.
license_typecorestringSpecifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15
locationcorestringResource location
namecorestringResource name
network_profilecorejsonSpecifies the network interfaces of the virtual machine.
os_profilecorejsonSpecifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
plancorejsonSpecifies 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**.
prioritycorestringSpecifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01
provisioning_statecorestringThe provisioning state, which only appears in the response.
resource_groupcorestring
resourcescorejsonThe virtual machine child extension resources.
storage_profilecorejsonSpecifies the storage settings for the virtual machine disks.
subscription_idcorestring
subscription_namecorestring
tagscorehstore
typecorestringResource type
vm_idcorestringSpecifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
zonescorearray<string>The virtual machine zones.