VirtualMachineScaleSetVMProperties Class

Describes the properties of a virtual machine scale set virtual machine.

Constructor

VirtualMachineScaleSetVMProperties(*args: Any, **kwargs: Any)

Variables

Name Description
latest_model_applied

Specifies whether the latest model has been applied to the virtual machine.

vm_id
str

Azure VM unique ID.

instance_view

The virtual machine instance view.

hardware_profile

Specifies the hardware settings for the virtual machine.

resilient_vm_deletion_status

Specifies the resilient VM deletion status for the virtual machine. Known values are: "Enabled", "Disabled", "InProgress", and "Failed".

storage_profile

Specifies the storage settings for the virtual machine disks.

additional_capabilities

Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

os_profile

Specifies the operating system settings for the virtual machine.

security_profile

Specifies the Security related profile settings for the virtual machine.

network_profile

Specifies the network interfaces of the virtual machine.

network_profile_configuration

Specifies the network profile configuration of 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. An existing VM cannot be added to an availability set.

provisioning_state
str

The provisioning state, which only appears in the response.

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.

model_definition_applied
str

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

protection_policy

Specifies the protection policy of the virtual machine.

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.

time_created

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

virtual_machine_resource_id
str

Specifies the ARM resource ID of the standalone virtual machine associated with this VMSS VM. This property is only applicable to Virtual Machine Scale Sets with Flexible orchestration mode. Minimum api-version: 2025-11-01.

Attributes

additional_capabilities

Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

additional_capabilities: _models.AdditionalCapabilities | 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. An existing VM cannot be added to an availability set.

availability_set: _models.SubResource | None

diagnostics_profile

2015-06-15.

diagnostics_profile: _models.DiagnosticsProfile | None

hardware_profile

Specifies the hardware settings for the virtual machine.

hardware_profile: _models.HardwareProfile | None

instance_view

The virtual machine instance view.

instance_view: _models.VirtualMachineScaleSetVMInstanceView | None

latest_model_applied

Specifies whether the latest model has been applied to the virtual machine.

latest_model_applied: bool | 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

model_definition_applied

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

model_definition_applied: str | None

network_profile

Specifies the network interfaces of the virtual machine.

network_profile: _models.NetworkProfile | None

network_profile_configuration

Specifies the network profile configuration of the virtual machine.

network_profile_configuration: _models.VirtualMachineScaleSetVMNetworkProfileConfiguration | None

os_profile

Specifies the operating system settings for the virtual machine.

os_profile: _models.OSProfile | None

protection_policy

Specifies the protection policy of the virtual machine.

protection_policy: _models.VirtualMachineScaleSetVMProtectionPolicy | None

provisioning_state

The provisioning state, which only appears in the response.

provisioning_state: str | None

resilient_vm_deletion_status

Specifies the resilient VM deletion status for the virtual machine. Known values are: "Enabled", "Disabled", "InProgress", and "Failed".

resilient_vm_deletion_status: str | _models.ResilientVMDeletionStatus | 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_resource_id

Specifies the ARM resource ID of the standalone virtual machine associated with this VMSS VM. This property is only applicable to Virtual Machine Scale Sets with Flexible orchestration mode. Minimum api-version: 2025-11-01.

virtual_machine_resource_id: str | None

vm_id

Azure VM unique ID.

vm_id: str | None