Citrix Virtual Apps and Desktops SDK

Stop-EnvTestTask

Stops a still running task from completing.

Syntax

Stop-EnvTestTask
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->
Stop-EnvTestTask
    [-Task <EnvTestTask>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->
Stop-EnvTestTask
    [-TaskId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

Stop-EnvTestTask
<!--NeedCopy-->

EXAMPLE 2

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

Stop-EnvTestTask -TestId 50A4139F-2B55-4A97-A1BE-20EE4E124AA3
<!--NeedCopy-->

EXAMPLE 3

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

$secondTask = $(Get-EnvTestTask -List)[1]
Stop-EnvTestTask -Task $secondTask
<!--NeedCopy-->

Parameters

-TaskId

The id of the task to stop, retrieveable from the $task.TaskId property.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Task

An EnvTestTask representing the task to stop

Type: EnvTestTask
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Stop-EnvTestTask