azure.mgmt.compute.types.VirtualMachineProperties class

Constructor

VirtualMachineProperties()

Variables

Name	Description
hardware_profile	<xref:<xref:"HardwareProfile">> Specifies the hardware settings for the virtual machine.
scheduled_events_policy	<xref:<xref:"ScheduledEventsPolicy">> Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
storage_profile	<xref:<xref:"StorageProfile">> Specifies the storage settings for the virtual machine disks.
additional_capabilities	<xref:<xref:"AdditionalCapabilities">> Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile	<xref:<xref:"OSProfile">> Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
network_profile	<xref:<xref:"NetworkProfile">> Specifies the network interfaces of the virtual machine.
security_profile	<xref:<xref:"SecurityProfile">> Specifies the Security related profile settings for the virtual machine.
diagnostics_profile	<xref:<xref:"DiagnosticsProfile">> Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
availability_set	<xref:<xref:"SubResource">> Specifies 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. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. 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. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
virtual_machine_scale_set	<xref:<xref:"SubResource">> Specifies 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.
proximity_placement_group	<xref:<xref:"SubResource">> Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
priority	Union[str, <xref:"VirtualMachinePriorityTypes">] Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01. Known values are: "Regular", "Low", and "Spot".
eviction_policy	Union[str, <xref:"VirtualMachineEvictionPolicyTypes">] Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Known values are: "Deallocate" and "Delete".
billing_profile	<xref:<xref:"BillingProfile">> Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
host	<xref:<xref:"SubResource">> Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.
host_group	<xref:<xref:"SubResource">> Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.
provisioning_state	str The provisioning state, which only appears in the response.
instance_view	<xref:<xref:"VirtualMachineInstanceView">> The virtual machine instance view.
license_type	str Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15.
vm_id	str Specifies 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.
extensions_time_budget	str Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01.
platform_fault_domain	int Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01.
scheduled_events_profile	<xref:<xref:"ScheduledEventsProfile">> Specifies Scheduled Event related configurations.
user_data	str UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
capacity_reservation	<xref:<xref:"CapacityReservationProfile">> Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
interconnect_block_profile	<xref:<xref:"InterconnectBlockProfile">> Specifies information about the Interconnect Block that is used to allocate the Virtual Machine. Minimum api-version: 2026-03-01.
application_profile	<xref:<xref:"ApplicationProfile">> Specifies the gallery applications that should be made available to the VM/VMSS.
time_created	str Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
resiliency_profile	<xref:<xref:"ResiliencyProfile">> Resiliency profile for the virtual machine.

additionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

additionalCapabilities: AdditionalCapabilities

applicationProfile

Specifies the gallery applications that should be made available to the VM/VMSS.

applicationProfile: ApplicationProfile

availabilitySet

Specifies 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. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. 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. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

availabilitySet: SubResource

billingProfile

Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.

billingProfile: BillingProfile

capacityReservation

Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

capacityReservation: CapacityReservationProfile

diagnosticsProfile

2015-06-15.

diagnosticsProfile: DiagnosticsProfile

evictionPolicy

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Known values are: "Deallocate" and "Delete".

evictionPolicy: str | VirtualMachineEvictionPolicyTypes

extensionsTimeBudget

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01.

extensionsTimeBudget: str

hardwareProfile

Specifies the hardware settings for the virtual machine.

hardwareProfile: HardwareProfile

host

Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.

host: SubResource

hostGroup

Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.

hostGroup: SubResource

instanceView

The virtual machine instance view.

instanceView: VirtualMachineInstanceView

interconnectBlockProfile

Specifies information about the Interconnect Block that is used to allocate the Virtual Machine. Minimum api-version: 2026-03-01.

interconnectBlockProfile: InterconnectBlockProfile

licenseType

Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see Azure Hybrid Use Benefit for Windows Server

Azure Hybrid Use Benefit for Linux Server

Minimum api-version: 2015-06-15.

licenseType: str

networkProfile

Specifies the network interfaces of the virtual machine.

networkProfile: NetworkProfile

osProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

osProfile: OSProfile

platformFaultDomain

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01.

platformFaultDomain: int

priority

2019-03-01. Known values are: "Regular", "Low", and "Spot".

priority: str | VirtualMachinePriorityTypes

provisioningState

The provisioning state, which only appears in the response.

provisioningState: str

proximityPlacementGroup

Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.

proximityPlacementGroup: SubResource

resiliencyProfile

Resiliency profile for the virtual machine.

resiliencyProfile: ResiliencyProfile

scheduledEventsPolicy

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.

scheduledEventsPolicy: ScheduledEventsPolicy

scheduledEventsProfile

Specifies Scheduled Event related configurations.

scheduledEventsProfile: ScheduledEventsProfile

securityProfile

Specifies the Security related profile settings for the virtual machine.

securityProfile: SecurityProfile

storageProfile

Specifies the storage settings for the virtual machine disks.

storageProfile: StorageProfile

timeCreated

Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

timeCreated: str

userData

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

userData: str

virtualMachineScaleSet

Specifies 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.

virtualMachineScaleSet: SubResource

vmId

Specifies 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.

vmId: str