Package version:

Interface VirtualMachineScaleSetVMProfile

Describes a virtual machine scale set virtual machine profile.

interface VirtualMachineScaleSetVMProfile {
    applicationProfile?: ApplicationProfile;
    billingProfile?: BillingProfile;
    capacityReservation?: CapacityReservationProfile;
    diagnosticsProfile?: DiagnosticsProfile;
    evictionPolicy?: string;
    extensionProfile?: VirtualMachineScaleSetExtensionProfile;
    hardwareProfile?: VirtualMachineScaleSetHardwareProfile;
    licenseType?: string;
    networkProfile?: VirtualMachineScaleSetNetworkProfile;
    osProfile?: VirtualMachineScaleSetOSProfile;
    priority?: string;
    scheduledEventsProfile?: ScheduledEventsProfile;
    securityPostureReference?: SecurityPostureReference;
    securityProfile?: SecurityProfile;
    serviceArtifactReference?: ServiceArtifactReference;
    storageProfile?: VirtualMachineScaleSetStorageProfile;
    timeCreated?: any;
    userData?: string;
}

Properties

applicationProfile? billingProfile? capacityReservation? diagnosticsProfile? evictionPolicy? extensionProfile? hardwareProfile? licenseType? networkProfile? osProfile? priority? scheduledEventsProfile? securityPostureReference? securityProfile? serviceArtifactReference? storageProfile? timeCreated? userData?

Properties

OptionalapplicationProfile

applicationProfile?: ApplicationProfile

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

OptionalbillingProfile

billingProfile?: BillingProfile

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

OptionalcapacityReservation

capacityReservation?: CapacityReservationProfile

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

OptionaldiagnosticsProfile

diagnosticsProfile?: DiagnosticsProfile

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

OptionalevictionPolicy

evictionPolicy?: string

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.

OptionalextensionProfile

extensionProfile?: VirtualMachineScaleSetExtensionProfile

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

OptionalhardwareProfile

hardwareProfile?: VirtualMachineScaleSetHardwareProfile

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

OptionallicenseType

licenseType?: string

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

OptionalnetworkProfile

networkProfile?: VirtualMachineScaleSetNetworkProfile

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

OptionalosProfile

osProfile?: VirtualMachineScaleSetOSProfile

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

Optionalpriority

priority?: string

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

OptionalscheduledEventsProfile

scheduledEventsProfile?: ScheduledEventsProfile

Specifies Scheduled Event related configurations.

OptionalsecurityPostureReference

securityPostureReference?: SecurityPostureReference

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

OptionalsecurityProfile

securityProfile?: SecurityProfile

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

OptionalserviceArtifactReference

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

OptionalstorageProfile

storageProfile?: VirtualMachineScaleSetStorageProfile

Specifies the storage settings for the virtual machine disks.

Optional ReadonlytimeCreated

timeCreated?: any

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.

OptionaluserData

userData?: string

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.

Settings

Member Visibility