Invoke-RdsUserSessionLogoff

Referens

Modul:: WindowsVirtualDesktopPowershell

Loggar ut en användare från den aktuella aktiva sessionen.

Syntax

Invoke-RdsUserSessionLogoff
      [-TenantName] <String>
      [-HostPoolName] <String>
      [-SessionHostName] <String>
      [-SessionId] <Int32>
      [-NoUserPrompt]
      [-Force]
      [<CommonParameters>]

Description

Invoke-RdsUserSessionLogoff loggar ut en användare från den aktuella aktiva sessionen som körs på den angivna sessionsvärden. Eftersom användaren är utloggad avslutas alla program och det finns en risk att data går förlorade om användaren eller programmen inte har sparat öppnade filer.

Exempel

Exempel 1: Logga ut en användare genom att ange all nödvändig information

PS C:\> Invoke-RdsUserSessionLogoff -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1

Det här kommandot loggar ut användaren på den angivna sessionsvärden som är associerad med det angivna sessions-ID:t. Det här kommandot kräver att du har letat upp användarsessionen tidigare för att tillhandahålla all nödvändig information. Genom att köra Invoke-RdsUserSessionLogoff-cmdleten utan NoUserPrompt-växeln uppmanas du att bekräfta att du loggar ut användaren.

Exempel 2: Logga ut en användare genom att söka efter användarsessionen

PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Invoke-RdsUserSessionLogoff -NoUserPrompt

Det här kommandot använder cmdleten Get-RdsUserSession för att söka efter den specifika användarens session och skickar den sedan till cmdleten Invoke-RdsUserSessionLogoff för att logga ut användaren. Genom att köra Invoke-RdsUserSessionLogoff-cmdleten med NoUserPrompt-växeln får du ingen ytterligare uppmaning om att bekräfta att du loggar ut användaren.

Parametrar

-Force

Växeln som anger att du vill logga ut användaren och ta bort sessionen från databasen, även om tjänsten inte kan nå sessionsvärden.

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

-HostPoolName

Namnet på värdpoolen.

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

-NoUserPrompt

Växeln som anger att du vill logga ut användaren utan ytterligare bekräftelse.

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

-SessionHostName

Namnet på sessionsvärden.

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

-SessionId

Sessions-ID:t som korrelerar till den användare som du vill logga ut.

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

-TenantName

Namnet på klientorganisationen.

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

Indata

System.String

System.Int32

Utdata

System.Object