Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-AzWvdHostPool
- Module:
- Az.DesktopVirtualization Module
Create a host pool.
Syntax
CreateExpanded (Default)
New-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
-HostPoolType <String>
-LoadBalancerType <String>
-Location <String>
-PreferredAppGroupType <String>
[-SubscriptionId <String>]
[-AgentUpdateMaintenanceWindow <IMaintenanceWindowProperties[]>]
[-AgentUpdateMaintenanceWindowTimeZone <String>]
[-AgentUpdateType <String>]
[-AgentUpdateUseSessionHostLocalTime]
[-CustomRdpProperty <String>]
[-Description <String>]
[-ExpirationTime <DateTime>]
[-FriendlyName <String>]
[-IdentityType <String>]
[-Kind <String>]
[-ManagedBy <String>]
[-MaxSessionLimit <Int32>]
[-PersonalDesktopAssignmentType <String>]
[-PlanName <String>]
[-PlanProduct <String>]
[-PlanPromotionCode <String>]
[-PlanPublisher <String>]
[-PlanVersion <String>]
[-PublicNetworkAccess <String>]
[-RegistrationInfoToken <String>]
[-RegistrationTokenOperation <String>]
[-Ring <Int32>]
[-SkuCapacity <Int32>]
[-SkuFamily <String>]
[-SkuName <String>]
[-SkuSize <String>]
[-SkuTier <String>]
[-SsoClientId <String>]
[-SsoClientSecretKeyVaultPath <String>]
[-SsoSecretType <String>]
[-SsoadfsAuthority <String>]
[-StartVMOnConnect]
[-Tag <Hashtable>]
[-VMTemplate <String>]
[-ValidationEnvironment]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FullScenarioCreate
New-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
-HostPoolType <String>
-LoadBalancerType <String>
-Location <String>
-PreferredAppGroupType <String>
[-SubscriptionId <String>]
[-DesktopAppGroupName <String>]
[-WorkspaceName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzWvdHostPool
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a host pool.
Examples
Example 1: Create a Windows Virtual Desktop HostPool by name
New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
-Name HostPoolName `
-Location 'eastus' `
-HostPoolType 'Pooled' `
-LoadBalancerType 'DepthFirst' `
-RegistrationTokenOperation 'Update' `
-ExpirationTime $((Get-Date).ToUniversalTime().AddDays(1).ToString('yyyy-MM-ddTHH:mm:ss.fffffffZ')) `
-Description 'Description' `
-FriendlyName 'Friendly Name' `
-MaxSessionLimit 5 `
-VMTemplate $null `
-SsoClientId $null `
-SsoClientSecretKeyVaultPath $null `
-SsoSecretType $null `
-SsoadfsAuthority $null `
-CustomRdpProperty $null `
-Ring $null `
-ValidationEnvironment:$false
Location Name Type
-------- ---- ----
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools
This command creates a Windows Virtual Desktop HostPool in a Resource Group.
Example 2: Create a Windows Virtual Desktop HostPool by name
New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
-Name HostPoolName `
-Location 'eastus' `
-HostPoolType 'Personal' `
-LoadBalancerType 'Persistent' `
-RegistrationTokenOperation 'Update' `
-ExpirationTime $((Get-Date).ToUniversalTime().AddDays(1).ToString('yyyy-MM-ddTHH:mm:ss.fffffffZ')) `
-Description 'Description' `
-FriendlyName 'Friendly Name' `
-MaxSessionLimit 5 `
-VMTemplate $null `
-SsoClientId $null `
-SsoClientSecretKeyVaultPath $null `
-SsoSecretType $null `
-SsoadfsAuthority $null `
-CustomRdpProperty $null `
-Ring $null `
-ValidationEnvironment:$false
Location Name Type
-------- ---- ----
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools
This command creates a Windows Virtual Desktop HostPool in a Resource Group.
Parameters
-AgentUpdateMaintenanceWindow
List of maintenance windows. Maintenance windows are 2 hours long.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AgentUpdateMaintenanceWindowTimeZone
Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AgentUpdateType
The type of maintenance for session host components.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AgentUpdateUseSessionHostLocalTime
Whether to use localTime of the virtual machine.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-CustomRdpProperty
Custom rdp property of HostPool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
-Description
Description of HostPool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DesktopAppGroupName
Desktop App Group Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ExpirationTime
Expiration time of registration token.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-FriendlyName
Friendly name of HostPool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HostPoolType
HostPool type for desktop.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IdentityType
Type of managed service identity (either system assigned, or none).
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-JsonFilePath
Path of Json file supplied to the Create operation
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-JsonString
Json string supplied to the Create operation
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Kind
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerType
The type of the load balancer.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Location
The geo-location where the resource lives
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ManagedBy
The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MaxSessionLimit
The max session limit of HostPool.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The name of the host pool within the specified resource group
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | HostPoolName |
Parameter sets
-PersonalDesktopAssignmentType
PersonalDesktopAssignment type for HostPool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PlanName
A user defined name of the 3rd Party Artifact that is being procured.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PlanProduct
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PlanPromotionCode
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PlanPublisher
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PlanVersion
The version of the desired product/artifact.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PreferredAppGroupType
The type of preferred application group type, default to Desktop Application Group
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicNetworkAccess
Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RegistrationInfoToken
The registration token base64 encoded string.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RegistrationTokenOperation
The type of resetting the token.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Ring
The ring number of HostPool.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuCapacity
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuFamily
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuName
The name of the SKU. E.g. P3. It is typically a letter+number code
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuSize
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SsoadfsAuthority
URL to customer ADFS server for signing WVD SSO certificates.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SsoClientId
ClientId for the registered Relying Party used to issue WVD SSO certificates.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SsoClientSecretKeyVaultPath
Path to Azure KeyVault storing the secret used for communication to ADFS.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SsoSecretType
The type of single sign on Secret Type.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StartVMOnConnect
The flag to turn on/off StartVMOnConnect feature.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
Parameter properties
| Type: | String |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tag
Resource tags.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ValidationEnvironment
Is validation environment.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VMTemplate
VM template for sessionhosts configuration within hostpool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
-WorkspaceName
Workspace Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
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.
Outputs
IHostPool
Azure PowerShell
Feedback
Was this page helpful?