< Back
Invoke-RdsUserSessionLogoff
Post
NAME Invoke-RdsUserSessionLogoff
SYNTAX
Invoke-RdsUserSessionLogoff [-TenantName] <string> [-HostPoolName] <string> [-SessionHostName] <string>
[-SessionId] <int> [-NoUserPrompt] [-Force] [<CommonParameters>]
PARAMETERS
-Force
Whether to force removal of session associated with the host.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-HostPoolName <string>
Name of HostPool.
Required? true
Position? 1
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-NoUserPrompt
Required? false
Position? Named
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-SessionHostName <string>
Name of SessionHost.
Required? true
Position? 2
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-SessionId <int>
SessionId to logoff.
Required? true
Position? 3
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-TenantName <string>
Name of Tenant.
Required? true
Position? 0
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Int32
OUTPUTS
System.Object
ALIASES
None
REMARKS
None
SYNTAX
Invoke-RdsUserSessionLogoff [-TenantName] <string> [-HostPoolName] <string> [-SessionHostName] <string>
[-SessionId] <int> [-NoUserPrompt] [-Force] [<CommonParameters>]
PARAMETERS
-Force
Whether to force removal of session associated with the host.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-HostPoolName <string>
Name of HostPool.
Required? true
Position? 1
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-NoUserPrompt
Required? false
Position? Named
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-SessionHostName <string>
Name of SessionHost.
Required? true
Position? 2
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-SessionId <int>
SessionId to logoff.
Required? true
Position? 3
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-TenantName <string>
Name of Tenant.
Required? true
Position? 0
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Int32
OUTPUTS
System.Object
ALIASES
None
REMARKS
None