Package version:

Interface VirtualMachineUpdate

Describes a Virtual Machine Update.

interface VirtualMachineUpdate {
    additionalCapabilities?: AdditionalCapabilities;
    applicationProfile?: ApplicationProfile;
    availabilitySet?: SubResource;
    billingProfile?: BillingProfile;
    capacityReservation?: CapacityReservationProfile;
    diagnosticsProfile?: DiagnosticsProfile;
    evictionPolicy?: string;
    extensionsTimeBudget?: string;
    hardwareProfile?: HardwareProfile;
    host?: SubResource;
    hostGroup?: SubResource;
    identity?: VirtualMachineIdentity;
    instanceView?: VirtualMachineInstanceView;
    licenseType?: string;
    networkProfile?: NetworkProfile;
    osProfile?: OSProfile;
    plan?: Plan;
    platformFaultDomain?: number;
    priority?: string;
    provisioningState?: string;
    proximityPlacementGroup?: SubResource;
    scheduledEventsPolicy?: ScheduledEventsPolicy;
    scheduledEventsProfile?: ScheduledEventsProfile;
    securityProfile?: SecurityProfile;
    storageProfile?: StorageProfile;
    tags?: {
        [propertyName: string]: string;
    };
    timeCreated?: any;
    userData?: string;
    virtualMachineScaleSet?: SubResource;
    vmId?: string;
    zones?: string[];
}

Hierarchy (view full)

UpdateResource
- VirtualMachineUpdate

Properties

`Optional`additionalCapabilities

additionalCapabilities?: AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

`Optional`applicationProfile

applicationProfile?: ApplicationProfile

Specifies the gallery applications that should be made available to the VM/VMSS.

`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 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. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

`Optional`billingProfile

billingProfile?: BillingProfile

Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.

`Optional`capacityReservation

capacityReservation?: CapacityReservationProfile

Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

`Optional`diagnosticsProfile

diagnosticsProfile?: DiagnosticsProfile

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

`Optional`evictionPolicy

evictionPolicy?: string

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.

`Optional`extensionsTimeBudget

extensionsTimeBudget?: string

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01.

`Optional`hardwareProfile

hardwareProfile?: HardwareProfile

Specifies the hardware settings for the virtual machine.

`Optional`host

host?: SubResource

Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.

`Optional`hostGroup

hostGroup?: SubResource

Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.

`Optional`identity

identity?: VirtualMachineIdentity

The identity of the virtual machine, if configured.

`Optional` `Readonly`instanceView

instanceView?: VirtualMachineInstanceView

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

`Optional`licenseType

licenseType?: string

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

`Optional`networkProfile

networkProfile?: NetworkProfile

Specifies the network interfaces of the virtual machine.

`Optional`osProfile

osProfile?: OSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

`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`platformFaultDomain

platformFaultDomain?: number

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01.

`Optional`priority

priority?: string

Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01

`Optional` `Readonly`provisioningState

provisioningState?: 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`proximityPlacementGroup

proximityPlacementGroup?: SubResource

Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.

`Optional`scheduledEventsPolicy

scheduledEventsPolicy?: ScheduledEventsPolicy

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.

`Optional`scheduledEventsProfile

scheduledEventsProfile?: ScheduledEventsProfile

Specifies Scheduled Event related configurations.

`Optional`securityProfile

securityProfile?: SecurityProfile

Specifies the Security related profile settings for the virtual machine.

`Optional`storageProfile

storageProfile?: StorageProfile

Specifies the storage settings for the virtual machine disks.

`Optional`tags

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

Resource tags

`Optional` `Readonly`timeCreated

timeCreated?: any

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.

`Optional`userData

userData?: string

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

`Optional`virtualMachineScaleSet

virtualMachineScaleSet?: SubResource

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01.

`Optional` `Readonly`vmId

vmId?: string

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

`Optional`zones

zones?: string[]

The virtual machine zones.

Interface VirtualMachineUpdate

Hierarchy (view full)

Index

Properties

Properties

`Optional`additionalCapabilities

`Optional`applicationProfile

`Optional`availabilitySet

`Optional`billingProfile

`Optional`capacityReservation

`Optional`diagnosticsProfile

`Optional`evictionPolicy

`Optional`extensionsTimeBudget

`Optional`hardwareProfile

`Optional`host

`Optional`hostGroup

`Optional`identity

`Optional` `Readonly`instanceView

`Optional`licenseType

`Optional`networkProfile

`Optional`osProfile

`Optional`plan

`Optional`platformFaultDomain

`Optional`priority

`Optional` `Readonly`provisioningState

`Optional`proximityPlacementGroup

`Optional`scheduledEventsPolicy

`Optional`scheduledEventsProfile

`Optional`securityProfile

`Optional`storageProfile

`Optional`tags

`Optional` `Readonly`timeCreated

`Optional`userData

`Optional`virtualMachineScaleSet

`Optional` `Readonly`vmId

`Optional`zones

Settings

Interface VirtualMachineUpdate

Hierarchy (view full)

Index

Properties

Properties

OptionaladditionalCapabilities

OptionalapplicationProfile

OptionalavailabilitySet

OptionalbillingProfile

OptionalcapacityReservation

OptionaldiagnosticsProfile

OptionalevictionPolicy

OptionalextensionsTimeBudget

OptionalhardwareProfile

Optionalhost

OptionalhostGroup

Optionalidentity

Optional ReadonlyinstanceView

OptionallicenseType

OptionalnetworkProfile

OptionalosProfile

Optionalplan

OptionalplatformFaultDomain

Optionalpriority

Optional ReadonlyprovisioningState

OptionalproximityPlacementGroup

OptionalscheduledEventsPolicy

OptionalscheduledEventsProfile

OptionalsecurityProfile

OptionalstorageProfile

Optionaltags

Optional ReadonlytimeCreated

OptionaluserData

OptionalvirtualMachineScaleSet

Optional ReadonlyvmId

Optionalzones

Settings

`Optional`additionalCapabilities

`Optional`applicationProfile

`Optional`availabilitySet

`Optional`billingProfile

`Optional`capacityReservation

`Optional`diagnosticsProfile

`Optional`evictionPolicy

`Optional`extensionsTimeBudget

`Optional`hardwareProfile

`Optional`host

`Optional`hostGroup

`Optional`identity

`Optional` `Readonly`instanceView

`Optional`licenseType

`Optional`networkProfile

`Optional`osProfile

`Optional`plan

`Optional`platformFaultDomain

`Optional`priority

`Optional` `Readonly`provisioningState

`Optional`proximityPlacementGroup

`Optional`scheduledEventsPolicy

`Optional`scheduledEventsProfile

`Optional`securityProfile

`Optional`storageProfile

`Optional`tags

`Optional` `Readonly`timeCreated

`Optional`userData

`Optional`virtualMachineScaleSet

`Optional` `Readonly`vmId

`Optional`zones