Citrix Virtual Apps and Desktops SDK

Switch-EnvTestTask

Sets the current task that will be returned by a call to Get-EnvTestTask with no parameters.

Syntax

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

Description

Sets the current task that will be returned by a call to Get-EnvTestTask with no parameters.

Examples

EXAMPLE 1

Switches the current task to another via its id, which is available from an existing task’s $task.TaskId property.

Switch-EnvTestTask -TaskId 50A4139F-2B55-4A97-A1BE-20EE4E124AA3
<!--NeedCopy-->

EXAMPLE 2

Switches the current task to the second in the list returned by Get-EnvTestTask -List.

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

Parameters

-TaskId

Specifies the identifier of the task to be made current.

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

-Task

The task object to be made current, retrieveable from the $task.TaskId property.

Type: EnvTestTask
Position: Named
Default value: None
Required: False
Accept pipeline input: False
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

PSObject

Objects containing the TaskId parameter can be piped to the Remove-EnvTestTask command.

Outputs

None

By default, this cmdlet returns no output.

Switch-EnvTestTask