Invoke-RdsUserSessionLogoff

Reference

Modul:: WindowsVirtualDesktopPowershell

Odhlásí uživatele z aktuální aktivní relace.

Syntax

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

Description

Invoke-RdsUserSessionLogoff odhlásí uživatele jeho aktuální aktivní relaci spuštěnou na zadaném hostiteli relace. Vzhledem k tomu, že je uživatel odhlášený, všechny aplikace budou ukončeny a existuje možnost ztráty dat, pokud uživatel nebo aplikace neuloží otevřené soubory.

Příklady

Příklad 1: Odhlášení uživatele zadáním všech požadovaných informací

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

Tento příkaz odhlásí uživatele na zadaném hostiteli relace přidruženém k zadanému ID relace. Tento příkaz vyžaduje, abyste předtím vyhlašovali uživatelskou relaci, abyste zadali všechny požadované informace. Spuštěním rutiny Invoke-RdsUserSessionLogoff bez přepínače NoUserPrompt budete vyzváni k potvrzení odhlášení uživatele.

Příklad 2: Odhlášení uživatele vyhledáním jeho uživatelské relace

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

Tento příkaz pomocí rutiny Get-RdsUserSession vyhledá relaci konkrétního uživatele a pak ji předá do rutiny Invoke-RdsUserSessionLogoff, aby se uživatel odhlasil. Spuštěním rutiny Invoke-RdsUserSessionLogoff s přepínačem NoUserPrompt se nezobrazí žádná další výzva k potvrzení odhlášení uživatele.

Parametry

-Force

Přepínač označující, že chcete odhlásit uživatele a odebrat relaci z databáze, i když se služba nemůže spojit s hostitelem relace.

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

-HostPoolName

Název fondu hostitelů.

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

-NoUserPrompt

Přepínač označující, že chcete uživatele odhlásit bez jakéhokoli dalšího potvrzení.

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

-SessionHostName

Název hostitele relace.

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

-SessionId

ID relace, které souvisí s uživatelem, kterého chcete odhlásit.

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

-TenantName

Název tenanta.

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

Vstupy

System.String

System.Int32

Výstupy

System.Object