VirtualMachineScaleSetVMProperties Class
Describes the properties of a virtual machine scale set virtual machine.
Constructor
VirtualMachineScaleSetVMProperties()
Variables
| Name | Description |
|---|---|
|
latest_model_applied
|
Specifies whether the latest model has been applied to the virtual machine. |
|
vm_id
|
Azure VM unique ID. |
|
instance_view
|
<xref:<xref:"VirtualMachineScaleSetVMInstanceView">>
The virtual machine instance view. |
|
hardware_profile
|
<xref:<xref:"HardwareProfile">>
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
|
<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 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
|
<xref:<xref:"OSProfile">>
Specifies the operating system settings for the virtual machine. |
|
security_profile
|
<xref:<xref:"SecurityProfile">>
Specifies the Security related profile settings for the virtual machine. |
|
network_profile
|
<xref:<xref:"NetworkProfile">>
Specifies the network interfaces of the virtual machine. |
|
network_profile_configuration
|
<xref:<xref:"VirtualMachineScaleSetVMNetworkProfileConfiguration">>
Specifies the network profile configuration of 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. An existing VM cannot be added to an availability set. |
|
provisioning_state
|
The provisioning state, which only appears in the response. |
|
license_type
|
Specifies that the image or disk that is being used was licensed
on-premises. |
|
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. |
|
protection_policy
|
<xref:<xref:"VirtualMachineScaleSetVMProtectionPolicy">>
Specifies the protection policy of the virtual machine. |
|
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. |
|
time_created
|
Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. |
|
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. |
|
interconnect_block_profile
|
<xref:<xref:"InterconnectBlockProfile">>
Specifies the Interconnect Block related details of a Scale Set VM instance. Minimum api-version: 2026-03-01. |
Attributes
additionalCapabilities
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.
additionalCapabilities: AdditionalCapabilities
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. An existing VM cannot be added to an availability set.
availabilitySet: SubResource
diagnosticsProfile
2015-06-15.
diagnosticsProfile: DiagnosticsProfile
hardwareProfile
Specifies the hardware settings for the virtual machine.
hardwareProfile: HardwareProfile
instanceView
The virtual machine instance view.
instanceView: VirtualMachineScaleSetVMInstanceView
interconnectBlockProfile
Specifies the Interconnect Block related details of a Scale Set VM instance. Minimum api-version: 2026-03-01.
interconnectBlockProfile: InterconnectBlockProfile
latestModelApplied
Specifies whether the latest model has been applied to the virtual machine.
latestModelApplied: bool
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
modelDefinitionApplied
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.
modelDefinitionApplied: str
networkProfile
Specifies the network interfaces of the virtual machine.
networkProfile: NetworkProfile
networkProfileConfiguration
Specifies the network profile configuration of the virtual machine.
networkProfileConfiguration: VirtualMachineScaleSetVMNetworkProfileConfiguration
osProfile
Specifies the operating system settings for the virtual machine.
osProfile: OSProfile
protectionPolicy
Specifies the protection policy of the virtual machine.
protectionPolicy: VirtualMachineScaleSetVMProtectionPolicy
provisioningState
The provisioning state, which only appears in the response.
provisioningState: str
resilientVMDeletionStatus
Specifies the resilient VM deletion status for the virtual machine. Known values are: "Enabled", "Disabled", "InProgress", and "Failed".
resilientVMDeletionStatus: str | ResilientVMDeletionStatus
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
virtualMachineResourceId
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.
virtualMachineResourceId: str
vmId
Azure VM unique ID.
vmId: str