Share via


VirtualMachineProfile interface

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.

capacityReservation

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

diagnosticsProfile

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

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 compute api-version: 2020-06-01.

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.

scheduledEventsPolicy

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

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.

userData

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

Property Details

additionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

additionalCapabilities?: AdditionalCapabilities

Property Value

applicationProfile

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

applicationProfile?: ApplicationProfile

Property Value

capacityReservation

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

capacityReservation?: CapacityReservationProfile

Property Value

diagnosticsProfile

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

diagnosticsProfile?: DiagnosticsProfile

Property Value

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 compute api-version: 2020-06-01.

extensionsTimeBudget?: string

Property Value

string

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?: NetworkProfile

Property Value

osProfile

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

osProfile?: OSProfile

Property Value

scheduledEventsPolicy

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

scheduledEventsPolicy?: ScheduledEventsPolicy

Property Value

scheduledEventsProfile

Specifies Scheduled Event related configurations.

scheduledEventsProfile?: ScheduledEventsProfile

Property Value

securityProfile

Specifies the Security related profile settings for the virtual machine.

securityProfile?: SecurityProfile

Property Value

storageProfile

Specifies the storage settings for the virtual machine disks.

storageProfile?: StorageProfile

Property Value

userData

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

userData?: string

Property Value

string