Invoke-RdsUserSessionLogoff

  • Referência
Módulo:
WindowsVirtualDesktopPowershell

Regista um utilizador da sua sessão ativa atual.

Syntax

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

Description

O Invoke-RdsUserSessionLogoff regista um utilizador a sua sessão ativa atual em execução no anfitrião de sessão especificado. Uma vez que o utilizador é desligado, todas as aplicações serão encerradas e existe um potencial para os dados serem perdidos se o utilizador ou aplicações não tiverem guardado ficheiros abertos.

Exemplos

Exemplo 1: Faça o registo de um utilizador, fornecendo todas as informações necessárias

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

Este comando regista o utilizador no anfitrião de sessão especificado associado ao ID de sessão fornecido. Este comando requer que tenha procurado a sessão do utilizador anteriormente para fornecer todas as informações necessárias. Ao executar o Invoke-RdsUserSessionLogoff cmdlet sem o interruptor NoUserPrompt, será solicitado que confirme para iniciar sessão do utilizador.

Exemplo 2: Faça login num utilizador procurando a sua sessão de utilizador

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

Este comando utiliza o Get-RdsUserSession cmdlet para procurar a sessão específica do utilizador e, em seguida, canaliza-o para o Invoke-RdsUserSessionLogoff cmdlet para iniciar sessão do utilizador. Ao executar o Invoke-RdsUserSessionLogoff cmdlet com o interruptor NoUserPrompt, não receberá nenhuma solicitação adicional para confirmar para iniciar sessão do utilizador.

Parâmetros

-Force

O interruptor indica que pretende desligar o utilizador e remover a sessão da base de dados, mesmo que o serviço não consiga chegar ao anfitrião da sessão.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostPoolName

O nome da piscina anfitriã.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoUserPrompt

O interruptor indica que pretende desligar o utilizador sem qualquer confirmação adicional.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SessionHostName

O nome do anfitrião da sessão.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SessionId

O ID da sessão está relacionado com o utilizador que pretende iniciar sessão.

Type:Int32
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TenantName

O nome do inquilino.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Entradas

System.String

System.Int32

Saídas

System.Object