VirtualMachineScaleSetVMProfile interface

Package:

@azure/arm-compute

Describes a virtual machine scale set virtual machine profile.

Properties

applicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS
billingProfile	Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.
capacityReservation	Specifies the capacity reservation related details of a scale set. 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.
extensionProfile	Specifies a collection of settings for extensions installed on virtual machines in the scale set.
hardwareProfile	Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-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 properties of the network interfaces of the virtual machines in the scale set.
osProfile	Specifies the operating system settings for the virtual machines in the scale set.
priority	Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview.
scheduledEventsProfile	Specifies Scheduled Event related configurations.
securityPostureReference	Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01
securityProfile	Specifies the Security related profile settings for the virtual machines in the scale set.
serviceArtifactReference	Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01
storageProfile	Specifies the storage settings for the virtual machine disks.
timeCreated	Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2024-03-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2024-03-01. NOTE: This property will not be serialized. It can only be populated by the server.
userData	UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

Property Details

applicationProfile

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

applicationProfile?: ApplicationProfile

Property Value

ApplicationProfile

billingProfile

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

billingProfile?: BillingProfile

Property Value

BillingProfile

capacityReservation

Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.

capacityReservation?: CapacityReservationProfile

Property Value

CapacityReservationProfile

diagnosticsProfile

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

diagnosticsProfile?: DiagnosticsProfile

Property Value

DiagnosticsProfile

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

Property Value

string

extensionProfile

Specifies a collection of settings for extensions installed on virtual machines in the scale set.

extensionProfile?: VirtualMachineScaleSetExtensionProfile

Property Value

VirtualMachineScaleSetExtensionProfile

hardwareProfile

Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.

hardwareProfile?: VirtualMachineScaleSetHardwareProfile

Property Value

VirtualMachineScaleSetHardwareProfile

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 properties of the network interfaces of the virtual machines in the scale set.

networkProfile?: VirtualMachineScaleSetNetworkProfile

Property Value

VirtualMachineScaleSetNetworkProfile

osProfile

Specifies the operating system settings for the virtual machines in the scale set.

osProfile?: VirtualMachineScaleSetOSProfile

Property Value

VirtualMachineScaleSetOSProfile

priority

Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview.

priority?: string

Property Value

string

scheduledEventsProfile

Specifies Scheduled Event related configurations.

scheduledEventsProfile?: ScheduledEventsProfile

Property Value

ScheduledEventsProfile

securityPostureReference

Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01

securityPostureReference?: SecurityPostureReference

Property Value

SecurityPostureReference

securityProfile

Specifies the Security related profile settings for the virtual machines in the scale set.

securityProfile?: SecurityProfile

Property Value

SecurityProfile

serviceArtifactReference

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01

serviceArtifactReference?: ServiceArtifactReference

Property Value

ServiceArtifactReference

storageProfile

Specifies the storage settings for the virtual machine disks.

storageProfile?: VirtualMachineScaleSetStorageProfile

Property Value

VirtualMachineScaleSetStorageProfile

timeCreated

Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2024-03-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2024-03-01. NOTE: This property will not be serialized. It can only be populated by the server.

timeCreated?: Date

Property Value

Date

userData

UserData for the virtual machines in the scale set, 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