Citrix Virtual Apps and Desktops SDK


Removes from the database completed tasks for the EnvTest Service.


Remove-EnvTestTask [-TaskId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-EnvTestTask [-Task <EnvTestTask>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Enables completed tasks that have run within the EnvTest Service to be removed from the database.


Name Description Required? Pipeline Input Default Value
TaskId Specifies the identifier of the task to be removed, retrieveable from the $task.TaskId property. false false  
Task Specifies the task to be removed. false true (ByValue)  
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values


Example 1



Removes the current task from the EnvTest service.

Example 2

Remove-EnvTestTask -TaskId 50A4139F-2B55-4A97-A1BE-20EE4E124AA3


Removes a task from the EnvTest service via its id, which is available from an existing task’s $task.TaskId property.

Example 3

$secondTask = $(Get-EnvTestTask -List)[1]

Remove-EnvTestTask -Task $secondTask


Removes the second task in the list returned by Get-EnvTestTask -List.