Virtual Machine Scale Set

This table represents the virtual_machine_scale_set resource from Microsoft Azure.

azure.virtual_machine_scale_set

Fields

TitleIDTypeData TypeDescription
_keycorestring
additional_capabilitiescorejsonSpecifies 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.
automatic_repairs_policycorejsonPolicy for automatic repairs.
constrained_maximum_capacitycoreboolOptional property which must either be set to True or omitted.
do_not_run_extensions_on_overprovisioned_v_mscoreboolWhen 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.
etagcorestringEtag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates
extended_locationcorejsonThe extended location of the Virtual Machine Scale Set.
host_groupcorejsonSpecifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
idcorestringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identitycorejsonThe identity of the virtual machine scale set, if configured.
locationcorestringThe geo-location where the resource lives
namecorestringThe name of the resource
orchestration_modecorestringSpecifies the orchestration mode for the virtual machine scale set.
overprovisioncoreboolSpecifies whether the Virtual Machine Scale Set should be overprovisioned.
plancorejsonSpecifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
platform_fault_domain_countcoreint64Fault Domain count for each placement group.
priority_mix_policycorejsonSpecifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
provisioning_statecorestringThe provisioning state, which only appears in the response.
proximity_placement_groupcorejsonSpecifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
resiliency_policycorejsonPolicy for Resiliency
resource_groupcorestring
scale_in_policycorejsonSpecifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
scheduled_events_policycorejsonThe ScheduledEventsPolicy.
single_placement_groupcoreboolWhen 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.
skucorejsonThe virtual machine scale set sku.
sku_profilecorejsonSpecifies the sku profile for the virtual machine scale set.
spot_restore_policycorejsonSpecifies the Spot Restore properties for the virtual machine scale set.
subscription_idcorestring
subscription_namecorestring
system_datacorejsonAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagscorehstore_csv
time_createdcorestringSpecifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.
typecorestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
unique_idcorestringSpecifies the ID which uniquely identifies a Virtual Machine Scale Set.
upgrade_policycorejsonThe upgrade policy.
virtual_machine_profilecorejsonThe virtual machine profile.
zonal_platform_fault_domain_align_modecorestringSpecifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
zone_balancecoreboolWhether 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.
zonescorearray<string>The availability zones.