Microsoft.AzureFleet (preview:2025-07-01)

2025/08/11 • 10 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureFleet/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_ListBySubscription (new)
Description :  List Fleet resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureFleet/fleets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Fleet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
zones:
{
Description: Zones in which the Compute Fleet is available ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_ListByResourceGroup (new)
Description :  List Fleet resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Fleet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
zones:
{
Description: Zones in which the Compute Fleet is available ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_Get (new)
Description :  Get a Fleet
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Compute Fleet ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
zones:
{
Description: Zones in which the Compute Fleet is available ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_CreateOrUpdate (new)
Description :  Create a Fleet
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Compute Fleet ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
zones:
{
Description: Zones in which the Compute Fleet is available ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
zones:
{
Description: Zones in which the Compute Fleet is available ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An Compute Fleet resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
zones:
{
Description: Zones in which the Compute Fleet is available ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_Update (new)
Description :  Update a Fleet
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Compute Fleet ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Updatable managed service identity ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Updatable resource plan ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: False ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: False ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: RP-specific updatable properties ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: False ,
}
enum ,
spotPriorityProfile:
{
Description: Configuration Options for Spot instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPricePerVM:
{
Description: Price per hour of each Spot VM will never exceed this. ,
Format: float ,
Required: False ,
}
number ,
evictionPolicy:
{
Description: Eviction Policy to follow when evicting Spot VMs. ,
Enum:
{
Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. ,
Deallocate: When evicted, the Spot VM will be deallocated/stopped ,
}
,
Required: False ,
}
enum ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. ,
Enum:
{
PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. ,
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight. ,
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity. ,
}
,
Required: False ,
}
enum ,
maintain:
{
Description: Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default. ,
Required: False ,
}
boolean ,
}
,
regularPriorityProfile:
{
Description: Configuration Options for Regular instances in Compute Fleet. ,
Required: False ,
}
{
capacity:
{
Description: Total capacity to achieve. It is currently in terms of number of VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. ,
Format: int32 ,
Required: False ,
}
integer ,
allocationStrategy:
{
Description: Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. ,
Enum:
{
LowestPrice: Default. VM sizes distribution will be determined to optimize for price. ,
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size. ,
}
,
Required: False ,
}
enum ,
}
,
vmSizesProfile:
{
Description: List of VM sizes supported for Compute Fleet ,
Required: True ,
}
[
{
name:
{
Description: The Sku name (e.g. 'Standard_DS1_v2') ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmAttributes:
{
Description: Attribute based Fleet. ,
Required: False ,
}
{
vCpuCount:
{
Description: The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memoryInGiB:
{
Description: The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. ,
Required: True ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
memoryInGiBPerVCpu:
{
Description: The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageSupport:
{
Description: Specifies whether the VMSize supporting local storage should be used to build Fleet or not. Included - Default if not specified as most Azure VMs support local storage. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
localStorageInGiB:
{
Description: LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
localStorageDiskTypes:
{
Description: The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. If localStorageSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
dataDiskCount:
{
Description: The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkInterfaceCount:
{
Description: The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkBandwidthInMbps:
{
Description: The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. ,
Required: False ,
}
{
min:
{
Description: Minimum value. default 0. Double.MinValue() ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Maximum value. Double.MaxValue(1.7976931348623157E+308) ,
Format: double ,
Required: False ,
}
number ,
}
,
rdmaSupport:
{
Description: Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
rdmaNetworkInterfaceCount:
{
Description: The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. If rdmaSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
acceleratorSupport:
{
Description: Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
acceleratorManufacturers:
{
Description: The accelerator manufacturers specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorTypes:
{
Description: The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
[
string ,
]
,
acceleratorCount:
{
Description: The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. If acceleratorSupport is "Excluded", this VMAttribute can not be used. ,
Required: False ,
}
{
min:
{
Description: Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
vmCategories:
{
Description: The VM category specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
architectureTypes:
{
Description: The VM architecture types specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
cpuManufacturers:
{
Description: The VM CPU manufacturers specified as a list. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
burstableSupport:
{
Description: Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. ,
Enum:
{
Excluded: All VMSizes having the feature support will be excluded. ,
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required. ,
Required: Only the VMSizes having the feature support will be used. ,
}
,
Required: False ,
}
enum ,
excludedVMSizes:
{
Description: Specifies which VMSizes should be excluded while building Fleet. Optional parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
additionalLocationsProfile:
{
Description: Represents the configuration for additional locations where Fleet resources may be deployed. ,
Required: False ,
}
{
locationProfiles:
{
Description: The list of location profiles. ,
Required: True ,
}
[
{
location:
{
Description: The ARM location name of the additional region. If LocationProfile is specified, then location is required. ,
Required: True ,
}
string ,
virtualMachineProfileOverride:
{
Description: An override for computeProfile.baseVirtualMachineProfile specific to this region. This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
computeProfile:
{
Description: Compute Profile to use for running user's workloads. ,
Required: True ,
}
{
baseVirtualMachineProfile:
{
Description: Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" ,
Required: True ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: 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. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Format: password ,
Required: False ,
}
string ,
customData:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init) ,
Format: password ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: 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. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: AutoLogon setting ,
FirstLogonCommands: FirstLogonCommands setting ,
}
,
Required: False ,
}
enum ,
content:
{
Description: 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. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: 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'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: Http protocol ,
Https: Https protocol ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: 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 ,
Required: False ,
}
string ,
keyData:
{
Description: 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://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: 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. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: 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 ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: 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. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: Unknown Reboot setting ,
IfRequired: IfRequired Reboot setting ,
Never: Never Reboot setting ,
Always: Always Reboot setting ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: 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](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Format: uri ,
Required: False ,
}
string ,
certificateStore:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: 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. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: 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. ,
Required: False ,
}
string ,
exactVersion:
{
Description: 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'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: 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. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: Local Option. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. ,
Enum:
{
CacheDisk: CacheDisk option. ,
ResourceDisk: Resource Disk option. ,
NvmeDisk: NvmeDisk option. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: 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.** ,
Enum:
{
Windows: Windows OS type ,
Linux: Linux OS type ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Format: uri ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
deleteOption:
{
Description: 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. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: 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](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: 'None' is default for Standard Storage ,
ReadOnly: 'ReadOnly' is default for Premium Storage ,
ReadWrite: 'ReadWrite' is default for OS Disk ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
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. ,
Empty: This value is used when creating an empty data disk. ,
Attach: This value is used when you are using a specialized disk to create the virtual machine. ,
Copy: This value is used to create a data disk from a snapshot or another disk. ,
Restore: This value is used to create a data disk from a disk restore point. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: 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. ,
Enum:
{
Standard_LRS: Standard_LRS option. ,
Premium_LRS: Premium_LRS option. ,
StandardSSD_LRS: StandardSSD_LRS option. ,
UltraSSD_LRS: UltraSSD_LRS option. ,
Premium_ZRS: Premium_ZRS option. ,
StandardSSD_ZRS: StandardSSD_ZRS option. ,
PremiumV2_LRS: PremiumV2_LRS option. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: 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. ,
Enum:
{
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
diskIOPSReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data 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 data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: If this value is used, the managed disk is deleted when VM gets deleted. ,
Detach: If this value is used, the managed disk is retained after VM gets deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 ,
Enum:
{
SCSI: SCSI disk type ,
NVMe: NVMe disk type ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: 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}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: 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 ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: 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 ,
Enum:
{
TenantReuse: TenantReuse type ,
SubscriptionReuse: SubscriptionReuse type ,
ResourceGroupReuse: ResourceGroupReuse type ,
NoReuse: NoReuse type ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: Basic sku name ,
Standard: Standard sku name ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: Regional sku tier ,
Global: Global sku tier ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: 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'. ,
Enum:
{
IPv4: IPv4 version ,
IPv6: IPv6 version ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: 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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: Delete Option ,
Detach: Detach Option ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: None Mode ,
AcceleratedConnections: AcceleratedConnections Mode ,
Floating: Floating Mode ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: no sku ,
A1: A1 sku ,
A2: A2 sku ,
A4: A4 sku ,
A8: A8 sku ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: 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' ,
Enum:
{
2020-11-01: Initial version supported. Later versions are supported as well. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: 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. ,
Required: False ,
}
boolean ,
securityType:
{
Description: 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. ,
Enum:
{
TrustedLaunch: TrustedLaunch security type ,
ConfidentialVM: ConfidentialVM security type ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: 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. ,
Enum:
{
Audit: Audit Mode ,
Enforce: Enforce Mode ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: 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. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: 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. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Format: uri ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: 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 not exceed 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: 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. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: 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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Format: arm-id ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: 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](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceArtifactReference:
{
Description: 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 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: List of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" ,
Format: date-time ,
Required: False ,
}
string ,
}
,
computeApiVersion:
{
Description: Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVirtualMachineCapabilities:
{
Description: Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. hibernationEnabled: Enables the hibernation capability on the VMSS VMs. Default value is null if not specified. This property cannot be updated once set. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
}
,
timeCreated:
{
Description: Specifies the time at which the Compute Fleet is created. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Compute Fleet. ,
Required: False ,
}
string ,
mode:
{
Description: Mode of the Fleet. ,
Enum:
{
Managed: Default. Managed is the default mode for Compute Fleet where VMs are provisioned via VMSS. ,
Instance: Instance mode for Compute Fleet will directly provision VM instances. ,
}
,
Required: False ,
}
enum ,
capacityType:
{
Description: Specifies capacity type for Fleet Regular and Spot priority profiles. capacityType is an immutable property. Once set during Fleet creation, it cannot be updated. Specifying different capacity type for Fleet Regular and Spot priority profiles is not allowed. ,
Enum:
{
VM: Default. VM is the default capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VMs. ,
VCpu: VCpu is the capacity type for Compute Fleet where Fleet capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, Fleet capacity in VCpus will be overprovisioned by default. ,
}
,
Required: False ,
}
enum ,
zoneAllocationPolicy:
{
Description: Zone Allocation Policy for Fleet. ,
Required: False ,
}
{
distributionStrategy:
{
Description: Distribution strategy used for zone allocation policy. ,
Enum:
{
BestEffortSingleZone: Default. Compute Fleet allocates all Fleet capacity within a single zone based on best effort. If capacity is not available, Compute Fleet can allocate capacity in different zones. ,
Prioritized: Compute Fleet allocates capacity based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. ,
}
,
Required: True ,
}
enum ,
zonePreferences:
{
Description: Zone preferences, required when zone distribution strategy is Prioritized. ,
Required: False ,
}
[
{
zone:
{
Description: Name of the zone. ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. The lower the number, the higher the priority, starting with 0. 0 is the highest rank. If not specified, defaults to lowest rank. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
zones:
{
Description: Zones in which the Compute Fleet is available ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_Delete (new)
Description :  Delete a Fleet
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Compute Fleet ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_Cancel (new)
Description :  Cancels an instance Fleet creation that is in progress.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}/cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Compute Fleet ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_ListVirtualMachineScaleSets (new)
Description :  List VirtualMachineScaleSet resources by Fleet
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachineScaleSets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Fleet ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualMachineScaleSet items on this page ,
Required: True ,
}
[
{
name:
{
Description: The name of the virtualMachineScaleSet ,
Required: True ,
}
string ,
id:
{
Description: The compute RP resource id of the virtualMachineScaleSet "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}" ,
Format: arm-id ,
Required: True ,
}
string ,
type:
{
Description: Type of the virtualMachineScaleSet ,
Required: False ,
}
string ,
operationStatus:
{
Description: This represents the operationStatus of the VMSS in response to the last operation that was performed on it by Azure Fleet resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
Migrating: Resource is being migrated from one subscription or resource group to another. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error Information when `operationStatus` is `Failed` ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The API error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The API inner error ,
Required: False ,
}
{
exceptionType:
{
Description: The exception type. ,
Required: False ,
}
string ,
errorDetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Fleets_ListVirtualMachines (new)
Description :  List VirtualMachine resources of an instance Fleet.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Fleet ,
Required: True ,
}
string ,
$filter:
{
Description: Filter expression to filter the virtual machines. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skip token for pagination. Uses the token from a previous response to fetch the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Virtual Machine items on this page. ,
Required: True ,
}
[
{
name:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
id:
{
Description: The compute RP resource id of the virtual machine. subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachines/{vmName} ,
Format: arm-id ,
Required: True ,
}
string ,
type:
{
Description: Type of the virtual machine ,
Required: False ,
}
string ,
operationStatus:
{
Description: This represents the operationStatus of the virtual machine in response to the last operation that was performed on it by Azure Fleet resource. ,
Enum:
{
Creating: Indicates that the virtual machine is either in the process of being created or is scheduled to be created. ,
Canceled: Indicates that the cancellation request was successful because the virtual machine had not been created yet. ,
CancelFailedStatusUnknown: Indicates that the cancellation request could not be applied because the virtual machine had already been created. ,
Failed: Indicates that the virtual machine operation failed. ,
Succeeded: Indicates that the virtual machine operation completed successfully. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error information when `operationStatus` is `Failed`. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The API error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The API inner error ,
Required: False ,
}
{
exceptionType:
{
Description: The exception type. ,
Required: False ,
}
string ,
errorDetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}