VirtualMachineScaleSetPropertiesOutput interface

Package:

@azure-rest/arm-compute

Describes the properties of a Virtual Machine Scale Set.

Properties

additionalCapabilities	Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
automaticRepairsPolicy	Policy for automatic repairs.
doNotRunExtensionsOnOverprovisionedVMs	When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
hostGroup	Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
orchestrationMode	Specifies the orchestration mode for the virtual machine scale set.
overprovision	Specifies whether the Virtual Machine Scale Set should be overprovisioned.
platformFaultDomainCount	Fault Domain count for each placement group.
priorityMixPolicy	Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
provisioningState	The provisioning state, which only appears in the response.
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
scaleInPolicy	Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
singlePlacementGroup	When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
spotRestorePolicy	Specifies the Spot Restore properties for the virtual machine scale set.
timeCreated	Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.
uniqueId	Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
upgradePolicy	The upgrade policy.
virtualMachineProfile	The virtual machine profile.
zoneBalance	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

Property Details

additionalCapabilities

Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

additionalCapabilities?: AdditionalCapabilitiesOutput

Property Value

AdditionalCapabilitiesOutput

automaticRepairsPolicy

Policy for automatic repairs.

automaticRepairsPolicy?: AutomaticRepairsPolicyOutput

Property Value

AutomaticRepairsPolicyOutput

doNotRunExtensionsOnOverprovisionedVMs

When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.

doNotRunExtensionsOnOverprovisionedVMs?: boolean

Property Value

boolean

hostGroup

Specifies information about the dedicated host group that the virtual machine scale set resides in.

Minimum api-version: 2020-06-01.

hostGroup?: SubResourceOutput

Property Value

SubResourceOutput

orchestrationMode

Specifies the orchestration mode for the virtual machine scale set.

orchestrationMode?: "Uniform" | "Flexible"

Property Value

"Uniform" | "Flexible"

overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

overprovision?: boolean

Property Value

boolean

platformFaultDomainCount

Fault Domain count for each placement group.

platformFaultDomainCount?: number

Property Value

number

priorityMixPolicy

Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.

priorityMixPolicy?: PriorityMixPolicyOutput

Property Value

PriorityMixPolicyOutput

provisioningState

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

string

proximityPlacementGroup

Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01.

proximityPlacementGroup?: SubResourceOutput

Property Value

SubResourceOutput

scaleInPolicy

Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.

scaleInPolicy?: ScaleInPolicyOutput

Property Value

ScaleInPolicyOutput

singlePlacementGroup

When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.

singlePlacementGroup?: boolean

Property Value

boolean

spotRestorePolicy

Specifies the Spot Restore properties for the virtual machine scale set.

spotRestorePolicy?: SpotRestorePolicyOutput

Property Value

SpotRestorePolicyOutput

timeCreated

Specifies the time at which the Virtual Machine Scale Set resource was created.

Minimum api-version: 2021-11-01.

timeCreated?: string

Property Value

string

uniqueId

Specifies the ID which uniquely identifies a Virtual Machine Scale Set.

uniqueId?: string

Property Value

string

upgradePolicy

The upgrade policy.

upgradePolicy?: UpgradePolicyOutput

Property Value

UpgradePolicyOutput

virtualMachineProfile

The virtual machine profile.

virtualMachineProfile?: VirtualMachineScaleSetVMProfileOutput

Property Value

VirtualMachineScaleSetVMProfileOutput

zoneBalance

Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

zoneBalance?: boolean

Property Value

boolean