VirtualMachineScaleSetVM interface

Describes a virtual machine scale set virtual machine.

Extends

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 Manage the availability of virtual machines.

For more information on Azure planned maintenance, see Planned maintenance 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.

id

Resource Id

instanceId

The virtual machine instance ID.

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. This element is only used for images that contain the Windows Server operating system.

Possible values are:

Windows_Client

Windows_Server

If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

For more information, see Azure Hybrid Use Benefit for Windows Server

Minimum api-version: 2015-06-15

location

Resource location

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.

name

Resource name

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.

resources

The virtual machine child extension resources.

sku

The virtual machine SKU.

storageProfile

Specifies the storage settings for the virtual machine disks.

tags

Resource tags

type

Resource type

vmId

Azure VM unique ID.

zones

The virtual machine zones.

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

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 Manage the availability of virtual machines.

For more information on Azure planned maintenance, see Planned maintenance 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

diagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

diagnosticsProfile?: DiagnosticsProfile

Property Value

hardwareProfile

Specifies the hardware settings for the virtual machine.

hardwareProfile?: HardwareProfile

Property Value

id

Resource Id

id?: string

Property Value

string

instanceId

The virtual machine instance ID.

instanceId?: string

Property Value

string

instanceView

The virtual machine instance view.

instanceView?: VirtualMachineScaleSetVMInstanceView

Property Value

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. This element is only used for images that contain the Windows Server operating system.

Possible values are:

Windows_Client

Windows_Server

If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

For more information, see Azure Hybrid Use Benefit for Windows Server

Minimum api-version: 2015-06-15

licenseType?: string

Property Value

string

location

Resource location

location: 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

name

Resource name

name?: string

Property Value

string

networkProfile

Specifies the network interfaces of the virtual machine.

networkProfile?: NetworkProfile

Property Value

networkProfileConfiguration

Specifies the network profile configuration of the virtual machine.

networkProfileConfiguration?: VirtualMachineScaleSetVMNetworkProfileConfiguration

Property Value

osProfile

Specifies the operating system settings for the virtual machine.

osProfile?: OSProfile

Property Value

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

protectionPolicy

Specifies the protection policy of the virtual machine.

protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy

Property Value

provisioningState

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

string

resources

The virtual machine child extension resources.

resources?: VirtualMachineExtension[]

Property Value

sku

The virtual machine SKU.

sku?: Sku

Property Value

Sku

storageProfile

Specifies the storage settings for the virtual machine disks.

storageProfile?: StorageProfile

Property Value

tags

Resource tags

tags?: [key: string]: string

Property Value

[key: string]: string

type

Resource type

type?: string

Property Value

string

vmId

Azure VM unique ID.

vmId?: string

Property Value

string

zones

The virtual machine zones.

zones?: string[]

Property Value

string[]