New-AzVmss

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

Az.Compute

Creates a VMSS.

Syntax

New-AzVmss
   [-ResourceGroupName] <String>
   [-VMScaleSetName] <String>
   [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
   [-AsJob]
   [-EdgeZone <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzVmss
   [[-ResourceGroupName] <String>]
   [-VMScaleSetName] <String>
   [-AsJob]
   [-UserData <String>]
   [-ImageName <String>]
   -Credential <PSCredential>
   [-InstanceCount <Int32>]
   [-VirtualNetworkName <String>]
   [-SubnetName <String>]
   [-PublicIpAddressName <String>]
   [-DomainNameLabel <String>]
   [-SecurityGroupName <String>]
   [-LoadBalancerName <String>]
   [-BackendPort <Int32[]>]
   [-Location <String>]
   [-EdgeZone <String>]
   [-VmSize <String>]
   [-UpgradePolicyMode <UpgradeMode>]
   [-AllocationMethod <String>]
   [-VnetAddressPrefix <String>]
   [-SubnetAddressPrefix <String>]
   [-FrontendPoolName <String>]
   [-BackendPoolName <String>]
   [-SystemAssignedIdentity]
   [-UserAssignedIdentity <String>]
   [-EnableUltraSSD]
   [-Zone <System.Collections.Generic.List`1[System.String]>]
   [-NatBackendPort <Int32[]>]
   [-DataDiskSizeInGb <Int32[]>]
   [-ProximityPlacementGroupId <String>]
   [-HostGroupId <String>]
   [-Priority <String>]
   [-EvictionPolicy <String>]
   [-MaxPrice <Double>]
   [-ScaleInPolicy <String[]>]
   [-SkipExtensionsOnOverprovisionedVMs]
   [-EncryptionAtHost]
   [-PlatformFaultDomainCount <Int32>]
   [-OrchestrationMode <String>]
   [-CapacityReservationGroupId <String>]
   [-ImageReferenceId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SinglePlacementGroup]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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.

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 <PASSWORD_HERE> -AsPlainText -Force
$vmCred = New-Object System.Management.Automation.PSCredential(<USERNAME_HERE>, $vmPassword)

#Create a VMSS using the default settings
New-AzVmss -Credential $vmCred -VMScaleSetName $vmssName

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

# Common
$LOC = "WestUs";
$RGName = "rgkyvms";

New-AzResourceGroup -Name $RGName -Location $LOC -Force;

# SRP
$STOName = "STO" + $RGName;
$STOType = "Standard_GRS";
New-AzStorageAccount -ResourceGroupName $RGName -Name $STOName -Location $LOC -Type $STOType;
$STOAccount = Get-AzStorageAccount -ResourceGroupName $RGName -Name $STOName; 

# NRP
$SubNet = New-AzVirtualNetworkSubnetConfig -Name ("subnet" + $RGName) -AddressPrefix "10.0.0.0/24";
$VNet = New-AzVirtualNetwork -Force -Name ("vnet" + $RGName) -ResourceGroupName $RGName -Location $LOC -AddressPrefix "10.0.0.0/16" -DnsServer "10.1.1.1" -Subnet $SubNet;
$VNet = Get-AzVirtualNetwork -Name ('vnet' + $RGName) -ResourceGroupName $RGName;
$SubNetId = $VNet.Subnets[0].Id;

$PubIP = New-AzPublicIpAddress -Force -Name ("PubIP" + $RGName) -ResourceGroupName $RGName -Location $LOC -AllocationMethod Dynamic -DomainNameLabel ("PubIP" + $RGName);
$PubIP = Get-AzPublicIpAddress -Name ("PubIP"  + $RGName) -ResourceGroupName $RGName;

# Create LoadBalancer
$FrontendName = "fe" + $RGName
$BackendAddressPoolName = "bepool" + $RGName
$ProbeName = "vmssprobe" + $RGName
$InboundNatPoolName  = "innatpool" + $RGName
$LBRuleName = "lbrule" + $RGName
$LBName = "vmsslb" + $RGName

$Frontend = New-AzLoadBalancerFrontendIpConfig -Name $FrontendName -PublicIpAddress $PubIP
$BackendAddressPool = New-AzLoadBalancerBackendAddressPoolConfig -Name $BackendAddressPoolName
$Probe = New-AzLoadBalancerProbeConfig -Name $ProbeName -RequestPath healthcheck.aspx -Protocol http -Port 80 -IntervalInSeconds 15 -ProbeCount 2
$InboundNatPool = New-AzLoadBalancerInboundNatPoolConfig -Name $InboundNatPoolName  -FrontendIPConfigurationId `
    $Frontend.Id -Protocol Tcp -FrontendPortRangeStart 3360 -FrontendPortRangeEnd 3362 -BackendPort 3370;
$LBRule = New-AzLoadBalancerRuleConfig -Name $LBRuleName `
    -FrontendIPConfiguration $Frontend -BackendAddressPool $BackendAddressPool `
    -Probe $Probe -Protocol Tcp -FrontendPort 80 -BackendPort 80 `
    -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP;
$ActualLb = New-AzLoadBalancer -Name $LBName -ResourceGroupName $RGName -Location $LOC `
    -FrontendIpConfiguration $Frontend -BackendAddressPool $BackendAddressPool `
    -Probe $Probe -LoadBalancingRule $LBRule -InboundNatPool $InboundNatPool;
$ExpectedLb = Get-AzLoadBalancer -Name $LBName -ResourceGroupName $RGName

# New VMSS Parameters
$VMSSName = "VMSS" + $RGName;

$AdminUsername = "Admin01";
$AdminPassword = "p4ssw0rd@123" + $RGName;

$PublisherName = "MicrosoftWindowsServer" 
$Offer         = "WindowsServer" 
$Sku           = "2012-R2-Datacenter" 
$Version       = "latest"
        
$VHDContainer = "https://" + $STOName + ".blob.core.contoso.net/" + $VMSSName;

$ExtName = "CSETest";
$Publisher = "Microsoft.Compute";
$ExtType = "BGInfo";
$ExtVer = "2.1";

#IP Config for the NIC
$IPCfg = New-AzVmssIPConfig -Name "Test" `
    -LoadBalancerInboundNatPoolsId $ExpectedLb.InboundNatPools[0].Id `
    -LoadBalancerBackendAddressPoolsId $ExpectedLb.BackendAddressPools[0].Id `
    -SubnetId $SubNetId;
            
#VMSS Config
$VMSS = New-AzVmssConfig -Location $LOC -SkuCapacity 2 -SkuName "Standard_E4-2ds_v4" -UpgradePolicyMode "Automatic" `
    | Add-AzVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg `
    | Add-AzVmssNetworkInterfaceConfiguration -Name "Test2"  -IPConfiguration $IPCfg `
    | Set-AzVmssOSProfile -ComputerNamePrefix "Test"  -AdminUsername $AdminUsername -AdminPassword $AdminPassword `
    | Set-AzVmssStorageProfile -Name "Test"  -OsDiskCreateOption 'FromImage' -OsDiskCaching "None" `
    -ImageReferenceOffer $Offer -ImageReferenceSku $Sku -ImageReferenceVersion $Version `
    -ImageReferencePublisher $PublisherName -VhdContainer $VHDContainer `
    | Add-AzVmssExtension -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True

#Create the VMSS
New-AzVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $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 <PASSWORD_HERE> -AsPlainText -Force;
$vmCred = New-Object System.Management.Automation.PSCredential(<USERNAME_HERE>, $vmPassword);

$text = "UserData value to encode";
$bytes = [System.Text.Encoding]::Unicode.GetBytes($text);
$userData = [Convert]::ToBase64String($bytes);

#Create a VMSS
New-AzVmss -ResourceGroupName $ResourceGroupName -Name $vmssName -Credential $vmCred -DomainNameLabel $domainNameLabel -Userdata $userData;
$vmss = Get-AzVmss -ResourceGroupName $ResourceGroupName -VMScaleSetName $vmssName -InstanceView:$false -Userdata;

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.

Parameters

-AllocationMethod

Allocation method for the Public IP Address of the Scale Set (Static or Dynamic). If no value is supplied, allocation will be static.

Type:	String
Accepted values:	Static, Dynamic
Position:	Named
Default value:	Static
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run cmdlet in the background and return a Job to track progress.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-BackendPoolName

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.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-BackendPort

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.

Type:	Int32[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-CapacityReservationGroupId

Id of the capacity reservation Group that is used to allocate.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

The administrator credentials (username and password) for VMs in this Scale Set.

Type:	PSCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DataDiskSizeInGb

Specifies the sizes of data disks in GB.

Type:	Int32[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DomainNameLabel

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 (..cloudapp.azure.com). If no value is supplied, the default domain name label will be the concatenation of and .

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EdgeZone

Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-EnableUltraSSD

Use UltraSSD disks for the VMs in the scale set.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionAtHost

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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EvictionPolicy

The eviction policy for the low priority virtual machine scale set. Only supported values are 'Deallocate' and 'Delete'.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-FrontendPoolName

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.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-HostGroupId

Specifies the dedicated host group the virtual machine scale set will reside in.

Type:	String
Aliases:	HostGroup
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ImageName

The name of the image for VMs in this Scale Set. If no value is provided, the "Windows Server 2016 DataCenter" image will be used.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ImageReferenceId

Specified the shared gallery image unique id for vmss deployment. This can be fetched from shared gallery image GET call.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InstanceCount

The number of VM images in the Scale Set. If no value is provided, 2 instances will be created.

Type:	Int32
Position:	Named
Default value:	2
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerName

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.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

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.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxPrice

The max price of the billing of a low priority virtual machine scale set.

Type:	Double
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NatBackendPort

Backend port for inbound network address translation.

Type:	Int32[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-OrchestrationMode

Specifies the orchestration mode for the virtual machine scale set. Possible values: Uniform, Flexible

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-PlatformFaultDomainCount

Fault Domain count for each placement group.

Type:	Int32
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Priority

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'.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ProximityPlacementGroupId

The resource id of the Proximity Placement Group to use with this scale set.

Type:	String
Aliases:	ProximityPlacementGroup
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicIpAddressName

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.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

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.

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ScaleInPolicy

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.

Type:	String[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SecurityGroupName

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.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SinglePlacementGroup

Use this to create the Scale set in a single placement group, default is multiple groups

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipExtensionsOnOverprovisionedVMs

Specifies that the extensions do not run on the extra overprovisioned VMs.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SubnetAddressPrefix

The address prefix of the Subnet this ScaleSet will use. Default Subnet settings (192.168.1.0/24) will be applied if no value is provided.

Type:	String
Position:	Named
Default value:	192.168.1.0/24
Accept pipeline input:	False
Accept wildcard characters:	False

-SubnetName

The name of the subnet to use with this Scale Set. A new Subnet will be created with the same name as the Scale Set if no value is provided.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SystemAssignedIdentity

If the parameter is present then the VM(s) in the scale set is(are) assigned a managed system identity that is auto generated.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-UpgradePolicyMode

The upgrade policy mode for VM instances in this Scale Set. Upgrade policy could specify Automatic, Manual, or Rolling upgrades.

Type:	UpgradeMode
Accepted values:	Automatic, Manual, Rolling
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAssignedIdentity

The name of a managed service identity that should be assigned to the VM(s) in the scale set.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-UserData

UserData for the Vmss, which will be base-64 encoded. Customer should not pass any secrets in here.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualMachineScaleSet

Specifies the VirtualMachineScaleSet object that contains the properties of the VMSS that this cmdlet creates.

Type:	PSVirtualMachineScaleSet
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualNetworkName

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.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-VMScaleSetName

Specifies the name of the VMSS that this cmdlet creates.

Type:	String
Aliases:	Name
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-VmSize

The size of the VM instances in this scale set. A default size (Standard_DS1_v2) will be used if no Size is specified.

Type:	String
Position:	Named
Default value:	Standard_DS1_v2
Accept pipeline input:	False
Accept wildcard characters:	False

-VnetAddressPrefix

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.

Type:	String
Position:	Named
Default value:	192.168.0.0/16
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Zone

A list of availability zones denoting the IP allocated for the resource needs to come from.

Type:	List<T>[String]
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

PSVirtualMachineScaleSet

List<T>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

PSVirtualMachineScaleSet

Related Links

• Get-AzVmss
• Remove-AzVmss
• Restart-AzVmss
• Set-AzVmss
• Start-AzVmss
• Stop-AzVmss
• Update-AzVmss