Skip to content

Stop-Envtesttask

Stops a still running task from completing.

Syntax

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

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

Detailed Description

Stops a still running task from completing. A task may still be retreived via Get-EnvTestTask until it Remove-EnvTestTask is called with its task id.

Parameters

Name Description Required? Pipeline Input Default Value
TaskId The id of the task to stop, retrieveable from the \$task.TaskId property. false false
Task An EnvTestTask representing the task to stop 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

Examples

Example 1

Stop-EnvTestTask

Description

Stops the current task from completing if it is still running.

Example 2

Stop-EnvTestTask -TestId 50A4139F-2B55-4A97-A1BE-20EE4E124AA3

Description

Stops a task from completing via its id, which is available from an existing task's \$task.TaskId property.

Example 3

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

Stop-EnvTestTask -Task $secondTask

Description

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

Was this article helpful?