Virtual Machine Scale Sets - List
Gets a list of all VM scale sets under a resource group.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=2021-07-01| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string |
The name of the resource group. |
|
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
|
api-version
|
query | True |
string |
Client Api Version. |
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
| Name | Description |
|---|---|
|
Additional |
Enables or disables a capability on the virtual machine or virtual machine scale set. |
|
Additional |
Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied. |
|
Api |
The API entity reference. |
|
Application |
Contains the list of gallery applications that should be made available to the VM/VMSS |
|
Automatic |
The configuration parameters used for performing automatic OS upgrade. |
|
Automatic |
Specifies the configuration parameters for automatic repairs on the virtual machine scale set. |
|
Billing |
Specifies the billing related details of a Azure Spot VM or VMSS. |
|
Boot |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. |
|
Caching |
Gets the caching type. |
|
Capacity |
The parameters of a capacity reservation Profile. |
|
Component |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
|
Delete |
Specify what happens to the network interface when the VM is deleted |
|
Diagnostics |
Specifies the boot diagnostic settings state. |
|
Diff |
Specifies the ephemeral disk settings for operating system disk. |
|
Diff |
Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements |
|
Diff |
Describes the parameters of ephemeral disk settings that can be specified for operating system disk. |
|
Disk |
Specifies how the virtual machine should be created. |
|
Disk |
Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. |
|
Extended |
The complex type of the extended location. |
|
Extended |
The type of the extended location. |
|
Image |
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set. |
| IPVersion |
Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. |
|
Linux |
Specifies the Linux operating system settings on the virtual machine. |
|
Linux |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. |
|
Linux |
Specifies settings related to VM Guest Patching on Linux. |
|
Linux |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
|
Network |
specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations |
|
Operating |
The operating system of the osDiskImage. |
|
Orchestration |
Specifies the orchestration mode for the virtual machine scale set. |
|
Pass |
The pass name. Currently, the only allowable value is OobeSystem. |
|
Patch |
Specifies settings related to VM Guest Patching on Windows. |
| Plan |
Specifies 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. |
|
Protocol |
Specifies the protocol of WinRM listener. |
|
Public |
Describes the public IP Sku |
|
Public |
Specify public IP sku name |
|
Public |
Specify public IP sku tier |
|
Resource |
The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. |
|
Rolling |
The configuration parameters used while performing a rolling upgrade. |
|
Scale |
Describes a scale-in policy for a virtual machine scale set. |
|
Scheduled |
|
|
Security |
Specifies the Security profile settings for the virtual machine or virtual machine scale set. |
|
Security |
Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. |
|
Setting |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
| Sku |
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name. |
|
Spot |
Specifies the Spot-Try-Restore properties for the virtual machine scale set. |
|
Ssh |
SSH configuration for Linux based VMs running on Azure |
|
Ssh |
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. |
|
Storage |
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. |
|
Sub |
|
|
Terminate |
|
|
Uefi |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
|
Upgrade |
Specifies the mode of an upgrade to virtual machines in the scale set. |
|
Upgrade |
Describes an upgrade policy - automatic, manual, or rolling. |
|
User |
The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
|
Vault |
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. |
|
Vault |
Describes a set of certificates which are all in the same Key Vault. |
|
Virtual |
Describes the uri of a disk. |
|
Virtual |
Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. |
|
Virtual |
Specifies the priority for the virtual machine. |
|
Virtual |
Describes a Virtual Machine Scale Set. |
|
Virtual |
Describes a virtual machine scale set data disk. |
|
Virtual |
Describes a Virtual Machine Scale Set Extension. |
|
Virtual |
Describes a virtual machine scale set extension profile. |
|
Virtual |
Identity for the virtual machine scale set. |
|
Virtual |
Describes a virtual machine scale set network profile's IP configuration. |
|
Virtual |
Contains the IP tag associated with the public IP address. |
|
Virtual |
The List Virtual Machine operation response. |
|
Virtual |
Describes the parameters of a ScaleSet managed disk. |
|
Virtual |
Describes a virtual machine scale set network profile's network configurations. |
|
Virtual |
Describes a virtual machines scale sets network configuration's DNS settings. |
|
Virtual |
Describes a virtual machine scale set network profile. |
|
Virtual |
Describes a virtual machine scale set operating system disk. |
|
Virtual |
Describes a virtual machine scale set OS profile. |
|
Virtual |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration |
|
Virtual |
Describes a virtual machines scale sets network configuration's DNS settings. |
|
Virtual |
The rules to be followed when scaling-in a virtual machine scale set. |
|
Virtual |
Describes a virtual machine scale set storage profile. |
|
Virtual |
Describes a virtual machine scale set virtual machine profile. |
|
VMGallery |
Specifies the required information to reference a compute gallery application version |
|
Windows |
Specifies Windows operating system settings on the virtual machine. |
|
Windows |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. |
|
Windows |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
|
Win |
Describes Windows Remote Management configuration of the VM |
|
Win |
Describes Protocol and thumbprint of Windows Remote Management listener |
Enables or disables a capability on the virtual machine or virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| hibernationEnabled |
boolean |
The flag that enables or disables hibernation capability on the VM. |
| ultraSSDEnabled |
boolean |
The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. |
Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.
| Name | Type | Description |
|---|---|---|
| componentName |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
|
| content |
string |
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. |
| passName |
The pass name. Currently, the only allowable value is OobeSystem. |
|
| settingName |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
The API entity reference.
| Name | Type | Description |
|---|---|---|
| id |
string |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
Contains the list of gallery applications that should be made available to the VM/VMSS
| Name | Type | Description |
|---|---|---|
| galleryApplications |
Specifies the gallery applications that should be made available to the VM/VMSS |
The configuration parameters used for performing automatic OS upgrade.
| Name | Type | Description |
|---|---|---|
| disableAutomaticRollback |
boolean |
Whether OS image rollback feature should be disabled. Default value is false. |
| enableAutomaticOSUpgrade |
boolean |
Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. |
Specifies the configuration parameters for automatic repairs on the virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. |
| gracePeriod |
string |
The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). |
Specifies the billing related details of a Azure Spot VM or VMSS.
Minimum api-version: 2019-03-01.
| Name | Type | Description |
|---|---|---|
| maxPrice |
number |
Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
You can easily view the output of your console log.
Azure also enables you to see a screenshot of the VM from the hypervisor.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Whether boot diagnostics should be enabled on the Virtual Machine. |
| storageUri |
string |
Uri of the storage account to use for placing the console output and screenshot. |
Gets the caching type.
| Value | Description |
|---|---|
| None | |
| ReadOnly | |
| ReadWrite |
The parameters of a capacity reservation Profile.
| Name | Type | Description |
|---|---|---|
| capacityReservationGroup |
Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
| Value | Description |
|---|---|
| Microsoft-Windows-Shell-Setup |
Specify what happens to the network interface when the VM is deleted
| Value | Description |
|---|---|
| Delete | |
| Detach |
Specifies the boot diagnostic settings state.
Minimum api-version: 2015-06-15.
| Name | Type | Description |
|---|---|---|
| bootDiagnostics |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. |
Specifies the ephemeral disk settings for operating system disk.
| Value | Description |
|---|---|
| Local |
Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
| Value | Description |
|---|---|
| CacheDisk | |
| ResourceDisk |
Describes the parameters of ephemeral disk settings that can be specified for operating system disk.
NOTE: The ephemeral disk settings can only be specified for managed disk.
| Name | Type | Description |
|---|---|---|
| option |
Specifies the ephemeral disk settings for operating system disk. |
|
| placement |
Specifies the ephemeral disk placement for operating system disk. |
Specifies how the virtual machine should be created.
Possible values are:
Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.
FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
| Value | Description |
|---|---|
| Attach | |
| Empty | |
| FromImage |
Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.
NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
The complex type of the extended location.
| Name | Type | Description |
|---|---|---|
| name |
string |
The name of the extended location. |
| type |
The type of the extended location. |
The type of the extended location.
| Value | Description |
|---|---|
| EdgeZone |
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.
| Name | Type | Description |
|---|---|---|
| exactVersion |
string |
Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. |
| id |
string |
Resource Id |
| offer |
string |
Specifies the offer of the platform image or marketplace image used to create the virtual machine. |
| publisher |
string |
The image publisher. |
| sharedGalleryImageId |
string |
Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. |
| sku |
string |
The image SKU. |
| version |
string |
Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. |
Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
| Value | Description |
|---|---|
| IPv4 | |
| IPv6 |
Specifies the Linux operating system settings on the virtual machine.
For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
| Name | Type | Description |
|---|---|---|
| disablePasswordAuthentication |
boolean |
Specifies whether password authentication should be disabled. |
| patchSettings |
[Preview Feature] Specifies settings related to VM Guest Patching on Linux. |
|
| provisionVMAgent |
boolean |
Indicates whether virtual machine agent should be provisioned on the virtual machine. |
| ssh |
Specifies the ssh key configuration for a Linux OS. |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.
Possible values are:
ImageDefault - You control the timing of patch assessments on a virtual machine.
AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
| Value | Description |
|---|---|
| AutomaticByPlatform | |
| ImageDefault |
Specifies settings related to VM Guest Patching on Linux.
| Name | Type | Description |
|---|---|---|
| assessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. |
|
| patchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
ImageDefault - The virtual machine's default patching configuration is used.
AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
| Value | Description |
|---|---|
| AutomaticByPlatform | |
| ImageDefault |
specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations
| Value | Description |
|---|---|
| 2020-11-01 |
The operating system of the osDiskImage.
| Value | Description |
|---|---|
| Linux | |
| Windows |
Specifies the orchestration mode for the virtual machine scale set.
| Value | Description |
|---|---|
| Flexible | |
| Uniform |
The pass name. Currently, the only allowable value is OobeSystem.
| Value | Description |
|---|---|
| OobeSystem |
Specifies settings related to VM Guest Patching on Windows.
| Name | Type | Description |
|---|---|---|
| assessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. |
|
| enableHotpatching |
boolean |
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. |
| patchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
Specifies 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.
| Name | Type | Description |
|---|---|---|
| name |
string |
The plan ID. |
| product |
string |
Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. |
| promotionCode |
string |
The promotion code. |
| publisher |
string |
The publisher ID. |
Specifies the protocol of WinRM listener.
Possible values are:
http
https
| Value | Description |
|---|---|
| Http | |
| Https |
Describes the public IP Sku
| Name | Type | Description |
|---|---|---|
| name |
Specify public IP sku name |
|
| tier |
Specify public IP sku tier |
Specify public IP sku name
| Value | Description |
|---|---|
| Basic | |
| Standard |
Specify public IP sku tier
| Value | Description |
|---|---|
| Global | |
| Regional |
The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
| Value | Description |
|---|---|
| None | |
| SystemAssigned | |
| SystemAssigned, UserAssigned | |
| UserAssigned |
The configuration parameters used while performing a rolling upgrade.
| Name | Type | Description |
|---|---|---|
| enableCrossZoneUpgrade |
boolean |
Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. |
| maxBatchInstancePercent |
integer |
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. |
| maxUnhealthyInstancePercent |
integer |
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. |
| maxUnhealthyUpgradedInstancePercent |
integer |
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. |
| pauseTimeBetweenBatches |
string |
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). |
| prioritizeUnhealthyInstances |
boolean |
Upgrade all unhealthy instances in a scale set before any healthy instances. |
Describes a scale-in policy for a virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| forceDeletion |
boolean |
This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) |
| rules |
The rules to be followed when scaling-in a virtual machine scale set. |
| Name | Type | Description |
|---|---|---|
| terminateNotificationProfile |
Specifies Terminate Scheduled Event related configurations. |
Specifies the Security profile settings for the virtual machine or virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| encryptionAtHost |
boolean |
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. |
| securityType |
Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. |
|
| uefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.
Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch.
| Value | Description |
|---|---|
| TrustedLaunch |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
| Value | Description |
|---|---|
| AutoLogon | |
| FirstLogonCommands |
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
| Name | Type | Description |
|---|---|---|
| capacity |
integer |
Specifies the number of virtual machines in the scale set. |
| name |
string |
The sku name. |
| tier |
string |
Specifies the tier of virtual machines in a scale set. |
Specifies the Spot-Try-Restore properties for the virtual machine scale set.
With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints |
| restoreTimeout |
string |
Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances |
SSH configuration for Linux based VMs running on Azure
| Name | Type | Description |
|---|---|---|
| publicKeys |
The list of SSH public keys used to authenticate with linux based VMs. |
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
| Name | Type | Description |
|---|---|---|
| keyData |
string |
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. |
| path |
string |
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys |
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
| Value | Description |
|---|---|
| Premium_LRS | |
| Premium_ZRS | |
| StandardSSD_LRS | |
| StandardSSD_ZRS | |
| Standard_LRS | |
| UltraSSD_LRS |
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| Name | Type | Description |
|---|---|---|
| enable |
boolean |
Specifies whether the Terminate Scheduled event is enabled or disabled. |
| notBeforeTimeout |
string |
Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
Minimum api-version: 2020-12-01
| Name | Type | Description |
|---|---|---|
| secureBootEnabled |
boolean |
Specifies whether secure boot should be enabled on the virtual machine. |
| vTpmEnabled |
boolean |
Specifies whether vTPM should be enabled on the virtual machine. |
Specifies the mode of an upgrade to virtual machines in the scale set.
Possible values are:
Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.
Automatic - All virtual machines in the scale set are automatically updated at the same time.
| Value | Description |
|---|---|
| Automatic | |
| Manual | |
| Rolling |
Describes an upgrade policy - automatic, manual, or rolling.
| Name | Type | Description |
|---|---|---|
| automaticOSUpgradePolicy |
Configuration parameters used for performing automatic OS Upgrade. |
|
| mode |
Specifies the mode of an upgrade to virtual machines in the scale set. |
|
| rollingUpgradePolicy |
The configuration parameters used while performing a rolling upgrade. |
The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
| Name | Type | Description |
|---|---|---|
|
|
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
| Name | Type | Description |
|---|---|---|
| certificateStore |
string |
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. |
| certificateUrl |
string |
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: |
Describes a set of certificates which are all in the same Key Vault.
| Name | Type | Description |
|---|---|---|
| sourceVault |
The relative URL of the Key Vault containing all of the certificates in VaultCertificates. |
|
| vaultCertificates |
The list of key vault references in SourceVault which contain certificates. |
Describes the uri of a disk.
| Name | Type | Description |
|---|---|---|
| uri |
string |
Specifies the virtual hard disk's uri. |
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.
| Value | Description |
|---|---|
| Deallocate | |
| Delete |
Specifies the priority for the virtual machine.
Minimum api-version: 2019-03-01
| Value | Description |
|---|---|
| Low | |
| Regular | |
| Spot |
Describes a Virtual Machine Scale Set.
| Name | Type | Description |
|---|---|---|
| extendedLocation |
The extended location of the Virtual Machine Scale Set. |
|
| id |
string |
Resource Id |
| identity |
The identity of the virtual machine scale set, if configured. |
|
| location |
string |
Resource location |
| name |
string |
Resource name |
| plan |
Specifies 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. |
|
| 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. |
|
| properties.automaticRepairsPolicy |
Policy for automatic repairs. |
|
| properties.doNotRunExtensionsOnOverprovisionedVMs |
boolean |
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. |
| properties.hostGroup |
Specifies information about the dedicated host group that the virtual machine scale set resides in. |
|
| properties.orchestrationMode |
Specifies the orchestration mode for the virtual machine scale set. |
|
| properties.overprovision |
boolean |
Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
| properties.platformFaultDomainCount |
integer |
Fault Domain count for each placement group. |
| properties.provisioningState |
string |
The provisioning state, which only appears in the response. |
| properties.proximityPlacementGroup |
Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. |
|
| properties.scaleInPolicy |
Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. |
|
| properties.singlePlacementGroup |
boolean |
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. |
| properties.spotRestorePolicy |
Specifies the Spot Restore properties for the virtual machine scale set. |
|
| properties.uniqueId |
string |
Specifies the ID which uniquely identifies a Virtual Machine Scale Set. |
| properties.upgradePolicy |
The upgrade policy. |
|
| properties.virtualMachineProfile |
The virtual machine profile. |
|
| properties.zoneBalance |
boolean |
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. |
| sku |
The virtual machine scale set sku. |
|
| tags |
object |
Resource tags |
| type |
string |
Resource type |
| zones |
string[] |
The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set |
Describes a virtual machine scale set data disk.
| Name | Type | Description |
|---|---|---|
| caching |
Specifies the caching requirements. |
|
| createOption |
The create option. |
|
| diskIOPSReadWrite |
integer |
Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. |
| diskMBpsReadWrite |
integer |
Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. |
| diskSizeGB |
integer |
Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. |
| lun |
integer |
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. |
| managedDisk |
The managed disk parameters. |
|
| name |
string |
The disk name. |
| writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
Describes a Virtual Machine Scale Set Extension.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| name |
string |
The name of the extension. |
| properties.autoUpgradeMinorVersion |
boolean |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
| properties.enableAutomaticUpgrade |
boolean |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
| properties.forceUpdateTag |
string |
If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. |
| properties.protectedSettings |
object |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
| properties.provisionAfterExtensions |
string[] |
Collection of extension names after which this extension needs to be provisioned. |
| properties.provisioningState |
string |
The provisioning state, which only appears in the response. |
| properties.publisher |
string |
The name of the extension handler publisher. |
| properties.settings |
object |
Json formatted public settings for the extension. |
| properties.suppressFailures |
boolean |
Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. |
| properties.type |
string |
Specifies the type of the extension; an example is "CustomScriptExtension". |
| properties.typeHandlerVersion |
string |
Specifies the version of the script handler. |
| type |
string |
Resource type |
Describes a virtual machine scale set extension profile.
| Name | Type | Description |
|---|---|---|
| extensions |
The virtual machine scale set child extension resources. |
|
| extensionsTimeBudget |
string |
Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). |
Identity for the virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| principalId |
string |
The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. |
| tenantId |
string |
The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. |
| type |
The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. |
|
| userAssignedIdentities |
The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Describes a virtual machine scale set network profile's IP configuration.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| name |
string |
The IP configuration name. |
| properties.applicationGatewayBackendAddressPools |
Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. |
|
| properties.applicationSecurityGroups |
Specifies an array of references to application security group. |
|
| properties.loadBalancerBackendAddressPools |
Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. |
|
| properties.loadBalancerInboundNatPools |
Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. |
|
| properties.primary |
boolean |
Specifies the primary network interface in case the virtual machine has more than 1 network interface. |
| properties.privateIPAddressVersion |
Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. |
|
| properties.publicIPAddressConfiguration |
The publicIPAddressConfiguration. |
|
| properties.subnet |
Specifies the identifier of the subnet. |
Contains the IP tag associated with the public IP address.
| Name | Type | Description |
|---|---|---|
| ipTagType |
string |
IP tag type. Example: FirstPartyUsage. |
| tag |
string |
IP tag associated with the public IP. Example: SQL, Storage etc. |
The List Virtual Machine operation response.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS. |
| value |
The list of virtual machine scale sets. |
Describes the parameters of a ScaleSet managed disk.
| Name | Type | Description |
|---|---|---|
| diskEncryptionSet |
Specifies the customer managed disk encryption set resource id for the managed disk. |
|
| storageAccountType |
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. |
Describes a virtual machine scale set network profile's network configurations.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| name |
string |
The network configuration name. |
| properties.deleteOption |
Specify what happens to the network interface when the VM is deleted |
|
| properties.dnsSettings |
The dns settings to be applied on the network interfaces. |
|
| properties.enableAcceleratedNetworking |
boolean |
Specifies whether the network interface is accelerated networking-enabled. |
| properties.enableFpga |
boolean |
Specifies whether the network interface is FPGA networking-enabled. |
| properties.enableIPForwarding |
boolean |
Whether IP forwarding enabled on this NIC. |
| properties.ipConfigurations |
Specifies the IP configurations of the network interface. |
|
| properties.networkSecurityGroup |
The network security group. |
|
| properties.primary |
boolean |
Specifies the primary network interface in case the virtual machine has more than 1 network interface. |
Describes a virtual machines scale sets network configuration's DNS settings.
| Name | Type | Description |
|---|---|---|
| dnsServers |
string[] |
List of DNS servers IP addresses |
Describes a virtual machine scale set network profile.
| Name | Type | Description |
|---|---|---|
| healthProbe |
A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. |
|
| networkApiVersion |
specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' |
|
| networkInterfaceConfigurations |
The list of network configurations. |
Describes a virtual machine scale set operating system disk.
| Name | Type | Description |
|---|---|---|
| caching |
Specifies the caching requirements. |
|
| createOption |
Specifies how the virtual machines in the scale set should be created. |
|
| diffDiskSettings |
Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. |
|
| diskSizeGB |
integer |
Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. |
| image |
Specifies information about the unmanaged user image to base the scale set on. |
|
| managedDisk |
The managed disk parameters. |
|
| name |
string |
The disk name. |
| osType |
This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. |
|
| vhdContainers |
string[] |
Specifies the container urls that are used to store operating system disks for the scale set. |
| writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
Describes a virtual machine scale set OS profile.
| Name | Type | Description |
|---|---|---|
| adminPassword |
string |
Specifies the password of the administrator account. |
| adminUsername |
string |
Specifies the name of the administrator account. |
| computerNamePrefix |
string |
Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. |
| customData |
string |
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. |
| linuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. |
|
| secrets |
Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
|
| windowsConfiguration |
Specifies Windows operating system settings on the virtual machine. |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
| Name | Type | Description |
|---|---|---|
| name |
string |
The publicIP address configuration name. |
| properties.deleteOption |
Specify what happens to the public IP when the VM is deleted |
|
| properties.dnsSettings |
Virtual |
The dns settings to be applied on the publicIP addresses . |
| properties.idleTimeoutInMinutes |
integer |
The idle timeout of the public IP address. |
| properties.ipTags |
The list of IP tags associated with the public IP address. |
|
| properties.publicIPAddressVersion |
Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. |
|
| properties.publicIPPrefix |
The PublicIPPrefix from which to allocate publicIP addresses. |
|
| sku |
Describes the public IP Sku |
Describes a virtual machines scale sets network configuration's DNS settings.
| Name | Type | Description |
|---|---|---|
| domainNameLabel |
string |
The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created |
The rules to be followed when scaling-in a virtual machine scale set.
Possible values are:
Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.
OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.
NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.
| Value | Description |
|---|---|
| Default | |
| NewestVM | |
| OldestVM |
Describes a virtual machine scale set storage profile.
| Name | Type | Description |
|---|---|---|
| dataDisks |
Specifies the parameters that are used to add data disks to the virtual machines in the scale set. |
|
| imageReference |
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. |
|
| osDisk |
Specifies information about the operating system disk used by the virtual machines in the scale set. |
Describes a virtual machine scale set virtual machine profile.
| Name | Type | Description |
|---|---|---|
| applicationProfile |
Specifies the gallery applications that should be made available to the VM/VMSS |
|
| billingProfile |
Specifies the billing related details of a Azure Spot VMSS. |
|
| capacityReservation |
Specifies the capacity reservation related details of a scale set. |
|
| diagnosticsProfile |
Specifies the boot diagnostic settings state. |
|
| evictionPolicy |
Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. |
|
| extensionProfile |
Specifies a collection of settings for extensions installed on virtual machines in the scale set. |
|
| licenseType |
string |
Specifies that the image or disk that is being used was licensed on-premises. |
| networkProfile |
Specifies properties of the network interfaces of the virtual machines in the scale set. |
|
| osProfile |
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. |
|
| scheduledEventsProfile |
Specifies Scheduled Event related configurations. |
|
| securityProfile |
Specifies the Security related profile settings for the virtual machines in the scale set. |
|
| storageProfile |
Specifies the storage settings for the virtual machine disks. |
|
| 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. |
Specifies the required information to reference a compute gallery application version
| Name | Type | Description |
|---|---|---|
| configurationReference |
string |
Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided |
| order |
integer |
Optional, Specifies the order in which the packages have to be installed |
| packageReferenceId |
string |
Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} |
| tags |
string |
Optional, Specifies a passthrough value for more generic context. |
Specifies Windows operating system settings on the virtual machine.
| Name | Type | Description |
|---|---|---|
| additionalUnattendContent |
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. |
|
| enableAutomaticUpdates |
boolean |
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. |
| patchSettings |
[Preview Feature] Specifies settings related to VM Guest Patching on Windows. |
|
| provisionVMAgent |
boolean |
Indicates whether virtual machine agent should be provisioned on the virtual machine. |
| timeZone |
string |
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". |
| winRM |
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.
Possible values are:
ImageDefault - You control the timing of patch assessments on a virtual machine.
AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
| Value | Description |
|---|---|
| AutomaticByPlatform | |
| ImageDefault |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false
AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.
AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
| Value | Description |
|---|---|
| AutomaticByOS | |
| AutomaticByPlatform | |
| Manual |
Describes Windows Remote Management configuration of the VM
| Name | Type | Description |
|---|---|---|
| listeners |
The list of Windows Remote Management listeners |
Describes Protocol and thumbprint of Windows Remote Management listener
| Name | Type | Description |
|---|---|---|
| certificateUrl |
string |
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: |
| protocol |
Specifies the protocol of WinRM listener. |