VirtualMachineScaleSetVM interface

Package:

@azure/arm-compute

Describes a virtual machine scale set virtual machine.

Extends

Resource

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.
etag	Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates. NOTE: This property will not be serialized. It can only be populated by the server.
hardwareProfile	Specifies the hardware settings for the virtual machine.
identity	The identity of the virtual machine, if configured.
instanceId	The virtual machine instance ID. NOTE: This property will not be serialized. It can only be populated by the server.
instanceView	The virtual machine instance view. NOTE: This property will not be serialized. It can only be populated by the server.
latestModelApplied	Specifies whether the latest model has been applied to the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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.
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
protectionPolicy	Specifies the protection policy of the virtual machine.
provisioningState	The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
resources	The virtual machine child extension resources. NOTE: This property will not be serialized. It can only be populated by the server.
securityProfile	Specifies the Security related profile settings for the virtual machine.
sku	The virtual machine SKU. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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
vmId	Azure VM unique ID. NOTE: This property will not be serialized. It can only be populated by the server.
zones	The virtual machine zones. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location
name	Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags
type	Resource type NOTE: This property will not be serialized. It can only be populated by the server.

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

etag

Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

hardwareProfile

Specifies the hardware settings for the virtual machine.

hardwareProfile?: HardwareProfile

Property Value

HardwareProfile

identity

The identity of the virtual machine, if configured.

identity?: VirtualMachineIdentity

Property Value

VirtualMachineIdentity

instanceId

The virtual machine instance ID. NOTE: This property will not be serialized. It can only be populated by the server.

instanceId?: string

Property Value

string

instanceView

The virtual machine instance view. NOTE: This property will not be serialized. It can only be populated by the server.

instanceView?: VirtualMachineScaleSetVMInstanceView

Property Value

VirtualMachineScaleSetVMInstanceView

latestModelApplied

Specifies whether the latest model has been applied to the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

plan?: Plan

Property Value

Plan

protectionPolicy

Specifies the protection policy of the virtual machine.

protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy

Property Value

VirtualMachineScaleSetVMProtectionPolicy

provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resources

The virtual machine child extension resources. NOTE: This property will not be serialized. It can only be populated by the server.

resources?: VirtualMachineExtension[]

Property Value

VirtualMachineExtension[]

securityProfile

Specifies the Security related profile settings for the virtual machine.

securityProfile?: SecurityProfile

Property Value

SecurityProfile

sku

The virtual machine SKU. NOTE: This property will not be serialized. It can only be populated by the server.

sku?: Sku

Property Value

Sku

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

vmId

Azure VM unique ID. NOTE: This property will not be serialized. It can only be populated by the server.

vmId?: string

Property Value

string

zones

The virtual machine zones. NOTE: This property will not be serialized. It can only be populated by the server.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type