Invoke-RdsUserSessionLogoff
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 z bieżącej aktywnej sesji uruchomionej 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: Wyloguj użytkownika, podając wszystkie wymagane informacje
PS C:\> Invoke-RdsUserSessionLogoff -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1
To polecenie wyloguje 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 go 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.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-HostPoolName
Nazwa puli hostów.
Typ: | String |
Position: | 1 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-NoUserPrompt
Przełącznik wskazujący, że chcesz wylogować użytkownika bez dodatkowego potwierdzenia.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-SessionHostName
Nazwa hosta sesji.
Typ: | String |
Position: | 2 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SessionId
Identyfikator sesji korelujący z użytkownikiem, który chcesz wylogować.
Typ: | Int32 |
Position: | 3 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-TenantName
Nazwa dzierżawy.
Typ: | String |
Position: | 0 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
Dane wejściowe
System.String
System.Int32
Dane wyjściowe
System.Object