Share via

VirtualMachinePropertiesOutput interface

Package:
@azure-rest/arm-compute

Describes the properties of a Virtual Machine.

Properties

additionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.
applicationProfile

Specifies the gallery applications that should be made available to the VM/VMSS
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. 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.
billingProfile

Specifies the billing related details of a Azure Spot virtual machine.

Minimum api-version: 2019-03-01.
capacityReservation

Specifies information about the capacity reservation that is used to allocate virtual machine.

Minimum api-version: 2021-04-01.
diagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.
evictionPolicy

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.
extensionsTimeBudget

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
hardwareProfile

Specifies the hardware settings for the virtual machine.
host

Specifies information about the dedicated host that the virtual machine resides in.

Minimum api-version: 2018-10-01.
hostGroup

Specifies information about the dedicated host group that the virtual machine resides in.

Minimum api-version: 2020-06-01.

NOTE: User cannot specify both host and hostGroup properties.
instanceView

The virtual machine instance view.
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
networkProfile

Specifies the network interfaces of the virtual machine.
osProfile

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

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' > 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

    		•
    priority

    Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01
    provisioningState

    The provisioning state, which only appears in the response.
    proximityPlacementGroup

    Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01.
    scheduledEventsProfile

    Specifies Scheduled Event related configurations.
    securityProfile

    Specifies the Security related profile settings for the virtual machine.
    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.
    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
    virtualMachineScaleSet

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

    Property Details

    additionalCapabilities

    Specifies additional capabilities enabled or disabled on the virtual machine.

    additionalCapabilities?: AdditionalCapabilitiesOutput

    Property Value

    AdditionalCapabilitiesOutput

    applicationProfile

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

    applicationProfile?: ApplicationProfileOutput

    Property Value

    ApplicationProfileOutput

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

    availabilitySet?: SubResourceOutput

    Property Value

    SubResourceOutput

    billingProfile

    Specifies the billing related details of a Azure Spot virtual machine.

    Minimum api-version: 2019-03-01.

    billingProfile?: BillingProfileOutput

    Property Value

    BillingProfileOutput

    capacityReservation

    Specifies information about the capacity reservation that is used to allocate virtual machine.

    Minimum api-version: 2021-04-01.

    capacityReservation?: CapacityReservationProfileOutput

    Property Value

    CapacityReservationProfileOutput

    diagnosticsProfile

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    diagnosticsProfile?: DiagnosticsProfileOutput

    Property Value

    DiagnosticsProfileOutput

    evictionPolicy

    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.

    evictionPolicy?: "Deallocate" | "Delete"

    Property Value

    "Deallocate" | "Delete"

    extensionsTimeBudget

    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

    extensionsTimeBudget?: string

    Property Value

    string

    hardwareProfile

    Specifies the hardware settings for the virtual machine.

    hardwareProfile?: HardwareProfileOutput

    Property Value

    HardwareProfileOutput

    host

    Specifies information about the dedicated host that the virtual machine resides in.

    Minimum api-version: 2018-10-01.

    host?: SubResourceOutput

    Property Value

    SubResourceOutput

    hostGroup

    Specifies information about the dedicated host group that the virtual machine resides in.

    Minimum api-version: 2020-06-01.

    NOTE: User cannot specify both host and hostGroup properties.

    hostGroup?: SubResourceOutput

    Property Value

    SubResourceOutput

    instanceView

    The virtual machine instance view.

    instanceView?: VirtualMachineInstanceViewOutput

    Property Value

    VirtualMachineInstanceViewOutput

    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

    networkProfile

    Specifies the network interfaces of the virtual machine.

    networkProfile?: NetworkProfileOutput

    Property Value

    NetworkProfileOutput

    osProfile

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

    osProfile?: OSProfileOutput

    Property Value

    OSProfileOutput

    platformFaultDomain

    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' > 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

    platformFaultDomain?: number

    Property Value

    number

    • priority

    Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01

    priority?: "Regular" | "Low" | "Spot"

    Property Value

    "Regular" | "Low" | "Spot"

    provisioningState

    The provisioning state, which only appears in the response.

    provisioningState?: string

    Property Value

    string

    proximityPlacementGroup

    Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01.

    proximityPlacementGroup?: SubResourceOutput

    Property Value

    SubResourceOutput

    scheduledEventsProfile

    Specifies Scheduled Event related configurations.

    scheduledEventsProfile?: ScheduledEventsProfileOutput

    Property Value

    ScheduledEventsProfileOutput

    securityProfile

    Specifies the Security related profile settings for the virtual machine.

    securityProfile?: SecurityProfileOutput

    Property Value

    SecurityProfileOutput

    storageProfile

    Specifies the storage settings for the virtual machine disks.

    storageProfile?: StorageProfileOutput

    Property Value

    StorageProfileOutput

    timeCreated

    Specifies the time at which the Virtual Machine resource was created.

    Minimum api-version: 2021-11-01.

    timeCreated?: string

    Property Value

    string

    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

    virtualMachineScaleSet

    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

    virtualMachineScaleSet?: SubResourceOutput

    Property Value

    SubResourceOutput

    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