Invoke-RdsUserSessionLogoff

Модуль:

Microsoft.RDInfra.RDPowershell

Выводит пользователя из текущего активного сеанса.

Синтаксис

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

Описание

Этот Invoke-RdsUserSessionLogoff выводит пользователя из системы, его текущий активный сеанс выполняется на указанном узле сеанса. Поскольку пользователь вышел из системы, все приложения будут завершены, и существует вероятность потери данных, если пользователь или приложения не сохранили открытые файлы.

Примеры

Пример 1: Выйдите из системы, предоставив всю необходимую информацию

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

Эта команда выводит пользователя из системы на указанном узле сеанса, связанном с предоставленным идентификатором сеанса. Эта команда требует, чтобы вы ранее выполнили поиск пользовательского сеанса, чтобы предоставить всю необходимую информацию. При выполнении командлета Invoke-RdsUserSessionLogoff без переключателя NoUserPrompt вам будет предложено подтвердить выход пользователя из системы.

Пример 2: Выход пользователя из системы, выполнив поиск его пользовательского сеанса

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

Эта команда использует командлет Get-RdsUserSession для поиска сеанса конкретного пользователя, а затем передает его в командлет Invoke-RdsUserSessionLogoff для выхода пользователя из системы. При выполнении командлета Invoke-RdsUserSessionLogoff с параметром NoUserPrompt вы не получите никаких дополнительных запросов на подтверждение выхода пользователя из системы.

Параметры

-Force

Переключатель, указывающий на то, что вы хотите выйти из системы пользователя и удалить сеанс из базы данных, даже если служба не может связаться с узлом сеанса.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-HostPoolName

Имя пула узлов.

Тип:	String
Position:	1
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-NoUserPrompt

Переключатель указывает на то, что вы хотите выйти из системы пользователя без какого-либо дополнительного подтверждения.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SessionHostName

Имя узла сеанса.

Тип:	String
Position:	2
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-SessionId

Идентификатор сеанса, соответствующий пользователю, из которого вы хотите выйти из системы.

Тип:	Int32
Position:	3
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TenantName

Имя клиента.

Тип:	String
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

Входные данные

System.String

System.Int32

Выходные данные

System.Object