Invoke-RdsUserSessionLogoff

Modul:
Microsoft.RDInfra.RDPowershell Module

Meldet einen Benutzer von seiner aktuellen aktiven Sitzung ab.

Syntax

Default (Standardwert) 

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

Beschreibung

Der Invoke-RdsUserSessionLogoff meldet einen Benutzer ab, dessen aktuelle aktive Sitzung auf dem angegebenen Sitzungshost ausgeführt wird. Da der Benutzer abgemeldet ist, werden alle Anwendungen beendet, und es besteht die Möglichkeit, dass Daten verloren gehen, wenn der Benutzer oder die Anwendungen die geöffneten Dateien nicht gespeichert haben.

Beispiele

Beispiel 1: Abmelden eines Benutzers durch Bereitstellen aller erforderlichen Informationen

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

Mit diesem Befehl wird der Benutzer auf dem angegebenen Sitzungshost abgemeldet, der der angegebenen Sitzungs-ID zugeordnet ist. Für diesen Befehl müssen Sie die Benutzersitzung zuvor nachgeschlagen haben, um alle erforderlichen Informationen bereitzustellen. Wenn Sie das Cmdlet Invoke-RdsUserSessionLogoff ohne die Option NoUserPrompt ausführen, werden Sie aufgefordert, die Abmeldung des Benutzers zu bestätigen.

Beispiel 2: Abmelden eines Benutzers durch Suchen nach seiner Benutzersitzung

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

Dieser Befehl verwendet das Cmdlet Get-RdsUserSession, um nach der Sitzung des jeweiligen Benutzers zu suchen, und leitet sie dann an das Cmdlet Invoke-RdsUserSessionLogoff weiter, um den Benutzer abzumelden. Wenn Sie das Cmdlet Invoke-RdsUserSessionLogoff mit der Option NoUserPrompt ausführen, erhalten Sie keine zusätzliche Eingabeaufforderung zur Bestätigung, dass sich der Benutzer abmelden soll.

Parameter

-Force

Der Schalter, der angibt, dass Sie den Benutzer abmelden und die Sitzung aus der Datenbank entfernen möchten, auch wenn der Dienst den Sitzungshost nicht erreichen kann.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-HostPoolName

Der Name des Hostpools.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:1
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-NoUserPrompt

Der Schalter, der anzeigt, dass Sie den Benutzer ohne zusätzliche Bestätigung abmelden möchten.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-SessionHostName

Der Name des Sitzungshosts.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:2
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-SessionId

Die Sitzungs-ID, die dem Benutzer entspricht, den Sie abmelden möchten.

Parametereigenschaften

Typ:Int32
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:3
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-TenantName

Der Name des Mandanten.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:0
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

System.String

System.Int32

Ausgaben

System.Object