New-AzVmssConfig

Syntax

DefaultParameterSet (Default)

New-AzVmssConfig
    [[-Overprovision] <Boolean>]
    [[-Location] <String>]
    [[-Tag] <Hashtable>]
    [[-SkuName] <String>]
    [[-SkuTier] <String>]
    [[-SkuCapacity] <Int32>]
    [[-UpgradePolicyMode] <UpgradeMode>]
    [[-OsProfile] <VirtualMachineScaleSetOSProfile>]
    [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>]
    [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>]
    [[-Extension] <PSVirtualMachineScaleSetExtension[]>]
    [-EdgeZone <String>]
    [-SkipExtensionsOnOverprovisionedVMs]
    [-SinglePlacementGroup <Boolean>]
    [-ZoneBalance]
    [-PlatformFaultDomainCount <Int32>]
    [-Zone <String[]>]
    [-PlanName <String>]
    [-PlanPublisher <String>]
    [-PlanProduct <String>]
    [-PlanPromotionCode <String>]
    [-RollingUpgradePolicy <RollingUpgradePolicy>]
    [-EnableAutomaticRepair]
    [-AutomaticRepairGracePeriod <String>]
    [-EnableAutomaticOSUpgrade]
    [-DisableAutoRollback <Boolean>]
    [-EnableUltraSSD]
    [-HealthProbeId <String>]
    [-BootDiagnostic <BootDiagnostics>]
    [-LicenseType <String>]
    [-Priority <String>]
    [-EnableSpotRestore]
    [-SpotRestoreTimeout <String>]
    [-EvictionPolicy <String>]
    [-MaxPrice <Double>]
    [-TerminateScheduledEvents]
    [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
    [-ProximityPlacementGroupId <String>]
    [-ScaleInPolicy <String[]>]
    [-EncryptionAtHost]
    [-OrchestrationMode <String>]
    [-CapacityReservationGroupId <String>]
    [-UserData <String>]
    [-AutomaticRepairAction <String>]
    [-BaseRegularPriorityCount <Int32>]
    [-RegularPriorityPercentage <Int32>]
    [-ImageReferenceId <String>]
    [-SharedGalleryImageId <String>]
    [-OSImageScheduledEventEnabled]
    [-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>]
    [-SecurityType <String>]
    [-EnableVtpm <Boolean>]
    [-EnableSecureBoot <Boolean>]
    [-SecurityPostureId <String>]
    [-SecurityPostureExcludeExtension <String[]>]
    [-SkuProfileVmSize <String[]>]
    [-SkuProfileAllocationStrategy <String>]
    [-EnableResilientVMCreate]
    [-EnableResilientVMDelete]
    [-EnableAutomaticZoneRebalance]
    [-AutomaticZoneRebalanceStrategy <String>]
    [-AutomaticZoneRebalanceBehavior <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ExplicitIdentityParameterSet

New-AzVmssConfig
    [[-Overprovision] <Boolean>]
    [[-Location] <String>]
    [[-Tag] <Hashtable>]
    [[-SkuName] <String>]
    [[-SkuTier] <String>]
    [[-SkuCapacity] <Int32>]
    [[-UpgradePolicyMode] <UpgradeMode>]
    [[-OsProfile] <VirtualMachineScaleSetOSProfile>]
    [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>]
    [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>]
    [[-Extension] <PSVirtualMachineScaleSetExtension[]>]
    -IdentityType <ResourceIdentityType>
    [-EdgeZone <String>]
    [-SkipExtensionsOnOverprovisionedVMs]
    [-SinglePlacementGroup <Boolean>]
    [-ZoneBalance]
    [-PlatformFaultDomainCount <Int32>]
    [-Zone <String[]>]
    [-PlanName <String>]
    [-PlanPublisher <String>]
    [-PlanProduct <String>]
    [-PlanPromotionCode <String>]
    [-RollingUpgradePolicy <RollingUpgradePolicy>]
    [-EnableAutomaticRepair]
    [-AutomaticRepairGracePeriod <String>]
    [-EnableAutomaticOSUpgrade]
    [-DisableAutoRollback <Boolean>]
    [-EnableUltraSSD]
    [-HealthProbeId <String>]
    [-BootDiagnostic <BootDiagnostics>]
    [-LicenseType <String>]
    [-Priority <String>]
    [-EnableSpotRestore]
    [-SpotRestoreTimeout <String>]
    [-EvictionPolicy <String>]
    [-MaxPrice <Double>]
    [-TerminateScheduledEvents]
    [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
    [-ProximityPlacementGroupId <String>]
    [-ScaleInPolicy <String[]>]
    [-IdentityId <String[]>]
    [-EncryptionIdentity <String>]
    [-EncryptionAtHost]
    [-OrchestrationMode <String>]
    [-CapacityReservationGroupId <String>]
    [-UserData <String>]
    [-AutomaticRepairAction <String>]
    [-BaseRegularPriorityCount <Int32>]
    [-RegularPriorityPercentage <Int32>]
    [-ImageReferenceId <String>]
    [-SharedGalleryImageId <String>]
    [-OSImageScheduledEventEnabled]
    [-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>]
    [-SecurityType <String>]
    [-EnableVtpm <Boolean>]
    [-EnableSecureBoot <Boolean>]
    [-SecurityPostureId <String>]
    [-SecurityPostureExcludeExtension <String[]>]
    [-SkuProfileVmSize <String[]>]
    [-SkuProfileAllocationStrategy <String>]
    [-EnableResilientVMCreate]
    [-EnableResilientVMDelete]
    [-EnableAutomaticZoneRebalance]
    [-AutomaticZoneRebalanceStrategy <String>]
    [-AutomaticZoneRebalanceBehavior <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Examples

Example 1: Create a VMSS configuration object

$VMSS = New-AzVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -NetworkInterfaceConfiguration $NetCfg `
            | Add-AzVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg `
            | Set-AzVmssOsProfile -ComputerNamePrefix "Test" -AdminUsername $adminUsername -AdminPassword $AdminPassword `
            | Set-AzVmssStorageProfile -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" `
            -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version `
            -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VHDContainer `
            | Add-AzVmssAdditionalUnattendContent -ComponentName  $AUCComponentName -Content  $AUCContent -PassName  $AUCPassName -SettingName  $AUCSetting;

New-AzVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS;

Example 2

New-AzVmssConfig -Location <String> -Overprovision $false -SkuCapacity 2 -SkuName 'Standard_A0' -SecurityType "Standard" -Tag @{key0="value0";key1=$null;key2="value2"} -UpgradePolicyMode Automatic;

Example 3

New-AzVmssConfig -Location <String> -SkuCapacity 2 -SkuName 'Standard_A0' -UpgradePolicyMode Automatic -IdentityType SystemAssigned -SecurityType "Standard";

Example 4: Create a VMSS with the OS Image Scheduled Events enabled

$publisher = "MicrosoftWindowsServer";
$offer = "WindowsServer";
$imgSku = "2019-Datacenter";
$version = "latest";
$vmssName = 'vmss' + $rgname;
$vmssSku = "Standard_D2s_v3";
$vmssname = "vmss" + $rgname;
$domainNameLabel = "d" + $rgname;
$securityTypeStnd = "Standard";
$username = <Username>;
$securePassword = ConvertTo-SecureString -String "****" -AsPlainText -Force;

$credential = New-Object System.Management.Automation.PSCredential ($username, $securePassword);

# 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" -Subnet $subnet;
$vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname;
$subnetId = $vnet.Subnets[0].Id;

# Create VMSS with managed disk
$timeoutValue = 'PT15M';
$ipCfg = New-AzVmssIpConfig -Name 'test' -SubnetId $subnetId;
$vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSku -OSImageScheduledEventEnabled -OSImageScheduledEventNotBeforeTimeoutInMinutes $timeoutValue -UpgradePolicyMode "Automatic" -SecurityType $securityTypeStnd `
    | Add-AzVmssNetworkInterfaceConfiguration -Name 'test' -Primary $true -IPConfiguration $ipCfg `
    | Set-AzVmssOsProfile -ComputerNamePrefix 'test' -AdminUsername $username -AdminPassword $password `
    | Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'None' `
       -ImageReferenceOffer $offer -ImageReferenceSku $imgSku -ImageReferenceVersion $version `
       -ImageReferencePublisher $publisher;

$result = New-AzVmss -ResourceGroupName $rgname -Name $vmssName -VirtualMachineScaleSet $vmss;

$vmss = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName;
# $vmss.VirtualMachineProfile.ScheduledEventsProfile.OsImageNotificationProfile.Enable is the OSImageScheduledEventEnabled flag.
# $vmss.VirtualMachineProfile.ScheduledEventsProfile.OsImageNotificationProfile.NotBeforeTimeout is the timeout value 'PT15M'.

Example 5: Create a Vmss with the security type TrustedLaunch

$rgname = "rganme";
 $loc = "eastus";
 New-AzResourceGroup -Name $rgname -Location $loc -Force;
# VMSS Profile & Hardware requirements for the TrustedLaunch default behavior.
$vmssSize = 'Standard_D4s_v3';
$PublisherName = "MicrosoftWindowsServer";
$Offer = "WindowsServer";
$SKU = "2016-datacenter-gensecond";
$securityType = "TrustedLaunch";
$enable = $true;
$disable = $false;
$extDefaultName = "GuestAttestation";
$vmGADefaultIdentity = "SystemAssigned";

# 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" -Subnet $subnet;
$vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname;
$subnetId = $vnet.Subnets[0].Id;

# New VMSS Parameters
$vmssName1 = 'vmss1' + $rgname;
$vmssName2 = 'vmss2' + $rgname;
$vmssType = 'Microsoft.Compute/virtualMachineScaleSets';
$adminUsername = <Username>;
$adminPassword = ConvertTo-SecureString -String "****" -AsPlainText -Force;
$imgRef = New-Object -TypeName 'Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImage';
$imgRef.PublisherName = $PublisherName;
$imgRef.Offer = $Offer;
$imgRef.Skus = $SKU;
$imgRef.Version = "latest";
$ipCfg = New-AzVmssIpConfig -Name 'test' -SubnetId $subnetId;

$vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSize -UpgradePolicyMode 'Manual' `
    | Add-AzVmssNetworkInterfaceConfiguration -Name 'test' -Primary $true -IPConfiguration $ipCfg `
    | Set-AzVmssOsProfile -ComputerNamePrefix 'test' -AdminUsername $adminUsername -AdminPassword $adminPassword `
    | Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'ReadOnly' `
    -ImageReferenceOffer $imgRef.Offer -ImageReferenceSku $imgRef.Skus -ImageReferenceVersion $imgRef.Version `
    -ImageReferencePublisher $imgRef.PublisherName;

# VMSS Creation using VMSSConfig for Trusted Launch SecurityType
$vmss1 = Set-AzVmssSecurityProfile -VirtualMachineScaleSet $vmss -SecurityType $securityType;
$result = New-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName1 -VirtualMachineScaleSet $vmss1;
$vmssGet = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName1;

# Validate that for -SecurityType "TrustedLaunch" "-Vtpm" and -"SecureBoot" are "Enabled/true"
#$vmssGet.VirtualMachineProfile.SecurityProfile.UefiSettings.VTpmEnabled $true;
#$vmssGet.VirtualMachineProfile.SecurityProfile.UefiSettings.SecureBootEnabled $true;

Parameters

-AutomaticRepairAction

Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

Parameter properties

Parameter sets

-AutomaticRepairGracePeriod

The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).

Parameter properties

Parameter sets

-AutomaticZoneRebalanceBehavior

Specifies the behavior for Automatic Zone Rebalance.

Parameter properties

Parameter sets

-AutomaticZoneRebalanceStrategy

Specifies the strategy for Automatic Zone Rebalance.

Parameter properties

Parameter sets

-BaseRegularPriorityCount

Specifies the minimum number of VMs that must be of Regular priority as a VMSS Flex instance scales out. This parameter is only valid for VMSS instances with Flexible OrchestrationMode.

Parameter properties

Parameter sets

-BootDiagnostic

Specifies the virtual machine scale set boot diagnostics profile.

Parameter properties

Parameter sets

-CapacityReservationGroupId

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

Parameter properties

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-DefaultProfile

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

Parameter properties

Parameter sets

-DisableAutoRollback

Disable Auto Rollback for Auto OS Upgrade Policy

Parameter properties

Parameter sets

-EdgeZone

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

Parameter properties

Parameter sets

-EnableAutomaticOSUpgrade

Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.

Parameter properties

Parameter sets

-EnableAutomaticRepair

Enables automatic repairs on the virtual machine scale set.

Parameter properties

Parameter sets

-EnableAutomaticZoneRebalance

Specifies whether Automatic Zone Rebalance should be enabled on the virtual machine scale set. The default value is false.

Parameter properties

Parameter sets

-EnableResilientVMCreate

Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false.

Parameter properties

Parameter sets

-EnableResilientVMDelete

Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false.

Parameter properties

Parameter sets

-EnableSecureBoot

Specifies whether secure boot should be enabled on the virtual machine.

Parameter properties

Parameter sets

-EnableSpotRestore

Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints

Parameter properties

Parameter sets

-EnableUltraSSD

Enables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the virtual machine scale set. Managed disks with storage account type UltraSSD_LRS can be added to a VMSS only if this property is enabled.

Parameter properties

Parameter sets

-EnableVtpm

Specifies whether vTPM should be enabled on the virtual machine.

Parameter properties

Parameter sets

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

Parameter properties

Parameter sets

-EncryptionIdentity

Specifies the user identity associated with the virtual machine.That identity will be used for Azure Disk Encryption.

Parameter properties

Parameter sets

-EvictionPolicy

Specifies the eviction policy for the virtual machines in the scale set.

Parameter properties

Parameter sets

-Extension

Specifies the extension information object for the VMSS. You can use the Add-AzVmssExtension cmdlet to add this object.

Parameter properties

Parameter sets

-HealthProbeId

Specifies the ID of a load balancer probe used to determine the health of an instance in the virtual machine scale set. HealthProbeId is in the form of '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.

Parameter properties

Parameter sets

-IdentityId

Specifies the list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'

Parameter properties

Parameter sets

-IdentityType

Specifies the type of identity used for the virtual machine scale set. The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. The acceptable values for this parameter are:

• SystemAssigned
• UserAssigned
• SystemAssignedUserAssigned
• None

Parameter properties

Parameter sets

-ImageReferenceId

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

Parameter properties

Parameter sets

-LicenseType

Specify the license type, which is for bringing your own license scenario.

Parameter properties

Parameter sets

-Location

Specifies the Azure location where the VMSS is created.

Parameter properties

Parameter sets

-MaxPrice

Specifies the maximum price you are willing to pay for a Spot VM/VMSS. This price is in US Dollars. This price will be compared with the current Spot price for the VM size. Also, the prices are compared at the time of create/update of Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Spot price. The maxPrice will also be used for evicting a Spot VM/VMSS if the current Spot price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: any decimal value greater than zero. Example: 0.01538. -1 indicates that the Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Parameter properties

Parameter sets

-NetworkInterfaceConfiguration

Specifies the network profile object that contains the networking properties for the VMSS configuration. You can use the Add-AzVmssNetworkInterfaceConfiguration cmdlet to add this object.

Parameter properties

Parameter sets

-OrchestrationMode

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

Parameter properties

Parameter sets

-OSImageScheduledEventEnabled

Specifies whether the OS Image Scheduled event is enabled or disabled.

Parameter properties

Parameter sets

-OSImageScheduledEventNotBeforeTimeoutInMinutes

The 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, with the value set to 15 minutes (PT15M).

Parameter properties

Parameter sets

-OsProfile

Specifies the operating system profile object that contains the operating system properties for the VMSS configuration. You can use the Set-AzVmssOsProfile cmdlet to set this object.

Parameter properties

Parameter sets

-Overprovision

Indicates whether the cmdlet overprovisions the VMSS.

Parameter properties

Parameter sets

-PlanName

Specifies the plan name.

Parameter properties

Parameter sets

-PlanProduct

Specifies the plan product.

Parameter properties

Parameter sets

-PlanPromotionCode

Specifies the plan promotion code.

Parameter properties

Parameter sets

-PlanPublisher

Specifies the plan publisher.

Parameter properties

Parameter sets

-PlatformFaultDomainCount

Fault Domain count for each placement group.

Parameter properties

Parameter sets

-Priority

The priority for the virtual machien 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'.

Parameter properties

Parameter sets

-ProximityPlacementGroupId

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

Parameter properties

Parameter sets

-RegularPriorityPercentage

Specifies the desired percentage of VMs, after the BaseRegularCount has been met, that are of Regular priority as the VMSS Flex instance scales out. This property is only valid for VMSS instances with Flexible OrchestrationMode.

Parameter properties

Parameter sets

-RollingUpgradePolicy

Specifies the rolling upgrade policy.

Parameter properties

Parameter sets

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

Parameter properties

Parameter sets

-SecurityPostureExcludeExtension

List of virtual machine extensions to exclude when applying the security posture.

Parameter properties

Parameter sets

-SecurityPostureId

The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest

Parameter properties

Parameter sets

-SecurityType

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.

Parameter properties

Parameter sets

-SharedGalleryImageId

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

Parameter properties

Parameter sets

-SinglePlacementGroup

Specifies the single placement group.

Parameter properties

Parameter sets

-SkipExtensionsOnOverprovisionedVMs

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

Parameter properties

Parameter sets

-SkuCapacity

Specifies the number of instances in the VMSS.

Parameter properties

Parameter sets

-SkuName

Specifies the size of all the instances of VMSS. Get-AzComputeResourceSku can be used to find out available sizes for your subscription and region.

Parameter properties

Parameter sets

-SkuProfileAllocationStrategy

Allocation strategy for the SKU profile.

Parameter properties

Parameter sets

-SkuProfileVmSize

Array of VM sizes for the scale set.

Parameter properties

Parameter sets

-SkuTier

Specifies the tier of VMSS. The acceptable values for this parameter are:

• Standard
• Basic

Parameter properties

Parameter sets

-SpotRestoreTimeout

Specifies timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

Parameter properties

Parameter sets

-StorageProfile

Specifies the storage profile object that contains the disk properties for the VMSS configuration. You can use the Set-AzVmssStorageProfile cmdlet to set this object.

Parameter properties

Parameter sets

-Tag

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Parameter properties

Parameter sets

-TerminateScheduledEventNotBeforeTimeoutInMinutes

Configurable length of time (in minutes) a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out).

Parameter properties

Parameter sets

-TerminateScheduledEvents

Enable the Terminate Scheduled events

Parameter properties

Parameter sets

-UpgradePolicyMode

Specified the mode of an upgrade to virtual machines in the scale set. The acceptable values for this parameter are:

• Automatic
• Manual

Parameter properties

Parameter sets

-UserData

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

Parameter properties

Parameter sets

-WhatIf

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

Parameter properties

Parameter sets

-Zone

Specifies the zone list for the virtual machine scale set.

Parameter properties

Parameter sets

-ZoneBalance

Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

Parameter properties

Parameter sets

CommonParameters

Inputs

Nullable<T>

String

Hashtable

Int32

Nullable<T>

VirtualMachineScaleSetOSProfile

VirtualMachineScaleSetStorageProfile

VirtualMachineScaleSetNetworkConfiguration

VirtualMachineScaleSetExtension

String

RollingUpgradePolicy

SwitchParameter

BootDiagnostics

Nullable<T>

Outputs

PSVirtualMachineScaleSet

Related Links

• Set-AzVmssOsProfile
• Set-AzVmssStorageProfile
• Add-AzVmssNetworkInterfaceConfiguration
• Add-AzVmssExtension
• New-AzVmss