VirtualMachineUpdate interface

Describes a Virtual Machine Update.

Extends

Properties

additionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

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.

identity

The identity of the virtual machine, if configured.

instanceView

The virtual machine instance view.

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

networkProfile

Specifies the network interfaces 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.

provisioningState

The provisioning state, which only appears in the response.

storageProfile

Specifies the storage settings for the virtual machine disks.

tags

Resource tags

vmId

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

zones

The virtual machine zones.

Property Details

additionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

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

identity

The identity of the virtual machine, if configured.

identity?: VirtualMachineIdentity

Property Value

instanceView

The virtual machine instance view.

instanceView?: VirtualMachineInstanceView

Property Value

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

networkProfile

Specifies the network interfaces of the virtual machine.

networkProfile?: NetworkProfile

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

provisioningState

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

string

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

vmId

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

vmId?: string

Property Value

string

zones

The virtual machine zones.

zones?: string[]

Property Value

string[]