O Invoke-RdsUserSessionLogoff faz logoff de um usuário sua sessão ativa atual em execução no host de sessão especificado. Uma vez que o usuário está desconectado, todos os aplicativos serão encerrados e há um potencial para dados a serem perdidos se o usuário ou aplicativos não salvaram arquivos abertos.
Exemplos
Exemplo 1: Fazer logoff de um usuário fornecendo todas as informações necessárias
Este comando faz logoff do usuário no host de sessão especificado associado ao ID de sessão fornecido. Este comando requer que você tenha pesquisado a sessão do usuário anteriormente para fornecer todas as informações necessárias. Ao executar o cmdlet Invoke-RdsUserSessionLogoff sem a opção NoUserPrompt, você será solicitado a confirmar o logoff do usuário.
Exemplo 2: Fazer logoff de um usuário pesquisando sua sessão de usuário
Este comando usa o cmdlet Get-RdsUserSession para procurar a sessão do usuário específico e, em seguida, canaliza-o para o cmdlet Invoke-RdsUserSessionLogoff para fazer logoff do usuário. Ao executar o cmdlet Invoke-RdsUserSessionLogoff com a opção NoUserPrompt, você não receberá nenhum prompt adicional para confirmar o logoff do usuário.
Parâmetros
-Force
A opção que indica que você gostaria de fazer logoff do usuário e remover a sessão do banco de dados, mesmo que o serviço não possa alcançar o host da sessão.
Propriedades dos parâmetros
Tipo:
SwitchParameter
Default value:
None
Suporta carateres universais:
False
NãoMostrar:
False
Conjuntos de parâmetros
(All)
Position:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline por nome de propriedade:
False
Valor dos restantes argumentos:
False
-HostPoolName
O nome do pool de hosts.
Propriedades dos parâmetros
Tipo:
String
Default value:
None
Suporta carateres universais:
False
NãoMostrar:
False
Conjuntos de parâmetros
(All)
Position:
1
Obrigatório:
True
Valor do pipeline:
True
Valor do pipeline por nome de propriedade:
True
Valor dos restantes argumentos:
False
-NoUserPrompt
A opção indica que você gostaria de fazer logoff do usuário sem qualquer confirmação adicional.
Propriedades dos parâmetros
Tipo:
SwitchParameter
Default value:
None
Suporta carateres universais:
False
NãoMostrar:
False
Conjuntos de parâmetros
(All)
Position:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline por nome de propriedade:
False
Valor dos restantes argumentos:
False
-SessionHostName
O nome do host da sessão.
Propriedades dos parâmetros
Tipo:
String
Default value:
None
Suporta carateres universais:
False
NãoMostrar:
False
Conjuntos de parâmetros
(All)
Position:
2
Obrigatório:
True
Valor do pipeline:
True
Valor do pipeline por nome de propriedade:
True
Valor dos restantes argumentos:
False
-SessionId
O ID da sessão correlacionado ao usuário que você deseja fazer logoff.
Propriedades dos parâmetros
Tipo:
Int32
Default value:
None
Suporta carateres universais:
False
NãoMostrar:
False
Conjuntos de parâmetros
(All)
Position:
3
Obrigatório:
True
Valor do pipeline:
True
Valor do pipeline por nome de propriedade:
True
Valor dos restantes argumentos:
False
-TenantName
O nome do inquilino.
Propriedades dos parâmetros
Tipo:
String
Default value:
None
Suporta carateres universais:
False
NãoMostrar:
False
Conjuntos de parâmetros
(All)
Position:
0
Obrigatório:
True
Valor do pipeline:
True
Valor do pipeline por nome de propriedade:
True
Valor dos restantes argumentos:
False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.