Invoke-RdsUserSessionLogoff

Moduł:

Microsoft.RDInfra.RDPowershell Module

Wylogowuje użytkownika z jego bieżącej aktywnej sesji.

Składnia

Default (Domyślna)

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

Opis

Invoke-RdsUserSessionLogoff wylogowuje użytkownika, jego 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ły 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 wylogowuje użytkownika na określonym hoście sesji skojarzonym z podanym identyfikatorem sesji. To polecenie wymaga wcześniejszego sprawdzenia 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: Wylogowanie użytkownika przez wyszukanie jego sesji 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 wyszukania sesji określonego użytkownika, a następnie przesyła 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.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-HostPoolName

Nazwa puli hostów.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	1
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-NoUserPrompt

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

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-SessionHostName

Nazwa hosta sesji.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	2
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-SessionId

Identyfikator sesji odpowiadający użytkownikowi, z którego chcesz się wylogować.

Właściwości parametru

Typ:	Int32
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	3
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-TenantName

Nazwa dzierżawy.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	0
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

System.String

System.Int32

Dane wyjściowe

System.Object