New-RASAVDHostPool.md
NAME
New-RASAVDHostPool
SYNOPSIS
The cmdlet creates an object of type Azure Virtual Desktop Host Pool.
SYNTAX
New-RASAVDHostPool [[-SiteId] (uint)] -AzureId (string) -HostName (string) -WorkspaceId (uint) [AutoScaleEnabled (bool)] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [DrainRemainsBelowSec (uint)] [Duration (uint)] [Enabled (bool)] [HostsToCreate (uint)] [MaxHosts (uint)] [MaxServersFromTemplate (uint)] [MinServersFromTemplate (uint)] [OverwriteSize (bool)] [PreCreatedHosts (uint)] [RemoveServersAfterDrainAndPowerOff (bool)] [ServersToAddPerRequest (uint)] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [ValidationEnvironment (bool)] [VMSize (string)] [WorkLoadDrain (uint)] [WorkloadThreshold (uint)] [(CommonParameters)]
New-RASAVDHostPool [Name] (string) [[-SiteId] (uint)] -LoadBalancerType {BreadthFirst | DepthFirst | Persistent} -Location (string) -PoolType {Pooled | Personal} -ProvisioningType {Template | Standalone} -PublishingType {RemoteApp | Desktop} -ResourceGroup (string) -WorkspaceId (uint) [AutoScaleEnabled (bool)] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [DrainRemainsBelowSec (uint)] [Duration (uint)] [Enabled (bool)] [FriendlyName (string)] [HostName (string)] [HostsToCreate (uint)] [LimitHosts (uint)] [MaxHosts (uint)] [MaxServersFromTemplate (uint)] [MinServersFromTemplate (uint)] [OverwriteSize (bool)] [PowerOnHost (bool)] [PreCreatedHosts (uint)] [RemoveServersAfterDrainAndPowerOff (bool)] [ServersToAddPerRequest (uint)] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [ValidationEnvironment (bool)] [VMSize (string)] [WorkLoadDrain (uint)] [WorkloadThreshold (uint)] [(CommonParameters)]
DESCRIPTION
Creates a new Azure Virtual Desktop Host Pool or imports an existing Azure Virtual Desktop Host Pool
PARAMETERS
Name (string)
The name of the AVD Host Pool.
SiteId (uint)
Site ID in which to modify the specified AVD Host Pool.
If the parameter is omitted, the site ID of the Licensing Server will be used.
WorkspaceId (uint)
The Workspace ID.
Description (string)
Description of the AVD Host Pool.
Enabled (bool)
Enable or disable the AVD Host Pool upon creation.
If the parameter is omitted, the AVD Host Pool is initialised as Disabled.
FriendlyName (string)
Friendly name of the AVD Host Pool.
ResourceGroup (string)
Resource Group of the AVD Host Pool.
Location (string)
Location of the AVD Host Pool.
AzureId (string)
The Azure ID of the AVD Host Pool.
PoolType (PoolType)
The Pool Type of the AVD Host Pool.
Possible values: Pooled, Personal
LimitHosts (uint)
The Limit of session on host. Default: Pooled: 50, Personal: 1 (always).
Available to Pooled Host Pools
PublishingType (PublishingType)
The Publishing Type of the AVD Host Pool.
Possible values: RemoteApp, Desktop
LoadBalancerType
(LoadBalancerType) The Load Balancer Type of the AVD Host Pool.
Possible values: BreadthFirst, DepthFirst, Persistent
PowerOnHost (bool)
Whether Power On Host is Enabled or not.
ValidationEnvironment (bool)
Whether Validation Environment is Enabled or not.
ProvisioningType
(ProvisioningType) The Provisioning Type of the Host Pool
Possible values: Template, Standalone
TemplateId (uint)
The Template ID.
Available to Templated Host Pools
TemplateVersionId (uint)
The Template Version ID.
Available to Templated Host Pools
TemplateTagId (uint)
The Template Tag ID.
Available to Templated Host Pools
MaxHosts (uint)
The maximum number of hosts that can be created from the template.
Available to Templated Personal Host Pools
PreCreatedHosts (uint)
The maximum number of pre-created hosts. (Keep available buffer)
Available to Templated Personal Host Pools
Duration (uint)
The duration (in seconds) before the unused hosts are deleted
Available to Templated Personal Host Pools
HostsToCreate (uint)
The number of hosts that will be created after template creation process has finished. These desktops are created only once.
AutoScaleEnabled (bool)
Whether AutoScale is Enabled or not
Available to Templated Pooled Host Pools
MinServersFromTemplate (uint)
The Minimum Number of Hosts added from the template.
Default: 1
MaxServersFromTemplate (uint)
The Maximum Number of Hosts added from the template.
Default: 2
WorkloadThreshold (uint)
The Workload Threshold.
Default: 75
ServersToAddPerRequest (uint)
The amount of servers to add per request.
Default: 1
WorkLoadDrain (uint)
The Drain Workload.
Default: 20
DrainRemainsBelowSec (uint)
The Remaining Drain level.
Default: 1 (Immediate)
RemoveServersAfterDrainAndPowerOff (bool)
Remove hosts from host pool after drain and power off.
HostName (string)
The host name format. All VMs created from the template will have this name with %ID:N:S% replaced.
DefaultPowerState
(DefaultPowerState) The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
OverwriteSize (bool)
Whether Overwrite Size is Enabled or not.
Available to Templated Host Pools
VMSize (string)
VMSize which will override the size specified in template properties.
Example: Standard_B2s
(CommonParameters)
INPUTS
-none-
OUTPUTS
EXAMPLES
**---------- EXAMPLE 1 ----------
New-RASAVDHostPool -Name "NGTstHostPool" -WorkspaceId 5 -ResourceGroup "NGResource" -Location "westeurope" -PoolType Pooled -PublishingType "Desktop" -ProvisioningType Template -LoadBalancer "DepthFirst"
Creates a new Pooled Templated AVD Host Pool. **---------- EXAMPLE 2 ----------
New-RASAVDHostPool -Name "NGTstHostPool" -WorkspaceId 5 -ResourceGroup "NGResource" -Location "westeurope" -PoolType Personal -PublishingType "Desktop" -ProvisioningType Template -LoadBalancer "Persistent"
Creates a new Personal Templated AVD Host Pool. **---------- EXAMPLE 3 ----------
New-RASAVDHostPool -WorkspaceId 1 -AzureId "subscriptions/b0375739-05f3-859f-ac89-20ef4dcd92cb/resourceGroups/My_Resource_Group/providers/Microsoft.DesktopVirtualization/hostpools/my-hostpool"
Imports an existing AVD Host Pool.
RELATED LINKS
Last updated