VirtualMachineProperties Class
Describes the properties of a Virtual Machine.
Constructor
VirtualMachineProperties(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
hardware_profile
|
Specifies the hardware settings for the virtual machine. |
|
scheduled_events_policy
|
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. |
|
storage_profile
|
Specifies the storage settings for the virtual machine disks. |
|
additional_capabilities
|
Specifies additional capabilities enabled or disabled on the virtual machine. |
|
os_profile
|
Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. |
|
network_profile
|
Specifies the network interfaces of the virtual machine. |
|
security_profile
|
Specifies the Security related profile settings for the virtual machine. |
|
diagnostics_profile
|
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
|
availability_set
|
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
|
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
|
Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. |
|
priority
|
Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01. Known values are: "Regular", "Low", and "Spot". |
|
eviction_policy
|
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
|
Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. |
|
host
|
Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. |
|
host_group
|
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
|
The provisioning state, which only appears in the response. |
|
instance_view
|
The virtual machine instance view. |
|
license_type
|
Specifies that the image or disk that is being used was licensed
on-premises. |
|
vm_id
|
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
|
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
|
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
|
|
scheduled_events_profile
|
Specifies Scheduled Event related configurations. |
|
user_data
|
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
|
Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. |
|
application_profile
|
Specifies the gallery applications that should be made available to the VM/VMSS. |
|
time_created
|
Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. |
|
resiliency_profile
|
Resiliency profile for the virtual machine. |
Attributes
additional_capabilities
Specifies additional capabilities enabled or disabled on the virtual machine.
additional_capabilities: _models.AdditionalCapabilities | None
application_profile
Specifies the gallery applications that should be made available to the VM/VMSS.
application_profile: _models.ApplicationProfile | None
availability_set
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.
availability_set: _models.SubResource | None
billing_profile
Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
billing_profile: _models.BillingProfile | None
capacity_reservation
Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
capacity_reservation: _models.CapacityReservationProfile | None
diagnostics_profile
2015-06-15.
diagnostics_profile: _models.DiagnosticsProfile | None
eviction_policy
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".
eviction_policy: str | _models.VirtualMachineEvictionPolicyTypes | None
extensions_time_budget
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.
extensions_time_budget: str | None
hardware_profile
Specifies the hardware settings for the virtual machine.
hardware_profile: _models.HardwareProfile | None
host
Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.
host: _models.SubResource | None
host_group
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.
host_group: _models.SubResource | None
instance_view
The virtual machine instance view.
instance_view: _models.VirtualMachineInstanceView | None
license_type
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.
license_type: str | None
network_profile
Specifies the network interfaces of the virtual machine.
network_profile: _models.NetworkProfile | None
os_profile
Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
os_profile: _models.OSProfile | None
platform_fault_domain
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.
platform_fault_domain: int | None
priority
2019-03-01. Known values are: "Regular", "Low", and "Spot".
priority: str | _models.VirtualMachinePriorityTypes | None
provisioning_state
The provisioning state, which only appears in the response.
provisioning_state: str | None
proximity_placement_group
Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
proximity_placement_group: _models.SubResource | None
resiliency_profile
Resiliency profile for the virtual machine.
resiliency_profile: _models.ResiliencyProfile | None
scheduled_events_policy
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
scheduled_events_policy: _models.ScheduledEventsPolicy | None
scheduled_events_profile
Specifies Scheduled Event related configurations.
scheduled_events_profile: _models.ScheduledEventsProfile | None
security_profile
Specifies the Security related profile settings for the virtual machine.
security_profile: _models.SecurityProfile | None
storage_profile
Specifies the storage settings for the virtual machine disks.
storage_profile: _models.StorageProfile | None
time_created
Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
time_created: datetime | None
user_data
UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
user_data: str | None
virtual_machine_scale_set
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.
virtual_machine_scale_set: _models.SubResource | None
vm_id
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.
vm_id: str | None