VirtualMachineScaleSetVMProfile interface
Describes a virtual machine scale set virtual machine profile.
Properties
| application |
Specifies the gallery applications that should be made available to the VM/VMSS |
| billing |
Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. |
| capacity |
Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. |
| diagnostics |
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
| eviction |
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. |
| extension |
Specifies a collection of settings for extensions installed on virtual machines in the scale set. |
| hardware |
Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. |
| license |
Specifies that the image or disk that is being used was licensed on-premises. |
| network |
Specifies properties of the network interfaces of the virtual machines in the scale set. |
| os |
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. |
| scheduled |
Specifies Scheduled Event related configurations. |
| security |
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 |
| security |
Specifies the Security related profile settings for the virtual machines in the scale set. |
| service |
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 |
| storage |
Specifies the storage settings for the virtual machine disks. |
| time |
Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. NOTE: This property will not be serialized. It can only be populated by the server. |
| user |
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?: ApplicationProfileProperty Value
billingProfile
Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.
billingProfile?: BillingProfileProperty Value
capacityReservation
Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.
capacityReservation?: CapacityReservationProfileProperty Value
diagnosticsProfile
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
diagnosticsProfile?: DiagnosticsProfileProperty Value
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?: stringProperty Value
string
extensionProfile
Specifies a collection of settings for extensions installed on virtual machines in the scale set.
extensionProfile?: VirtualMachineScaleSetExtensionProfileProperty Value
hardwareProfile
Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.
hardwareProfile?: VirtualMachineScaleSetHardwareProfileProperty Value
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?: stringProperty Value
string
networkProfile
Specifies properties of the network interfaces of the virtual machines in the scale set.
networkProfile?: VirtualMachineScaleSetNetworkProfileProperty Value
osProfile
Specifies the operating system settings for the virtual machines in the scale set.
osProfile?: VirtualMachineScaleSetOSProfileProperty Value
priority
Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview.
priority?: stringProperty Value
string
scheduledEventsProfile
Specifies Scheduled Event related configurations.
scheduledEventsProfile?: ScheduledEventsProfileProperty Value
securityPostureReference
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01
securityPostureReference?: SecurityPostureReferenceProperty Value
securityProfile
Specifies the Security related profile settings for the virtual machines in the scale set.
securityProfile?: SecurityProfileProperty Value
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?: ServiceArtifactReferenceProperty Value
storageProfile
Specifies the storage settings for the virtual machine disks.
storageProfile?: VirtualMachineScaleSetStorageProfileProperty Value
timeCreated
Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. NOTE: This property will not be serialized. It can only be populated by the server.
timeCreated?: DateProperty 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?: stringProperty Value
string