Update-AzWvdSessionHost

Module:

Az.DesktopVirtualization

Update a session host.

Syntax

Update-AzWvdSessionHost
      -HostPoolName <String>
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Force]
      [-AllowNewSession]
      [-AssignedUser <String>]
      [-FriendlyName <String>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Update-AzWvdSessionHost
      -InputObject <IDesktopVirtualizationIdentity>
      [-Force]
      [-AllowNewSession]
      [-AssignedUser <String>]
      [-FriendlyName <String>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Update a session host.

Examples

Example 1: Update a Windows Virtual Desktop SessionHost by name

Update-AzWvdSessionHost -ResourceGroupName ResourceGroupName `
                            -HostPoolName HostPoolName `
                            -Name SessionHostName `
                            -AllowNewSession:$false

Name                                               Type
----                                               ----
HostPoolName/SessionHostName Microsoft.DesktopVirtualization/hostpools/sessionhosts

This command updates a Windows Virtual Desktop SessionHost in a Host Pool.

Parameters

-AllowNewSession

Allow a new session.

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

-AssignedUser

User assigned to SessionHost.

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:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Force flag to update assign, unassign or reassign personal desktop.

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

-FriendlyName

Friendly name of SessionHost

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

-HostPoolName

The name of the host pool within the specified resource group

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the session host within the specified host pool

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

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IDesktopVirtualizationIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.ISessionHost

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IDesktopVirtualizationIdentity>: Identity Parameter

• [ApplicationGroupName <String>]: The name of the application group
• [ApplicationName <String>]: The name of the application within the specified application group
• [DesktopName <String>]: The name of the desktop within the specified desktop group
• [HostPoolName <String>]: The name of the host pool within the specified resource group
• [Id <String>]: Resource identity path
• [MsixPackageFullName <String>]: The version specific package full name of the MSIX package within specified hostpool
• [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
• [ScalingPlanName <String>]: The name of the scaling plan.
• [ScalingPlanScheduleName <String>]: The name of the ScalingPlanSchedule
• [SessionHostName <String>]: The name of the session host within the specified host pool
• [SubscriptionId <String>]: The ID of the target subscription.
• [UserSessionId <String>]: The name of the user session within the specified session host
• [WorkspaceName <String>]: The name of the workspace