Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-AzWvdSessionHost
- Module:
- Az.DesktopVirtualization Module
Update a session host.
Syntax
UpdateExpanded (Default)
Update-AzWvdSessionHost
-HostPoolName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Force]
[-AllowNewSession]
[-AssignedUser <String>]
[-FriendlyName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonString
Update-AzWvdSessionHost
-HostPoolName <String>
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-Force]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonFilePath
Update-AzWvdSessionHost
-HostPoolName <String>
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-Force]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityHostPoolExpanded
Update-AzWvdSessionHost
-Name <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
[-Force]
[-AllowNewSession]
[-AssignedUser <String>]
[-FriendlyName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityHostPool
Update-AzWvdSessionHost
-Name <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
-SessionHost <ISessionHostPatch>
[-Force]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzWvdSessionHost
-InputObject <IDesktopVirtualizationIdentity>
[-Force]
[-AllowNewSession]
[-AssignedUser <String>]
[-FriendlyName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AssignedUser
User assigned to SessionHost.
Parameter properties
| Type: | String |
| 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
-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
-Force
Force flag to update assign, unassign or reassign personal desktop.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-FriendlyName
Friendly name of SessionHost
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HostPoolInputObject
Identity Parameter
Parameter properties
| Type: | IDesktopVirtualizationIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HostPoolName
The name of the host pool within the specified resource group
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter
Parameter properties
| Type: | IDesktopVirtualizationIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-JsonFilePath
Path of Json file supplied to the Update operation
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-JsonString
Json string supplied to the Update operation
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The name of the session host within the specified host pool
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SessionHostName |
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
-SessionHost
SessionHost properties that can be patched.
Parameter properties
| Type: | ISessionHostPatch |
| 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
-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
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.
Inputs
IDesktopVirtualizationIdentity
ISessionHostPatch
Outputs
ISessionHost
Azure PowerShell
Feedback
Was this page helpful?