Disconnect-RdsUserSession

Desconecta a un usuario de su sesión activa actual.

Sintaxis

Default (Es el valor predeterminado).

Disconnect-RdsUserSession
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-SessionHostName] <String>
    [-SessionId] <Int32>
    [-NoUserPrompt]
    [<CommonParameters>]

Description

El cmdlet Disconnect-RdsUserSession desconecta al usuario de su sesión activa actual que se está ejecutando en el host de sesión especificado. El usuario no se desconecta, por lo que todas las aplicaciones continúan ejecutándose. El usuario puede volver a conectarse a su sesión iniciando una conexión de nuevo en su cliente de Escritorio remoto.

Ejemplos

Ejemplo 1: Desconectar a un usuario proporcionando toda la información necesaria

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

Este comando desconecta al 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 Disconnect-RdsUserSession sin el modificador NoUserPrompt, se le pedirá que confirme la desconexión del usuario.

Ejemplo 2: Desconectar a un usuario mediante la búsqueda de su sesión de usuario

PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Disconnect-RdsUserSession -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 Disconnect-RdsUserSession para desconectar al usuario. Al ejecutar el cmdlet Disconnect-RdsUserSession con el modificador NoUserPrompt, no recibirá ningún mensaje adicional para confirmar la desconexión del usuario.

Parámetros

-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 desconectar al 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 desconectar.

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