Edit

Remove-AzWvdUserSession

  • Reference
Module:
Az.DesktopVirtualization

Remove a userSession.

Syntax

Remove-AzWvdUserSession
      -HostPoolName <String>
      -Id <String>
      -ResourceGroupName <String>
      -SessionHostName <String>
      [-SubscriptionId <String>]
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Remove-AzWvdUserSession
      -InputObject <IDesktopVirtualizationIdentity>
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Remove a userSession.

Examples

Example 1: Delete a Windows Virtual Desktop UserSession by name

Remove-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2

This command deletes a Windows Virtual Desktop UserSession in a Session Host.

Parameters

-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

-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

-Force

Specify to force userSession deletion.

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

-Id

The name of the user session within the specified session host

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

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
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

-SessionHostName

The name of the session host within the specified host pool

Type:String
Position:Named
Default value:None
Required:True
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
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

Boolean

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