Invoke-RdsUserSessionLogoff

Odwołanie

Moduł:: WindowsVirtualDesktopPowershell

Wyloguje użytkownika z bieżącej aktywnej sesji.

Składnia

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

Opis

Invoke-RdsUserSessionLogoff wyloguje użytkownika swoją bieżącą aktywną sesję uruchomioną na określonym hoście sesji. Ponieważ użytkownik jest wylogowany, wszystkie aplikacje zostaną zakończone i istnieje możliwość utraty danych, jeśli użytkownik lub aplikacje nie zapisał otwartych plików.

Przykłady

Przykład 1. Wylogowanie użytkownika przez podanie wszystkich wymaganych informacji

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

To polecenie powoduje wylogowanie użytkownika na określonym hoście sesji skojarzonym z podanym identyfikatorem sesji. To polecenie wymaga wcześniejszego wyszukania sesji użytkownika, aby podać wszystkie wymagane informacje. Uruchamiając polecenie cmdlet Invoke-RdsUserSessionLogoff bez przełącznika NoUserPrompt, zostanie wyświetlony monit o potwierdzenie wylogowania użytkownika.

Przykład 2. Wyloguj użytkownika, wyszukując sesję użytkownika

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

To polecenie używa polecenia cmdlet Get-RdsUserSession do wyszukiwania sesji określonego użytkownika, a następnie potokuje je do polecenia cmdlet Invoke-RdsUserSessionLogoff w celu wylogowania użytkownika. Uruchamiając polecenie cmdlet Invoke-RdsUserSessionLogoff z przełącznikiem NoUserPrompt, nie otrzymasz żadnego dodatkowego monitu o potwierdzenie wylogowania użytkownika.

Parametry

-Force

Przełącznik wskazujący, że chcesz wylogować użytkownika i usunąć sesję z bazy danych, nawet jeśli usługa nie może nawiązać połączenia z hostem sesji.

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

-HostPoolName

Nazwa puli hostów.

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

-NoUserPrompt

Przełącznik wskazujący, że chcesz wylogować użytkownika bez dodatkowego potwierdzenia.

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

-SessionHostName

Nazwa hosta sesji.

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

-SessionId

Identyfikator sesji korelujący z użytkownikiem, który chcesz wylogować.

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

-TenantName

Nazwa dzierżawy.

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

Dane wejściowe

System.String

System.Int32

Dane wyjściowe

System.Object