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

このコマンドは、指定されたセッション ID に関連付けられた指定されたセッションホスト上のユーザーをログオフします。このコマンドでは、必要な情報をすべて提供するために、以前にユーザーセッションを検索しておく必要があります。 NoUserPrompt スイッチを指定せずに Invoke-RdsUserSessionLogoff コマンドレットを実行すると、ユーザーのログオフを確認するように求められます。

例 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
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HostPoolName

ホストプールの名前。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-NoUserPrompt

追加の確認なしでユーザーをログオフすることを示すスイッチ。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SessionHostName

セッション・ホストの名前。

型:	String
配置:	2
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SessionId

ログオフするユーザーに関連付けるセッション ID。

型:	Int32
配置:	3
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-TenantName

テナントの名前。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

入力

System.String

System.Int32

出力

System.Object