Invoke-RdsUserSessionLogoff

Modul:

Microsoft.RDInfra.RDPowershell Module

Loggar ut en användare från den aktuella aktiva sessionen.

Syntax

Default (Standard)

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

Description

Den Invoke-RdsUserSessionLogoff loggar ut en användare, deras aktuella aktiva session körs på den angivna sessionsvärden. Eftersom användaren loggas ut kommer alla program att avslutas och det finns en risk för 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 ange all nödvändig information. Genom att köra cmdleten Invoke-RdsUserSessionLogoff utan växeln NoUserPrompt uppmanas du att bekräfta att du vill logga ut användaren.

Exempel 2: Logga ut en användare genom att söka efter deras användarsession

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 cmdleten Invoke-RdsUserSessionLogoff med växeln NoUserPrompt får du ingen ytterligare uppmaning om att bekräfta att användaren ska loggas ut.

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.

Parameteregenskaper

Typ:	SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-HostPoolName

Namnet på värdpoolen.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	1
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-NoUserPrompt

Omkopplaren som anger att du vill logga ut från användaren utan ytterligare bekräftelse.

Parameteregenskaper

Typ:	SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-SessionHostName

Namnet på sessionsvärden.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	2
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-SessionId

Sessions-ID:t som korrelerar med den användare som du vill logga ut.

Parameteregenskaper

Typ:	Int32
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	3
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-TenantName

Namnet på hyresgästen.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	0
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

System.String

System.Int32

Utdata

System.Object