The New-AzVmss cmdlet creates a Virtual Machine Scale Set (VMSS) in Azure.
Use the simple parameter set (SimpleParameterSet) to quickly create a pre-set VMSS and associated resources.
Use the default parameter set (DefaultParameter) for more advanced scenarios when you need to precisely configure each component of the VMSS and each associated resource before creation.
For default parameter set, first use the New-AzVmssConfig cmdlet to create a virtual machine scale set object.
Then use the following cmdlets to set different properties of the virtual machine scale set object:
Get-AzComputeResourceSku can also be used to find out available virtual machine sizes for your subscription and region.
See other cmdlets for virtual machine scale set here.
VMSS creation will default to OrchestrationMode:Flexible. Default parameter set will set properties in VirtualMachineScaleSetVMProfile by default. To create a VMSS with an empty VirtualMachineScaleSetVMProfile property, use simple parameter set by first creating a VirtualMachineScaleSet object with an empty VirtualMachineScaleSetVMProfile property using New-AzVmssConfig.
See [Quickstart: Create a virtual machine scale set with Azure PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machine-scale-sets/quick-create-powershell) for tutorial.
Examples
Example 1: Create a VMSS using the SimpleParameterSet
$vmssName = 'VMSSNAME'
# Create credentials, I am using one way to create credentials, there are others as well.
# Pick one that makes the most sense according to your use case.
$vmPassword = ConvertTo-SecureString -String "****" -AsPlainText -Force
$vmCred = New-Object System.Management.Automation.PSCredential('USERNAME', $vmPassword)
$securityTypeStnd = "Standard"
#Create a VMSS using the default settings
New-AzVmss -Credential $vmCred -VMScaleSetName $vmssName -SecurityType $securityTypeStnd
The command above creates the following with the name $vmssName :
A Resource Group
A virtual network
A load balancer
A public IP
the VMSS with 2 instances
The default image chosen for the VMs in the VMSS is 2016-Datacenter Windows Server and the SKU is Standard_DS1_v2
Example 2: Create a VMSS using the DefaultParameterSet
The complex example above creates a VMSS, following is an explanation of what is happening:
The first command creates a resource group with the specified name and location.
The second command uses the New-AzStorageAccount cmdlet to create a storage account.
The third command then uses the Get-AzStorageAccount cmdlet to get the storage account created in the second command and stores the result in the $STOAccount variable.
The fifth command uses the New-AzVirtualNetworkSubnetConfig cmdlet to create a subnet and stores the result in the variable named $SubNet.
The sixth command uses the New-AzVirtualNetwork cmdlet to create a virtual network and stores the result in the variable named $VNet.
The seventh command uses the Get-AzVirtualNetwork to get information about the virtual network created in the sixth command and stores the information in the variable named $VNet.
The eighth and ninth command uses the New-AzPublicIpAddress and Get- AzureRmPublicIpAddress to create and get information from that public IP address.
The commands store the information in the variable named $PubIP.
The tenth command uses the New- AzureRmLoadBalancerFrontendIpConfig cmdlet to create a frontend load balancer and stores the result in the variable named $Frontend.
The eleventh command uses the New-AzLoadBalancerBackendAddressPoolConfig to create a backend address pool configuration and stores the result in the variable named $BackendAddressPool.
The twelfth command uses the New-AzLoadBalancerProbeConfig to create a probe and stores the probe information in the variable named $Probe.
The thirteenth command uses the New-AzLoadBalancerInboundNatPoolConfig cmdlet to create a load balancer inbound network address translation (NAT) pool configuration.
The fourteenth command uses the New-AzLoadBalancerRuleConfig to create a load balancer rule configuration and stores the result in the variable named $LBRule.
The fifteenth command uses the New-AzLoadBalancer cmdlet to create a load balancer and stores the result in the variable named $ActualLb.
The sixteenth command uses the Get-AzLoadBalancer to get information about the load balancer that was created in the fifteenth command and stores the information in the variable named $ExpectedLb.
The seventeenth command uses the New-AzVmssIpConfig cmdlet to create a VMSS IP configuration and stores the information in the variable named $IPCfg.
The eighteenth command uses the New-AzVmssConfig cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS.
The nineteenth command uses the New-AzVmss cmdlet to create the VMSS.
Example 3: Create a VMSS with a UserData value
$ResourceGroupName = 'RESOURCE GROUP NAME';
$vmssName = 'VMSSNAME';
$domainNameLabel = "dnl" + $ResourceGroupName;
# Create credentials, I am using one way to create credentials, there are others as well.
# Pick one that makes the most sense according to your use case.
$vmPassword = ConvertTo-SecureString -String "****" -AsPlainText -Force;
$vmCred = New-Object System.Management.Automation.PSCredential('USERNAME', $vmPassword);
$text = "UserData value to encode";
$bytes = [System.Text.Encoding]::Unicode.GetBytes($text);
$userData = [Convert]::ToBase64String($bytes);
$securityTypeStnd = "Standard";
#Create a VMSS
New-AzVmss -ResourceGroupName $ResourceGroupName -Name $vmssName -Credential $vmCred -DomainNameLabel $domainNameLabel -Userdata $userData -SecurityType $securityTypeStnd;
$vmss = Get-AzVmss -ResourceGroupName $ResourceGroupName -VMScaleSetName $vmssName -InstanceView:$false -Userdata;
Create a VMSS with a UserData value
Example 4: Create a Vmss with the security type TrustedLaunch
This example Creates a new VMSS with the new Security Type 'TrustedLaunch' and the necessary UEFISettings values, VTpmEnabled and SecureBootEnabled are true. Please check the Trusted Launch feature page for more information.
Example 5: Create a Vmss in Orchestration Mode: Flexible by default
The name of the backend address pool to use in the load balancer for this Scale Set. If no value is provided, a new backend pool will be created, with the same name as the Scale Set.
Backend port numbers used by the Scale Set load balancer to communicate with VMs in the Scale Set. If no values are specified, ports 3389 and 5985 will be used for Windows VMS, and port 22 will be used for Linux VMs.
The administrator credentials (username and password) for VMs in this Scale Set.
Username Restriction:
Windows: Cannot contain special characters /""[]:|<>+=;,?*@& or end in "."
Linux: Username must only contain letters, numbers, hyphens, and underscores and may not start with a hyphen or number. 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: 1 character Max-length: 20 characters for Windows, 64 characters for Linux Password
Must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character.
The value must be between 12 and 123 characters long.
The domain name label for the public Fully-Qualified domain name (FQDN) for this Scale Set. This is the first component of the domain name that is automatically assigned to the Scale Set. Automatically assigned Domain names use the form (<DomainNameLabel>.<Location>.cloudapp.azure.com). If no value is supplied, the default domain name label will be the concatenation of <ScaleSetName> and <ResourceGroupName>.
This parameter will enable the encryption for all the disks including Resource/Temp disk at host itself.
Default: The Encryption at host will be disabled unless this property is set to true for the resource.
The name of the frontend address pool to use in the Scale Set load balancer. If no value is supplied, a new Frontend Address Pool will be created, with the same name as the scale set.
used to make a request conditional for the PUT and other non-safe methods. The server will only return the requested resources if the resource matches one of the listed ETag values. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported.
The alias of the image for VMs in this Scale Set. If no value is provided, the "Windows Server 2016 DataCenter" image will be used. The available aliases are: Win2022AzureEdition, Win2022AzureEditionCore, Win2019Datacenter, Win2016Datacenter, Win2012R2Datacenter, Win2012Datacenter, UbuntuLTS, Ubuntu2204, CentOS85Gen2, Debian11, OpenSuseLeap154Gen2, RHELRaw8LVMGen2, SuseSles15SP3, FlatcarLinuxFreeGen2.
The name of the load balancer to use with this Scale Set. A new load balancer using the same name as the Scale Set will be created if no value is specified.
The Azure location where this Scale Set will be created. If no value is specified, the location will be inferred from the location of other resources referenced in the parameters.
Specifies the orchestration mode for the virtual machine scale set. Possible values: Uniform, Flexible
Creating a VMSS in OrchestrationMode:Flexible using default parameter set will result in having the VirtualMachineScaleSetVMProfile being populated by default.
If you want to create a VMSS with an empty VirtualMachineScaleSetVMProfile, first create a VirtualMachineScaleSet object with empty VMProfile property using New-AzVmssConfig, then create the VMSS using simple parameter set.
The priority for the virtual machine in the scale set. Only supported values are 'Regular', 'Spot' and 'Low'.
'Regular' is for regular virtual machine.
'Spot' is for spot virtual machine.
'Low' is also for spot virtual machine but is replaced by 'Spot'. Please use 'Spot' instead of 'Low'.
The name of the public IP Address to use with this scale set. A new Public IPAddress with the same name as the Scale Set will be created if no value is provided.
Specifies the name of the resource group of the VMSS. If no value is specified, a new ResourceGroup will be created using the same name as the Scale Set.
The rules to be followed when scaling-in a virtual machine scale set. Possible values are: 'Default', 'OldestVM' and 'NewestVM'. 'Default' when a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. 'OldestVM' when a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. 'NewestVM' when a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.
The name of the network security group to apply to this Scale Set. If no value is provided, a default network security group with the same name as the Scale Set will be created and applied to the Scale Set.
The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. UefiSettings will not be enabled unless this property is set.
The name fo the Virtual Network to use with this scale set. If no value is supplied, a new virtual network with the same name as the Scale Set will be created.
The size of the VM instances in this scale set. Get-AzComputeResourceSku can be used to find out available sizes for your subscription and region. A default size (Standard_DS1_v2) will be used if no Size is specified.
The address prefix for the virtual network used with this Scale Set. Default virtual network address prefix settings (192.168.0.0/16) will be used if no value is supplied.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.