Remove-RDMTask

    2024-10-28

    Remove-RDMTask

    SYNOPSIS

    Delete a task

    SYNTAX

    __AllParameterSets

    Remove-RDMTask [-Task] <PSTask> [-Force] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Delete a task of the current data source. The deletion consists of setting the status to Deleted. The confirm impact level is low. This feature is only available for the following data sources: Devolutions Server, Azure SQL, SQL Server, and SQLite.

    EXAMPLES

    EXAMPLE 1

    Get-RDMTask | Remove-RDMTask -Force

    Set the all tasks' status to Deleted without confirmation prompt.

    EXAMPLE 2

    Get-RDMTask -Due LastMonth | Where-Object AssignedToUserID -eq 00000000-0000-0000-0000-000000000000 | Remove-RDMTask -Force

    Remove all the tasks that were due last month and are still unassigned without a confirmation prompt. The empty guid means it is unassigned.

    EXAMPLE 3

    Get-RDMTask -Status Done, Closed | Remove-RDMTask -Force

    Remove all tasks that are done or closed without a confirmation prompt.

    PARAMETERS

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Force

    The task will be saved or created without confirmation.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -ForcePromptAnswer

    Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

    • Yes: Accept the prompt. Cover the OK and Automatic value.
    • No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Task

    Task to add or modify.

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -WhatIf

    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

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

    INPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask

    The task obtained from Get-RDMTask can be piped to the parameter Task.

    OUTPUTS

    NOTES

    For more information, type "Get-Help Remove-RDMTask -detailed". For technical information, type "Get-Help Remove-RDMTask -full".