Update-AzWvdHostPool

Reference

Module:: Az.DesktopVirtualization

update a host pool.

Syntax

Update-AzWvdHostPool
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
      [-AgentUpdateMaintenanceWindowTimeZone <String>]
      [-AgentUpdateType <String>]
      [-AgentUpdateUseSessionHostLocalTime]
      [-CustomRdpProperty <String>]
      [-Description <String>]
      [-FriendlyName <String>]
      [-LoadBalancerType <String>]
      [-MaxSessionLimit <Int32>]
      [-PersonalDesktopAssignmentType <String>]
      [-PreferredAppGroupType <String>]
      [-PublicNetworkAccess <String>]
      [-RegistrationInfoExpirationTime <DateTime>]
      [-RegistrationInfoRegistrationTokenOperation <String>]
      [-Ring <Int32>]
      [-SsoClientId <String>]
      [-SsoClientSecretKeyVaultPath <String>]
      [-SsoSecretType <String>]
      [-SsoadfsAuthority <String>]
      [-StartVMOnConnect]
      [-Tag <Hashtable>]
      [-VMTemplate <String>]
      [-ValidationEnvironment]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWvdHostPool
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWvdHostPool
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWvdHostPool
      -InputObject <IDesktopVirtualizationIdentity>
      [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
      [-AgentUpdateMaintenanceWindowTimeZone <String>]
      [-AgentUpdateType <String>]
      [-AgentUpdateUseSessionHostLocalTime]
      [-CustomRdpProperty <String>]
      [-Description <String>]
      [-FriendlyName <String>]
      [-LoadBalancerType <String>]
      [-MaxSessionLimit <Int32>]
      [-PersonalDesktopAssignmentType <String>]
      [-PreferredAppGroupType <String>]
      [-PublicNetworkAccess <String>]
      [-RegistrationInfoExpirationTime <DateTime>]
      [-RegistrationInfoRegistrationTokenOperation <String>]
      [-Ring <Int32>]
      [-SsoClientId <String>]
      [-SsoClientSecretKeyVaultPath <String>]
      [-SsoSecretType <String>]
      [-SsoadfsAuthority <String>]
      [-StartVMOnConnect]
      [-Tag <Hashtable>]
      [-VMTemplate <String>]
      [-ValidationEnvironment]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

update a host pool.

Examples

Example 1: Update a Windows Virtual Desktop HostPool by name

Update-AzWvdHostPool -ResourceGroupName ResourceGroupName `
                            -Name HostPoolName `
                            -LoadBalancerType 'BreadthFirst' `
                            -Description 'Description' `
                            -FriendlyName 'Friendly Name' `
                            -MaxSessionLimit 6 `
                            -CustomRdpProperty $null `
                            -Ring $null `
                            -ValidationEnvironment:$false

Location   Name                 Type
--------   ----                 ----
eastus     HostPoolName Microsoft.DesktopVirtualization/hostpools

This command updates a Windows Virtual Desktop HostPool in a Resource Group.

Parameters

-AgentUpdateMaintenanceWindow

List of maintenance windows. Maintenance windows are 2 hours long.

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

-AgentUpdateMaintenanceWindowTimeZone

Time zone for maintenance as defined in https://learn.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true.

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

-AgentUpdateType

The type of maintenance for session host components.

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

-AgentUpdateUseSessionHostLocalTime

Whether to use localTime of the virtual machine.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomRdpProperty

Custom rdp property of HostPool.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Description of HostPool.

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

-FriendlyName

Friendly name of HostPool.

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

-InputObject

Identity Parameter

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

-JsonFilePath

Path of Json file supplied to the Update operation

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

-JsonString

Json string supplied to the Update operation

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

-LoadBalancerType

The type of the load balancer.

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

-MaxSessionLimit

The max session limit of HostPool.

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

-Name

The name of the host pool within the specified resource group

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

-PersonalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

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

-PreferredAppGroupType

The type of preferred application group type, default to Desktop Application Group

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

-PublicNetworkAccess

Enabled to allow this resource to be access from the public network

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

-RegistrationInfoExpirationTime

Expiration time of registration token.

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

-RegistrationInfoRegistrationTokenOperation

The type of resetting the token.

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-Ring

The ring number of HostPool.

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

-SsoadfsAuthority

URL to customer ADFS server for signing WVD SSO certificates.

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

-SsoClientId

ClientId for the registered Relying Party used to issue WVD SSO certificates.

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

-SsoClientSecretKeyVaultPath

Path to Azure KeyVault storing the secret used for communication to ADFS.

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

-SsoSecretType

The type of single sign on Secret Type.

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

-StartVMOnConnect

The flag to turn on/off StartVMOnConnect feature.

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

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

tags to be updated

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

-ValidationEnvironment

Is validation environment.

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

-VMTemplate

VM template for sessionhosts configuration within hostpool.

Type:	String
Position:	Named
Default value:	None
Required:	False
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IDesktopVirtualizationIdentity

Outputs

IHostPool

Share via