Stop-R1Task
Stop-R1Task
SYNOPSIS
Terminates a running task.
SYNTAX
Stop-R1Task [-id] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Terminates a task which is running.
EXAMPLES
Example 1
Stop-R1Task -id 'e4ef6b3e'
Terminates the task, after prompting for confirmation.
Example 2
Get-R1Task | Where-Object status -eq 'RUNNING' | Stop-R1Task
Terminates every running task.
PARAMETERS
-id
The identifier of the task.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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.