Virtual Machine Instance

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

azure.virtual_machine_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
application_profilecorejsonSpecifies the gallery applications that should be made available to the VM/VMSS.
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 [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
capacity_reservationcorejsonSpecifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
diagnostics_profilecorejsonSpecifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
etagcorestringEtag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.
hardware_profilecorejsonSpecifies the hardware settings for the virtual machine.
idcorestringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identitycorejsonThe identity of the virtual machine, if configured.
instance_idcorestringThe virtual machine instance ID.
instance_viewcorejsonThe virtual machine instance view.
latest_model_appliedcoreboolSpecifies whether the latest model has been applied to the virtual machine.
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
locationcorestringThe geo-location where the resource lives
managed_bycorestringManagedBy 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.
model_definition_appliedcorestringSpecifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
namecorestringThe name of the resource
network_profilecorejsonSpecifies the network interfaces of the virtual machine.
network_profile_configurationcorejsonSpecifies the network profile configuration of the virtual machine.
os_profilecorejsonSpecifies the operating system settings for the virtual machine.
placementcorejsonPlacement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01.
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. Minimum api-version: 2019-03-01
protection_policycorejsonSpecifies the protection policy of the virtual machine.
provisioning_statecorestringThe provisioning state, which only appears in the response.
resilient_vm_deletion_statuscorestringSpecifies the resilient VM deletion status for the virtual machine.
resource_groupcorestring
resourcescorejsonThe virtual machine child extension resources.
scheduled_events_policycorejsonSpecifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
scheduled_events_profilecorejsonSpecifies Scheduled Event related configurations.
skucorejsonThe virtual machine SKU.
storage_profilecorejsonSpecifies the storage settings for the virtual machine disks.
subscription_idcorestring
subscription_namecorestring
system_datacorejsonAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagscorehstore_csv
time_createdcorestringSpecifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
typecorestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
user_datacorestringUserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01
virtual_machine_scale_setcorejsonSpecifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01.
vm_idcorestringAzure VM unique ID.
zonescorearray<string>The virtual machine zones.