Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VirtualMachineScaleSetVM

Package version

Describes a virtual machine scale set virtual machine.

Hierarchy

Index

Properties

Properties

Optional availabilitySet

availabilitySet: 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 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.

Optional diagnosticsProfile

diagnosticsProfile: DiagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

Optional hardwareProfile

hardwareProfile: HardwareProfile

Specifies the hardware settings for the virtual machine.

Optional id

id: undefined | string

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

Optional instanceId

instanceId: undefined | string

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

Optional instanceView

instanceView: VirtualMachineScaleSetVMInstanceView

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

Optional latestModelApplied

latestModelApplied: undefined | false | true

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.

Optional licenseType

licenseType: undefined | string

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

location: string

Resource location

Optional name

name: undefined | string

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

Optional networkProfile

networkProfile: NetworkProfile

Specifies the network interfaces of the virtual machine.

Optional osProfile

osProfile: OSProfile

Specifies the operating system settings for the virtual machine.

Optional plan

plan: 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.

Optional provisioningState

provisioningState: undefined | string

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

Optional resources

resources: VirtualMachineExtension[]

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

Optional sku

sku: Sku

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

Optional storageProfile

storageProfile: StorageProfile

Specifies the storage settings for the virtual machine disks.

Optional tags

tags: undefined | object

Resource tags

Optional type

type: undefined | string

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

Optional vmId

vmId: undefined | string

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

Generated using TypeDoc