Virtual Machine Scale Sets - Update
Update a VM scale set.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2024-07-01URI Parameters
| 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. |
|
vm
|
path | True |
string |
The name of the VM scale set to create or update. |
|
api-version
|
query | True |
string |
Client Api Version. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| If-Match |
string |
The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. |
|
| If-None-Match |
string |
Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. |
Request Body
| Name | Type | Description |
|---|---|---|
| identity |
The identity of the virtual machine scale set, if configured. |
|
| plan |
The purchase plan when deploying a virtual machine scale set from VM Marketplace images. |
|
| 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.overprovision |
boolean |
Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
| properties.priorityMixPolicy |
Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. |
|
| properties.proximityPlacementGroup |
Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. |
|
| properties.resiliencyPolicy |
Policy for Resiliency |
|
| 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.skuProfile |
Specifies the sku profile for the virtual machine scale set. |
|
| properties.spotRestorePolicy |
Specifies the Spot Restore properties for the virtual machine scale set. |
|
| properties.upgradePolicy |
The upgrade policy. |
|
| properties.virtualMachineProfile |
The virtual machine profile. |
|
| properties.zonalPlatformFaultDomainAlignMode |
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. |
|
| sku |
The virtual machine scale set sku. |
|
| tags |
object |
Resource tags |
| zones |
string[] |
The virtual machine scale set zones. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
|
Virtual |
|
Virtual |
VirtualMachineScaleSet_Update_MaximumSet_Gen
Sample request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaa?api-version=2024-07-01
{
"sku": {
"name": "DSv3-Type1",
"tier": "aaa",
"capacity": 7
},
"plan": {
"publisher": "microsoft-ads",
"product": "windows-data-science-vm",
"name": "windows2016",
"promotionCode": "aaaaaaaaaa"
},
"properties": {
"upgradePolicy": {
"mode": "Manual",
"rollingUpgradePolicy": {
"maxBatchInstancePercent": 49,
"maxUnhealthyInstancePercent": 81,
"maxUnhealthyUpgradedInstancePercent": 98,
"pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
"enableCrossZoneUpgrade": true,
"prioritizeUnhealthyInstances": true,
"rollbackFailedInstancesOnPolicyBreach": true,
"maxSurge": true
},
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true,
"disableAutomaticRollback": true,
"osRollingUpgradeDeferral": true
}
},
"automaticRepairsPolicy": {
"enabled": true,
"gracePeriod": "PT30M"
},
"virtualMachineProfile": {
"osProfile": {
"customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"patchSettings": {
"patchMode": "AutomaticByPlatform",
"enableHotpatching": true,
"assessmentMode": "ImageDefault",
"automaticByPlatformSettings": {
"rebootSetting": "Never"
}
},
"timeZone": "aaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaa"
}
],
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"linuxConfiguration": {
"ssh": {
"publicKeys": [
{
"path": "/home/{your-username}/.ssh/authorized_keys",
"keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
}
]
},
"disablePasswordAuthentication": true,
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
},
"secrets": [
{
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"vaultCertificates": [
{
"certificateUrl": "aaaaaaa",
"certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
}
]
},
"storageProfile": {
"imageReference": {
"sku": "2016-Datacenter",
"publisher": "MicrosoftWindowsServer",
"version": "latest",
"offer": "WindowsServer",
"sharedGalleryImageId": "aaaaaa",
"id": "aaaaaaaaaaaaaaaaaaa"
},
"osDisk": {
"caching": "ReadWrite",
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"diskSizeGB": 6,
"image": {
"uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
},
"vhdContainers": [
"aa"
],
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
}
},
"dataDisks": [
{
"diskSizeGB": 1023,
"createOption": "Empty",
"lun": 26,
"name": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"caching": "None",
"writeAcceleratorEnabled": true,
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskIOPSReadWrite": 28,
"diskMBpsReadWrite": 15
}
]
},
"networkProfile": {
"healthProbe": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
},
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"primary": true,
"enableAcceleratedNetworking": true,
"enableFpga": true,
"networkSecurityGroup": {
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
},
"dnsSettings": {
"dnsServers": []
},
"ipConfigurations": [
{
"name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "a",
"properties": {
"idleTimeoutInMinutes": 3,
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaa"
},
"deleteOption": "Delete"
}
},
"privateIPAddressVersion": "IPv4",
"applicationGatewayBackendAddressPools": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
],
"applicationSecurityGroups": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
],
"loadBalancerInboundNatPools": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
]
}
}
],
"enableIPForwarding": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2020-11-01"
},
"securityProfile": {
"encryptionAtHost": true,
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"securityType": "TrustedLaunch"
},
"diagnosticsProfile": {
"bootDiagnostics": {
"storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
"enabled": true
}
},
"extensionProfile": {
"extensions": [
{
"name": "{extension-name}",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
}
}
],
"extensionsTimeBudget": "PT1H20M"
},
"licenseType": "aaaaaaaaaaaa",
"billingProfile": {
"maxPrice": -1
},
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
}
},
"userData": "aaaaaaaaaaaaa"
},
"overprovision": true,
"doNotRunExtensionsOnOverprovisionedVMs": true,
"singlePlacementGroup": true,
"additionalCapabilities": {
"hibernationEnabled": true,
"ultraSSDEnabled": true
},
"scaleInPolicy": {
"rules": [
"OldestVM"
],
"forceDeletion": true
},
"proximityPlacementGroup": {
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
},
"identity": {
"type": "SystemAssigned",
"userAssignedIdentities": {
"key3951": {}
}
},
"zones": [
"1",
"2",
"3"
],
"tags": {
"key246": "aaaaaaaaaaaaaaaaaaaaaaaa"
}
}
Sample response
{
"sku": {
"tier": "Standard",
"capacity": 3,
"name": "Standard_D1_v2"
},
"location": "westus",
"properties": {
"overprovision": true,
"virtualMachineProfile": {
"storageProfile": {
"imageReference": {
"sku": "2016-Datacenter",
"publisher": "MicrosoftWindowsServer",
"version": "latest",
"offer": "WindowsServer",
"exactVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"sharedGalleryImageId": "aaaaaa",
"id": "aaaaaaaaaaaaaaaaaaa"
},
"osDisk": {
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"createOption": "FromImage",
"name": "aaaaaaaaaaaaaaa",
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"diskSizeGB": 6,
"osType": "Windows",
"image": {
"uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
},
"vhdContainers": [
"aa"
]
},
"dataDisks": [
{
"name": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"lun": 26,
"caching": "None",
"writeAcceleratorEnabled": true,
"createOption": "Empty",
"diskSizeGB": 1023,
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaa"
}
},
"diskIOPSReadWrite": 28,
"diskMBpsReadWrite": 15
}
]
},
"osProfile": {
"computerNamePrefix": "{vmss-name}",
"adminUsername": "{your-username}",
"customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "AutomaticByPlatform",
"enableHotpatching": true,
"assessmentMode": "ImageDefault",
"automaticByPlatformSettings": {
"rebootSetting": "Never"
}
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "/home/{your-username}/.ssh/authorized_keys",
"keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
},
"secrets": [
{
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"vaultCertificates": [
{
"certificateUrl": "aaaaaaa",
"certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
}
]
},
"networkProfile": {
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"primary": true,
"enableIPForwarding": true,
"ipConfigurations": [
{
"name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "a",
"properties": {
"idleTimeoutInMinutes": 3,
"dnsSettings": {
"domainNameLabel": "aaaaaaaaaaaaaaaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"deleteOption": "Delete"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"privateIPAddressVersion": "IPv4",
"applicationGatewayBackendAddressPools": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
],
"applicationSecurityGroups": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
],
"loadBalancerInboundNatPools": [
{
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
}
]
}
}
],
"enableAcceleratedNetworking": true,
"enableFpga": true,
"networkSecurityGroup": {
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
},
"dnsSettings": {
"dnsServers": [
"aaaaaaaaaaaa"
]
},
"deleteOption": "Delete"
}
}
],
"healthProbe": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
},
"networkApiVersion": "2020-11-01"
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "http://{existing-storage-account-name}.blob.core.windows.net"
}
},
"extensionProfile": {
"extensions": [
{
"name": "{extension-name}",
"type": "aaaaa",
"properties": {
"forceUpdateTag": "aaaaaaaaa",
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": {},
"protectedSettings": {},
"provisioningState": "aaaaaaaaaaaaaa",
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
},
"id": "aaaaaaaaaaaaaaaaaaaaaa"
}
],
"extensionsTimeBudget": "PT1H20M"
},
"licenseType": "aaaaaaaaaaaa",
"priority": "Regular",
"evictionPolicy": "Deallocate",
"billingProfile": {
"maxPrice": -1
},
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
}
},
"userData": "aaaaaaaaaaaaa",
"capacityReservation": {
"capacityReservationGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"applicationProfile": {
"galleryApplications": [
{
"tags": "aaaaaaaaaaa",
"order": 29,
"packageReferenceId": "aaaaaaaaaa",
"configurationReference": "aaaaa"
}
]
}
},
"upgradePolicy": {
"mode": "Manual",
"rollingUpgradePolicy": {
"maxBatchInstancePercent": 49,
"maxUnhealthyInstancePercent": 81,
"maxUnhealthyUpgradedInstancePercent": 98,
"pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
"enableCrossZoneUpgrade": true,
"prioritizeUnhealthyInstances": true,
"maxSurge": true
},
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true,
"disableAutomaticRollback": true,
"osRollingUpgradeDeferral": true
}
},
"automaticRepairsPolicy": {
"enabled": true,
"gracePeriod": "PT30M"
},
"provisioningState": "succeeded",
"doNotRunExtensionsOnOverprovisionedVMs": true,
"uniqueId": "aaaaaaaa",
"singlePlacementGroup": true,
"zoneBalance": true,
"platformFaultDomainCount": 1,
"proximityPlacementGroup": {
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
},
"hostGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"scaleInPolicy": {
"rules": [
"OldestVM"
],
"forceDeletion": true
},
"orchestrationMode": "Uniform",
"spotRestorePolicy": {
"enabled": true,
"restoreTimeout": "aaaaaaaaaa"
}
},
"plan": {
"name": "aaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaaaaaaaa"
},
"identity": {
"principalId": "aaaaaaaaaaaaaaa",
"tenantId": "aaaaaaaaaaaaaaaa",
"type": "SystemAssigned",
"userAssignedIdentities": {
"key3951": {
"principalId": "aaaa",
"clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}
},
"zones": [
"aaaaaaaaaaaaaaaaaaaa"
],
"extendedLocation": {
"name": "aaaaaaaaaaaaaaaaaaaaa",
"type": "EdgeZone"
},
"id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
"name": "{virtualMachineScaleSetName}",
"type": "Microsoft.Compute/virtualMachineScaleSets",
"tags": {
"key8425": "aaa"
}
}VirtualMachineScaleSet_Update_MinimumSet_Gen
Sample request
Sample response
{
"location": "westus"
}Definitions
| 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. |
|
Allocation |
Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. |
|
Api |
The API entity reference. |
|
Api |
Api error. |
|
Api |
Api error base. |
|
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. Minimum api-version: 2019-03-01. |
|
Boot |
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. |
|
Caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
|
Capacity |
The parameters of a capacity reservation Profile. |
|
Cloud |
An error response from the Compute service. |
|
Component |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
|
Delete |
Specify what happens to the public IP when the VM is deleted |
|
Diagnostics |
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
|
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, resource disk or nvme 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. Minimum api-version for NvmeDisk: 2024-03-01. |
|
Diff |
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. |
|
Disk |
|
|
Disk |
Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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. |
|
Disk |
Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). |
|
Disk |
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. |
|
Domain |
The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created |
|
Encryption |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
|
Event |
Specifies eventGridAndResourceGraph related Scheduled Event related configurations. |
|
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. |
|
Inner |
Inner error details. |
| 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'. |
|
Key |
Describes a reference to Key Vault Secret |
|
Linux |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
|
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 reboot setting for all AutomaticByPlatform patch installation operations. |
|
Linux |
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. |
|
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. |
| Mode |
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. |
|
Network |
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' |
|
Network |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
|
Network |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
|
Operating |
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. Possible values are: Windows, Linux. |
|
Orchestration |
Specifies the orchestration mode for the virtual machine scale set. |
|
OSImage |
|
|
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. |
|
Priority |
Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached. |
|
Protocol |
Specifies the protocol of WinRM listener. Possible values are: http, https. |
|
Proxy |
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. |
|
Public |
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. |
|
Public |
Specify public IP sku name |
|
Public |
Specify public IP sku tier |
|
Repair |
Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. |
|
Resiliency |
Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy. |
|
Resilient |
The configuration parameters used while performing resilient VM creation. |
|
Resilient |
The configuration parameters used while performing resilient VM deletion. |
|
Resource |
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. |
|
Rolling |
The configuration parameters used while performing a rolling upgrade. |
|
Scale |
Describes a scale-in policy for a virtual machine scale set. |
|
Scheduled |
|
|
Scheduled |
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. |
|
Scheduled |
|
|
security |
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. |
|
Security |
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 |
|
Security |
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 |
|
Security |
Specifies the Security profile settings for the virtual machine or virtual machine scale set. |
|
Security |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. |
|
Service |
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 |
|
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. |
|
Sku |
Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy. |
|
Sku |
Specifies the VM Size. |
|
Spot |
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. |
|
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. Minimum api-version: 2020-12-01. |
|
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}'. |
|
User |
Specifies Reboot related Scheduled Event related configurations. |
|
User |
Specifies Redeploy related Scheduled Event related configurations. |
|
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. 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. |
|
Virtual |
Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. |
|
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 |
Specifies the hardware settings for the virtual machine scale set. |
|
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 |
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 |
Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network |
|
Virtual |
Describes a virtual machine scale set network profile's network configurations. |
|
Virtual |
Describes a virtual machine scale set network profile. |
|
Virtual |
Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS 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 machine scale set storage profile. |
|
Virtual |
Describes a virtual machine scale set virtual machine profile. |
|
Virtual |
Describes a virtual machine scale set virtual machine profile. |
|
VMDisk |
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs. |
|
VMGallery |
Specifies the required information to reference a compute gallery application version |
|
VMSize |
Specifies VM Size Property settings on the virtual machine. |
|
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 reboot setting for all AutomaticByPlatform patch installation operations. |
|
Windows |
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. |
|
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 |
|
Zonal |
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. |
AdditionalCapabilities
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. |
AdditionalUnattendContent
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. |
AllocationStrategy
Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated.
| Name | Type | Description |
|---|---|---|
| CapacityOptimized |
string |
|
| LowestPrice |
string |
ApiEntityReference
The API entity reference.
| Name | Type | Description |
|---|---|---|
| id |
string |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
ApiError
Api error.
| Name | Type | Description |
|---|---|---|
| code |
string |
The error code. |
| details |
The Api error details |
|
| innererror |
The Api inner error |
|
| message |
string |
The error message. |
| target |
string |
The target of the particular error. |
ApiErrorBase
Api error base.
| Name | Type | Description |
|---|---|---|
| code |
string |
The error code. |
| message |
string |
The error message. |
| target |
string |
The target of the particular error. |
ApplicationProfile
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 |
AutomaticOSUpgradePolicy
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. If this is set to true for Windows based scale sets, enableAutomaticUpdates is automatically set to false and cannot be set to true. |
| osRollingUpgradeDeferral |
boolean |
Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. |
| useRollingUpgradePolicy |
boolean |
Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. |
AutomaticRepairsPolicy
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 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). |
| repairAction |
Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. |
BillingProfile
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. |
BootDiagnostics
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. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. |
CachingTypes
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
| Name | Type | Description |
|---|---|---|
| None |
string |
|
| ReadOnly |
string |
|
| ReadWrite |
string |
CapacityReservationProfile
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. |
CloudError
An error response from the Compute service.
| Name | Type | Description |
|---|---|---|
| error |
Api error. |
ComponentNames
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
| Name | Type | Description |
|---|---|---|
| Microsoft-Windows-Shell-Setup |
string |
DeleteOptions
Specify what happens to the public IP when the VM is deleted
| Name | Type | Description |
|---|---|---|
| Delete |
string |
|
| Detach |
string |
DiagnosticsProfile
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. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. |
DiffDiskOptions
Specifies the ephemeral disk settings for operating system disk.
| Name | Type | Description |
|---|---|---|
| Local |
string |
DiffDiskPlacement
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, resource disk or nvme 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. Minimum api-version for NvmeDisk: 2024-03-01.
| Name | Type | Description |
|---|---|---|
| CacheDisk |
string |
|
| NvmeDisk |
string |
|
| ResourceDisk |
string |
DiffDiskSettings
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. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. |
DiskControllerTypes
| Name | Type | Description |
|---|---|---|
| NVMe |
string |
|
| SCSI |
string |
DiskCreateOptionTypes
Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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.
| Name | Type | Description |
|---|---|---|
| Attach |
string |
|
| Copy |
string |
|
| Empty |
string |
|
| FromImage |
string |
|
| Restore |
string |
DiskDeleteOptionTypes
Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
Possible values:
Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.
Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted.
The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.
| Name | Type | Description |
|---|---|---|
| Delete |
string |
|
| Detach |
string |
DiskEncryptionSetParameters
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 |
DomainNameLabelScopeTypes
The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created
| Name | Type | Description |
|---|---|---|
| NoReuse |
string |
|
| ResourceGroupReuse |
string |
|
| SubscriptionReuse |
string |
|
| TenantReuse |
string |
EncryptionIdentity
Specifies the Managed Identity used by ADE to get access token for keyvault operations.
| Name | Type | Description |
|---|---|---|
| userAssignedIdentityResourceId |
string |
Specifies ARM Resource ID of one of the user identities associated with the VM. |
EventGridAndResourceGraph
Specifies eventGridAndResourceGraph related Scheduled Event related configurations.
| Name | Type | Description |
|---|---|---|
| enable |
boolean |
Specifies if event grid and resource graph is enabled for Scheduled event related configurations. |
ExtendedLocation
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. |
ExtendedLocationTypes
The type of the extended location.
| Name | Type | Description |
|---|---|---|
| EdgeZone |
string |
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. NOTE: Image reference publisher and offer can only be set when you create the scale set.
| Name | Type | Description |
|---|---|---|
| communityGalleryImageId |
string |
Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. |
| 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. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. |
InnerError
Inner error details.
| Name | Type | Description |
|---|---|---|
| errordetail |
string |
The internal error message or exception dump. |
| exceptiontype |
string |
The exception type. |
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'.
| Name | Type | Description |
|---|---|---|
| IPv4 |
string |
|
| IPv6 |
string |
KeyVaultSecretReference
Describes a reference to Key Vault Secret
| Name | Type | Description |
|---|---|---|
| secretUrl |
string |
The URL referencing a secret in a Key Vault. |
| sourceVault |
The relative URL of the Key Vault containing the secret. |
LinuxConfiguration
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. |
| enableVMAgentPlatformUpdates |
boolean |
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. |
| 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. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. |
| ssh |
Specifies the ssh key configuration for a Linux OS. |
LinuxPatchAssessmentMode
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.
| Name | Type | Description |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
LinuxPatchSettings
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. |
|
| automaticByPlatformSettings |
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. |
|
| 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. |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
| Name | Type | Description |
|---|---|---|
| Always |
string |
|
| IfRequired |
string |
|
| Never |
string |
|
| Unknown |
string |
LinuxVMGuestPatchAutomaticByPlatformSettings
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.
| Name | Type | Description |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Enables customer to schedule patching without accidental upgrades |
| rebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
LinuxVMGuestPatchMode
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
| Name | Type | Description |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
Mode
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.
| Name | Type | Description |
|---|---|---|
| Audit |
string |
|
| Enforce |
string |
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'
| Name | Type | Description |
|---|---|---|
| 2020-11-01 |
string |
NetworkInterfaceAuxiliaryMode
Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
| Name | Type | Description |
|---|---|---|
| AcceleratedConnections |
string |
|
| Floating |
string |
|
| None |
string |
NetworkInterfaceAuxiliarySku
Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
| Name | Type | Description |
|---|---|---|
| A1 |
string |
|
| A2 |
string |
|
| A4 |
string |
|
| A8 |
string |
|
| None |
string |
OperatingSystemTypes
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. Possible values are: Windows, Linux.
| Name | Type | Description |
|---|---|---|
| Linux |
string |
|
| Windows |
string |
OrchestrationMode
Specifies the orchestration mode for the virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| Flexible |
string |
|
| Uniform |
string |
OSImageNotificationProfile
| Name | Type | Description |
|---|---|---|
| enable |
boolean |
Specifies whether the OS Image Scheduled event is enabled or disabled. |
| notBeforeTimeout |
string |
Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) |
PassNames
The pass name. Currently, the only allowable value is OobeSystem.
| Name | Type | Description |
|---|---|---|
| OobeSystem |
string |
PatchSettings
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. |
|
| automaticByPlatformSettings |
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. |
|
| 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. |
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.
| 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. |
PriorityMixPolicy
Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached.
| Name | Type | Description |
|---|---|---|
| baseRegularPriorityCount |
integer |
The base number of regular priority VMs that will be created in this scale set as it scales out. |
| regularPriorityPercentageAboveBase |
integer |
The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. |
ProtocolTypes
Specifies the protocol of WinRM listener. Possible values are: http, https.
| Name | Type | Description |
|---|---|---|
| Http |
string |
|
| Https |
string |
ProxyAgentSettings
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. |
| keyIncarnationId |
integer |
Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. |
| mode |
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. |
PublicIPAddressSku
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
| Name | Type | Description |
|---|---|---|
| name |
Specify public IP sku name |
|
| tier |
Specify public IP sku tier |
PublicIPAddressSkuName
Specify public IP sku name
| Name | Type | Description |
|---|---|---|
| Basic |
string |
|
| Standard |
string |
PublicIPAddressSkuTier
Specify public IP sku tier
| Name | Type | Description |
|---|---|---|
| Global |
string |
|
| Regional |
string |
RepairAction
Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.
| Name | Type | Description |
|---|---|---|
| Reimage |
string |
|
| Replace |
string |
|
| Restart |
string |
ResiliencyPolicy
Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy.
| Name | Type | Description |
|---|---|---|
| resilientVMCreationPolicy |
The configuration parameters used while performing resilient VM creation. |
|
| resilientVMDeletionPolicy |
The configuration parameters used while performing resilient VM deletion. |
ResilientVMCreationPolicy
The configuration parameters used while performing resilient VM creation.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. |
ResilientVMDeletionPolicy
The configuration parameters used while performing resilient VM deletion.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. |
ResourceIdentityType
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.
| Name | Type | Description |
|---|---|---|
| None |
string |
|
| SystemAssigned |
string |
|
| SystemAssigned, UserAssigned |
string |
|
| UserAssigned |
string |
RollingUpgradePolicy
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%. |
| maxSurge |
boolean |
Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. |
| 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. |
| rollbackFailedInstancesOnPolicyBreach |
boolean |
Rollback failed instances to previous model if the Rolling Upgrade policy is violated. |
ScaleInPolicy
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. |
ScheduledEventsAdditionalPublishingTargets
| Name | Type | Description |
|---|---|---|
| eventGridAndResourceGraph |
The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. |
ScheduledEventsPolicy
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.
| Name | Type | Description |
|---|---|---|
| scheduledEventsAdditionalPublishingTargets |
The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. |
|
| userInitiatedReboot |
The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. |
|
| userInitiatedRedeploy |
The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. |
ScheduledEventsProfile
| Name | Type | Description |
|---|---|---|
| osImageNotificationProfile |
Specifies OS Image Scheduled Event related configurations. |
|
| terminateNotificationProfile |
Specifies Terminate Scheduled Event related configurations. |
securityEncryptionTypes
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.
| Name | Type | Description |
|---|---|---|
| DiskWithVMGuestState |
string |
|
| NonPersistedTPM |
string |
|
| VMGuestStateOnly |
string |
SecurityPostureReference
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01
| Name | Type | Description |
|---|---|---|
| excludeExtensions |
string[] |
The list of virtual machine extension names to exclude when applying the security posture. |
| id |
string |
The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest |
| isOverridable |
boolean |
Whether the security posture can be overridden by the user. |
SecurityPostureReferenceUpdate
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01
| Name | Type | Description |
|---|---|---|
| excludeExtensions |
string[] |
The list of virtual machine extension names to exclude when applying the security posture. |
| id |
string |
The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest |
| isOverridable |
boolean |
Whether the security posture can be overridden by the user. |
SecurityProfile
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. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. |
| encryptionIdentity |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
|
| proxyAgentSettings |
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. |
|
| securityType |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. |
|
| uefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. |
SecurityTypes
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
| Name | Type | Description |
|---|---|---|
| ConfidentialVM |
string |
|
| TrustedLaunch |
string |
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
| Name | Type | Description |
|---|---|---|
| id |
string |
The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} |
SettingNames
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
| Name | Type | Description |
|---|---|---|
| AutoLogon |
string |
|
| FirstLogonCommands |
string |
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.
| 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. |
SkuProfile
Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy.
| Name | Type | Description |
|---|---|---|
| allocationStrategy |
Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. |
|
| vmSizes |
Specifies the VM sizes for the virtual machine scale set. |
SkuProfileVMSize
Specifies the VM Size.
| Name | Type | Description |
|---|---|---|
| name |
string |
Specifies the name of the VM Size. |
SpotRestorePolicy
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 |
SshConfiguration
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. |
SshPublicKey
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. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). |
| 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 |
StorageAccountTypes
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.
| Name | Type | Description |
|---|---|---|
| PremiumV2_LRS |
string |
|
| Premium_LRS |
string |
|
| Premium_ZRS |
string |
|
| StandardSSD_LRS |
string |
|
| StandardSSD_ZRS |
string |
|
| Standard_LRS |
string |
|
| UltraSSD_LRS |
string |
SubResource
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
TerminateNotificationProfile
| 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) |
UefiSettings
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. Minimum api-version: 2020-12-01. |
| vTpmEnabled |
boolean |
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. |
UpgradeMode
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.
| Name | Type | Description |
|---|---|---|
| Automatic |
string |
|
| Manual |
string |
|
| Rolling |
string |
UpgradePolicy
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. |
UserAssignedIdentities
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 |
|---|---|---|
|
|
UserInitiatedReboot
Specifies Reboot related Scheduled Event related configurations.
| Name | Type | Description |
|---|---|---|
| automaticallyApprove |
boolean |
Specifies Reboot Scheduled Event related configurations. |
UserInitiatedRedeploy
Specifies Redeploy related Scheduled Event related configurations.
| Name | Type | Description |
|---|---|---|
| automaticallyApprove |
boolean |
Specifies Redeploy Scheduled Event related configurations. |
VaultCertificate
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. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. |
| 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: |
VaultSecretGroup
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. |
VirtualHardDisk
Describes the uri of a disk.
| Name | Type | Description |
|---|---|---|
| uri |
string |
Specifies the virtual hard disk's uri. |
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.
| Name | Type | Description |
|---|---|---|
| Deallocate |
string |
|
| Delete |
string |
VirtualMachinePriorityTypes
Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview.
| Name | Type | Description |
|---|---|---|
| Low |
string |
|
| Regular |
string |
|
| Spot |
string |
VirtualMachineScaleSet
Describes a Virtual Machine Scale Set.
| Name | Type | Description |
|---|---|---|
| etag |
string |
Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates |
| 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.constrainedMaximumCapacity |
boolean |
Optional property which must either be set to True or omitted. |
| 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. Minimum api-version: 2020-06-01. |
|
| 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.priorityMixPolicy |
Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. |
|
| 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. Minimum api-version: 2018-04-01. |
|
| properties.resiliencyPolicy |
Policy for Resiliency |
|
| properties.scaleInPolicy |
Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. |
|
| properties.scheduledEventsPolicy |
The ScheduledEventsPolicy. |
|
| 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.skuProfile |
Specifies the sku profile for the virtual machine scale set. |
|
| properties.spotRestorePolicy |
Specifies the Spot Restore properties for the virtual machine scale set. |
|
| properties.timeCreated |
string |
Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. |
| 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.zonalPlatformFaultDomainAlignMode |
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. |
|
| 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. |
VirtualMachineScaleSetDataDisk
Describes a virtual machine scale set data disk.
| Name | Type | Description |
|---|---|---|
| caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
|
| createOption |
The create option. |
|
| deleteOption |
Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). |
|
| 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. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. |
| 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. |
VirtualMachineScaleSetExtension
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.protectedSettingsFromKeyVault |
The extensions protected settings that are passed by reference, and consumed from key vault |
|
| 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 |
VirtualMachineScaleSetExtensionProfile
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). Minimum api-version: 2020-06-01. |
VirtualMachineScaleSetHardwareProfile
Specifies the hardware settings for the virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| vmSizeProperties |
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in VM Customization for more details. |
VirtualMachineScaleSetIdentity
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}'. |
VirtualMachineScaleSetIPConfiguration
Describes a virtual machine scale set network profile's IP configuration.
| Name | Type | Description |
|---|---|---|
| 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. |
VirtualMachineScaleSetIpTag
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. |
VirtualMachineScaleSetManagedDiskParameters
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. |
|
| securityProfile |
Specifies the security profile 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. |
VirtualMachineScaleSetNetworkConfiguration
Describes a virtual machine scale set network profile's network configurations.
| Name | Type | Description |
|---|---|---|
| name |
string |
The network configuration name. |
| properties.auxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
|
| properties.auxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
|
| properties.deleteOption |
Specify what happens to the network interface when the VM is deleted |
|
| properties.disableTcpStateTracking |
boolean |
Specifies whether the network interface is disabled for tcp state tracking. |
| 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. |
VirtualMachineScaleSetNetworkConfigurationDnsSettings
Describes a virtual machines scale sets network configuration's DNS settings.
| Name | Type | Description |
|---|---|---|
| dnsServers |
string[] |
List of DNS servers IP addresses |
VirtualMachineScaleSetNetworkProfile
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. |
VirtualMachineScaleSetOSDisk
Describes a virtual machine scale set operating system disk.
| Name | Type | Description |
|---|---|---|
| caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
|
| createOption |
Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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. |
|
| deleteOption |
Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). |
|
| diffDiskSettings |
Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. |
|
| 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. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. |
| 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. Possible values are: Windows, Linux. |
|
| 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. |
VirtualMachineScaleSetOSProfile
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. |
| allowExtensionOperations |
boolean |
Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set. |
| 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. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation |
| linuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
|
| requireGuestProvisionSignal |
boolean |
Optional property which must either be set to True or omitted. |
| 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. |
VirtualMachineScaleSetPublicIPAddressConfiguration
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. It can only be set with OrchestrationMode as Flexible. |
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
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 |
| domainNameLabelScope |
The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created |
VirtualMachineScaleSetScaleInRules
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.
| Name | Type | Description |
|---|---|---|
| Default |
string |
|
| NewestVM |
string |
|
| OldestVM |
string |
VirtualMachineScaleSetStorageProfile
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. For more information about disks, see About disks and VHDs for Azure virtual machines. |
|
| diskControllerType |
Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 |
|
| 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. For more information about disks, see About disks and VHDs for Azure virtual machines. |
VirtualMachineScaleSetUpdate
Describes a Virtual Machine Scale Set.
| Name | Type | Description |
|---|---|---|
| identity |
The identity of the virtual machine scale set, if configured. |
|
| plan |
The purchase plan when deploying a virtual machine scale set from VM Marketplace images. |
|
| 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.overprovision |
boolean |
Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
| properties.priorityMixPolicy |
Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. |
|
| properties.proximityPlacementGroup |
Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. |
|
| properties.resiliencyPolicy |
Policy for Resiliency |
|
| 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.skuProfile |
Specifies the sku profile for the virtual machine scale set. |
|
| properties.spotRestorePolicy |
Specifies the Spot Restore properties for the virtual machine scale set. |
|
| properties.upgradePolicy |
The upgrade policy. |
|
| properties.virtualMachineProfile |
The virtual machine profile. |
|
| properties.zonalPlatformFaultDomainAlignMode |
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. |
|
| sku |
The virtual machine scale set sku. |
|
| tags |
object |
Resource tags |
| zones |
string[] |
The virtual machine scale set zones. |
VirtualMachineScaleSetUpdateIPConfiguration
Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network
| Name | Type | Description |
|---|---|---|
| name |
string |
The IP configuration name. |
| properties.applicationGatewayBackendAddressPools |
The application gateway backend address pools. |
|
| properties.applicationSecurityGroups |
Specifies an array of references to application security group. |
|
| properties.loadBalancerBackendAddressPools |
The load balancer backend address pools. |
|
| properties.loadBalancerInboundNatPools |
The load balancer inbound nat pools. |
|
| properties.primary |
boolean |
Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. |
| 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 |
The subnet. |
VirtualMachineScaleSetUpdateNetworkConfiguration
Describes a virtual machine scale set network profile's network configurations.
| Name | Type | Description |
|---|---|---|
| name |
string |
The network configuration name. |
| properties.auxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
|
| properties.auxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
|
| properties.deleteOption |
Specify what happens to the network interface when the VM is deleted |
|
| properties.disableTcpStateTracking |
boolean |
Specifies whether the network interface is disabled for tcp state tracking. |
| 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 |
The virtual machine scale set IP Configuration. |
|
| properties.networkSecurityGroup |
The network security group. |
|
| properties.primary |
boolean |
Whether this is a primary NIC on a virtual machine. |
VirtualMachineScaleSetUpdateNetworkProfile
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. |
VirtualMachineScaleSetUpdateOSDisk
Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.
| Name | Type | Description |
|---|---|---|
| caching |
The caching type. |
|
| deleteOption |
Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). |
|
| diffDiskSettings |
Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. |
|
| 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. |
| image |
The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. |
|
| managedDisk |
The managed disk parameters. |
|
| vhdContainers |
string[] |
The list of virtual hard disk container uris. |
| writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
VirtualMachineScaleSetUpdateOSProfile
Describes a virtual machine scale set OS profile.
| Name | Type | Description |
|---|---|---|
| customData |
string |
A base-64 encoded string of custom data. |
| linuxConfiguration |
The Linux Configuration of the OS profile. |
|
| secrets |
The List of certificates for addition to the VM. |
|
| windowsConfiguration |
The Windows Configuration of the OS profile. |
VirtualMachineScaleSetUpdatePublicIPAddressConfiguration
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.publicIPPrefix |
The PublicIPPrefix from which to allocate publicIP addresses. |
VirtualMachineScaleSetUpdateStorageProfile
Describes a virtual machine scale set storage profile.
| Name | Type | Description |
|---|---|---|
| dataDisks |
The data disks. |
|
| diskControllerType |
Specifies the disk controller type configured for the virtual machines in the scale set. Note: You need to deallocate the virtual machines in the scale set before updating its disk controller type based on the upgrade mode configured for the scale set. Minimum api-version: 2022-08-01. |
|
| imageReference |
The image reference. |
|
| osDisk |
The OS disk. |
VirtualMachineScaleSetUpdateVMProfile
Describes a virtual machine scale set virtual machine profile.
| Name | Type | Description |
|---|---|---|
| billingProfile |
Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. |
|
| diagnosticsProfile |
The virtual machine scale set diagnostics profile. |
|
| extensionProfile |
The virtual machine scale set extension profile. |
|
| hardwareProfile |
Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. |
|
| licenseType |
string |
The license type, which is for bring your own license scenario. |
| networkProfile |
The virtual machine scale set network profile. |
|
| osProfile |
The virtual machine scale set OS profile. |
|
| scheduledEventsProfile |
Specifies Scheduled Event related configurations. |
|
| securityPostureReference |
The virtual machine scale set security posture reference. |
|
| securityProfile |
The virtual machine scale set Security profile |
|
| storageProfile |
The virtual machine scale set storage profile. |
|
| userData |
string |
UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. |
VirtualMachineScaleSetVMProfile
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. Minimum api-version: 2019-03-01. |
|
| capacityReservation |
Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. |
|
| diagnosticsProfile |
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
|
| 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. |
|
| extensionProfile |
Specifies a collection of settings for extensions installed on virtual machines in the scale set. |
|
| hardwareProfile |
Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. |
|
| 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. Minimum api-version: 2017-10-30-preview. |
|
| scheduledEventsProfile |
Specifies Scheduled Event related configurations. |
|
| securityPostureReference |
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 |
|
| securityProfile |
Specifies the Security related profile settings for the virtual machines in the scale set. |
|
| 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 |
|
| storageProfile |
Specifies the storage settings for the virtual machine disks. |
|
| timeCreated |
string |
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. |
| 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. |
VMDiskSecurityProfile
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.
| Name | Type | Description |
|---|---|---|
| diskEncryptionSet |
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. |
|
| securityEncryptionType |
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. |
VMGalleryApplication
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 |
| enableAutomaticUpgrade |
boolean |
If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS |
| 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. |
| treatFailureAsDeploymentFailure |
boolean |
Optional, If true, any failure for any operation in the VmApplication will fail the deployment |
VMSizeProperties
Specifies VM Size Property settings on the virtual machine.
| Name | Type | Description |
|---|---|---|
| vCPUsAvailable |
integer |
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region. |
| vCPUsPerCore |
integer |
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled. |
WindowsConfiguration
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. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. |
| enableVMAgentPlatformUpdates |
boolean |
Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. |
| 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. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. |
| timeZone |
string |
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. |
| winRM |
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. |
WindowsPatchAssessmentMode
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.
| Name | Type | Description |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
| Name | Type | Description |
|---|---|---|
| Always |
string |
|
| IfRequired |
string |
|
| Never |
string |
|
| Unknown |
string |
WindowsVMGuestPatchAutomaticByPlatformSettings
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.
| Name | Type | Description |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Enables customer to schedule patching without accidental upgrades |
| rebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
WindowsVMGuestPatchMode
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
| Name | Type | Description |
|---|---|---|
| AutomaticByOS |
string |
|
| AutomaticByPlatform |
string |
|
| Manual |
string |
WinRMConfiguration
Describes Windows Remote Management configuration of the VM
| Name | Type | Description |
|---|---|---|
| listeners |
The list of Windows Remote Management listeners |
WinRMListener
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 the Base64 encoding of the following JSON Object which is encoded in UTF-8: |
| protocol |
Specifies the protocol of WinRM listener. Possible values are: http, https. |
ZonalPlatformFaultDomainAlignMode
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
| Name | Type | Description |
|---|---|---|
| Aligned |
string |
|
| Unaligned |
string |