VirtualMachineScaleSetVMProfile Class

Describes a virtual machine scale set virtual machine profile.

Constructor

VirtualMachineScaleSetVMProfile()

Variables

Name Description
os_profile
<xref:<xref:"VirtualMachineScaleSetOSProfile">>

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

storage_profile
<xref:<xref:"VirtualMachineScaleSetStorageProfile">>

Specifies the storage settings for the virtual machine disks.

network_profile
<xref:<xref:"VirtualMachineScaleSetNetworkProfile">>

Specifies properties of the network interfaces of the virtual machines in the scale set.

security_profile
<xref:<xref:"SecurityProfile">>

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

diagnostics_profile
<xref:<xref:"DiagnosticsProfile">>

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

extension_profile
<xref:<xref:"VirtualMachineScaleSetExtensionProfile">>

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

license_type
str

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.

priority
Union[str, <xref:"VirtualMachinePriorityTypes">]

Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. Known values are: "Regular", "Low", and "Spot".

eviction_policy
Union[str, <xref:"VirtualMachineEvictionPolicyTypes">]

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. Known values are: "Deallocate" and "Delete".

billing_profile
<xref:<xref:"BillingProfile">>

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

scheduled_events_profile
<xref:<xref:"ScheduledEventsProfile">>

Specifies Scheduled Event related configurations.

user_data
str

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.

capacity_reservation
<xref:<xref:"CapacityReservationProfile">>

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

interconnect_block_profile
<xref:<xref:"InterconnectBlockProfile">>

Specifies the Interconnect Block related details of a Scale Set. Minimum api-version: 2026-03-01.

application_profile
<xref:<xref:"ApplicationProfile">>

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

hardware_profile
<xref:<xref:"VirtualMachineScaleSetHardwareProfile">>

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

service_artifact_reference
<xref:<xref:"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.

security_posture_reference
<xref:<xref:"SecurityPostureReference">>

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

time_created
str

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.

Attributes

applicationProfile

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

applicationProfile: ApplicationProfile

billingProfile

2019-03-01.

billingProfile: BillingProfile

capacityReservation

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

capacityReservation: CapacityReservationProfile

diagnosticsProfile

2015-06-15.

diagnosticsProfile: 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. Known values are: "Deallocate" and "Delete".

evictionPolicy: str | VirtualMachineEvictionPolicyTypes

extensionProfile

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

extensionProfile: VirtualMachineScaleSetExtensionProfile

hardwareProfile

2021-11-01.

hardwareProfile: VirtualMachineScaleSetHardwareProfile

interconnectBlockProfile

Specifies the Interconnect Block related details of a Scale Set. Minimum api-version: 2026-03-01.

interconnectBlockProfile: InterconnectBlockProfile

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: str

networkProfile

Specifies properties of the network interfaces of the virtual machines in the scale set.

networkProfile: VirtualMachineScaleSetNetworkProfile

osProfile

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

osProfile: VirtualMachineScaleSetOSProfile

priority

Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. Known values are: "Regular", "Low", and "Spot".

priority: str | VirtualMachinePriorityTypes

scheduledEventsProfile

Specifies Scheduled Event related configurations.

scheduledEventsProfile: ScheduledEventsProfile

securityPostureReference

2023-03-01.

securityPostureReference: SecurityPostureReference

securityProfile

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

securityProfile: 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

storageProfile

Specifies the storage settings for the virtual machine disks.

storageProfile: VirtualMachineScaleSetStorageProfile

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.

timeCreated: str

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: str