Invoke-RdsUserSessionLogoff
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.
Typ: | SwitchParameter |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-HostPoolName
Namnet på värdpoolen.
Typ: | String |
Position: | 1 |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-NoUserPrompt
Växeln som anger att du vill logga ut användaren utan ytterligare bekräftelse.
Typ: | SwitchParameter |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-SessionHostName
Namnet på sessionsvärden.
Typ: | String |
Position: | 2 |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-SessionId
Sessions-ID:t som korrelerar till den användare som du vill logga ut.
Typ: | Int32 |
Position: | 3 |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-TenantName
Namnet på klientorganisationen.
Typ: | String |
Position: | 0 |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
Indata
System.String
System.Int32
Utdata
System.Object