VirtualMachineScaleSetVMProperties interface

Package:
@azure/arm-compute

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

Properties

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

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
hardwareProfile

Specifies the hardware settings for the virtual machine.
instanceView

The virtual machine instance view.
latestModelApplied

Specifies whether the latest model has been applied to the virtual machine.
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
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.
networkProfile

Specifies the network interfaces of the virtual machine.
networkProfileConfiguration

Specifies the network profile configuration of the virtual machine.
osProfile

Specifies the operating system settings for the virtual machine.
protectionPolicy

Specifies the protection policy of the virtual machine.
provisioningState

The provisioning state, which only appears in the response.
resilientVMDeletionStatus

Specifies the resilient VM deletion status for the virtual machine.
securityProfile

Specifies the Security related profile settings for the virtual machine.
storageProfile

Specifies the storage settings for the virtual machine disks.
timeCreated

Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
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
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.
vmId

Azure VM unique ID.

Property Details

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

Property Value

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

Property Value

SubResource

diagnosticsProfile

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

diagnosticsProfile?: DiagnosticsProfile

Property Value

DiagnosticsProfile

hardwareProfile

Specifies the hardware settings for the virtual machine.

hardwareProfile?: HardwareProfile

Property Value

HardwareProfile

instanceView

The virtual machine instance view.

instanceView?: VirtualMachineScaleSetVMInstanceView

Property Value

VirtualMachineScaleSetVMInstanceView

latestModelApplied

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

latestModelApplied?: boolean

Property Value

boolean

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?: string

Property Value

string

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?: string

Property Value

string

networkProfile

Specifies the network interfaces of the virtual machine.

networkProfile?: NetworkProfile

Property Value

NetworkProfile

networkProfileConfiguration

Specifies the network profile configuration of the virtual machine.

networkProfileConfiguration?: VirtualMachineScaleSetVMNetworkProfileConfiguration

Property Value

VirtualMachineScaleSetVMNetworkProfileConfiguration

osProfile

Specifies the operating system settings for the virtual machine.

osProfile?: OSProfile

Property Value

OSProfile

protectionPolicy

Specifies the protection policy of the virtual machine.

protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy

Property Value

VirtualMachineScaleSetVMProtectionPolicy

provisioningState

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

string

resilientVMDeletionStatus

Specifies the resilient VM deletion status for the virtual machine.

resilientVMDeletionStatus?: string

Property Value

string

securityProfile

Specifies the Security related profile settings for the virtual machine.

securityProfile?: SecurityProfile

Property Value

SecurityProfile

storageProfile

Specifies the storage settings for the virtual machine disks.

storageProfile?: StorageProfile

Property Value

StorageProfile

timeCreated

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

timeCreated?: Date

Property Value

Date

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?: string

Property Value

string

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?: string

Property Value

string

vmId

Azure VM unique ID.

vmId?: string

Property Value

string