Compartir a través de

Invoke-RdsUserSessionLogoff

Módulo:
Microsoft.RDInfra.RDPowershell Module

Cierra la sesión de un usuario de su sesión activa actual.

Sintaxis

Default (Es el valor predeterminado). 

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

Description

El Invoke-RdsUserSessionLogoff cierra la sesión activa de un usuario que se está ejecutando en el host de sesión especificado. Dado que el usuario está desconectado, todas las aplicaciones se cerrarán y existe la posibilidad de que se pierdan datos si el usuario o las aplicaciones no han guardado los archivos abiertos.

Ejemplos

Ejemplo 1: Cerrar la sesión de un usuario proporcionando toda la información necesaria

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

Este comando cierra la sesión del usuario en el host de sesión especificado asociado con el ID de sesión proporcionado. Este comando requiere que haya buscado la sesión de usuario previamente para proporcionar toda la información requerida. Al ejecutar el cmdlet Invoke-RdsUserSessionLogoff sin el modificador NoUserPrompt, se le pedirá que confirme que se cierra la sesión del usuario.

Ejemplo 2: Cerrar la sesión de un usuario buscando su sesión de usuario

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

Este comando usa el cmdlet Get-RdsUserSession para buscar la sesión del usuario específico y, a continuación, lo canaliza al cmdlet Invoke-RdsUserSessionLogoff para cerrar la sesión del usuario. Al ejecutar el cmdlet Invoke-RdsUserSessionLogoff con el modificador NoUserPrompt, no recibirá ningún mensaje adicional para confirmar el cierre de sesión del usuario.

Parámetros

-Force

El modificador que indica que desea cerrar la sesión del usuario y quitar la sesión de la base de datos, incluso si el servicio no puede acceder al host de sesión.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-HostPoolName

Nombre del grupo de hosts.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-NoUserPrompt

El interruptor que indica que desea cerrar la sesión del usuario sin ninguna confirmación adicional.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-SessionHostName

El nombre del host de la sesión.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:2
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-SessionId

El ID de sesión que se correlaciona con el usuario que desea cerrar la sesión.

Propiedades del parámetro

Tipo:Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:3
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-TenantName

El nombre del inquilino.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

System.String

System.Int32

Salidas

System.Object