Invoke-RdsUserSessionLogoff

Modul:

Microsoft.RDInfra.RDPowershell Module

Odhlásí uživatele z jeho aktuální aktivní relace.

Syntaxe

Default (Výchozí)

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

Description

Invoke-RdsUserSessionLogoff odhlásí uživatele od jeho aktuální aktivní relace spuštěné na určeném hostiteli relace. Vzhledem k tomu, že je uživatel odhlášen, budou ukončeny všechny aplikace a existuje možnost ztráty dat, pokud uživatel nebo aplikace neuložili otevřené soubory.

Příklady

Příklad 1: Odhlášení uživatele zadáním všech požadovaných informací

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

Tento příkaz odhlásí uživatele na určeném hostiteli relace přidruženém k zadanému ID relace. Tento příkaz vyžaduje, abyste již dříve vyhledali relaci uživatele a poskytli všechny požadované informace. Spuštěním rutiny Invoke-RdsUserSessionLogoff bez přepínače NoUserPrompt budete požádáni o potvrzení odhlášení uživatele.

Příklad 2: Odhlášení uživatele vyhledáním jeho uživatelské relace

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

Tento příkaz pomocí rutiny Get-RdsUserSession vyhledá relaci konkrétního uživatele a poté ji předá do rutiny Invoke-RdsUserSessionLogoff a odhlásí uživatele. Spuštěním rutiny Invoke-RdsUserSessionLogoff s přepínačem NoUserPrompt se nezobrazí žádná další výzva k potvrzení odhlášení uživatele.

Parametry

-Force

Přepínač označující, že chcete odhlásit uživatele a odebrat relaci z databáze, i když se služba nemůže připojit k hostiteli relace.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-HostPoolName

Název fondu hostitelů.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	1
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-NoUserPrompt

Spínač označující, že si přejete odhlásit uživatele bez dalšího potvrzení.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-SessionHostName

Název hostitele relace.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	2
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-SessionId

ID relace vztahující se k uživateli, kterého chcete odhlásit.

Vlastnosti parametru

Typ:	Int32
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	3
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-TenantName

Název tenanta.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	0
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

System.String

System.Int32

Výstupy

System.Object