Skip to content

Latest commit

 

History

History
260 lines (185 loc) · 4.73 KB

Set-MyTask.md

File metadata and controls

260 lines (185 loc) · 4.73 KB
Raw
external help file Module Name online version schema
MyTasks-help.xml
MyTasks
2.0.0

Set-MyTask

SYNOPSIS

Modify or change a MyTask work item.

SYNTAX

Name (Default)

Set-MyTask [-Name] <String> [-NewName <String>] [-Description <String>] [-DueDate <DateTime>]
 [-Progress <Int32>] [-Passthru] [-WhatIf] [-Confirm] [-Category <String>] [<CommonParameters>]

Task

Set-MyTask [-Task <MyTask>] [-NewName <String>] [-Description <String>] [-DueDate <DateTime>]
 [-Progress <Int32>] [-Passthru] [-WhatIf] [-Confirm] [-Category <String>] [<CommonParameters>]

ID

Set-MyTask [-ID <Int32>] [-NewName <String>] [-Description <String>] [-DueDate <DateTime>] [-Progress <Int32>]
 [-Passthru] [-WhatIf] [-Confirm] [-Category <String>] [<CommonParameters>]

DESCRIPTION

Use this command to change a MyTask work item. You can specify a task by name or ID, although it might be just as easy to pipe from Get-MyTask. Use Complete-MyTask to mark an item as completed.

EXAMPLES

EXAMPLE 1

PS C:\> Set-MyTask -Name "Finish DSC Training" -Progress 70 -duedate "12/31/2020" -Passthru

ID  Name                      Description             DueDate OverDue Category     Progress
--  ----                      -----------             ------- ------- --------     --------
16  Finish DSC Training                            12/31/2020 False   Personal           70

Set the progress value and a new due date for the 'Finish DSC Training' task.

EXAMPLE 2

PS C:\> Get-MyTask -ID 9 | Set-MyTask -Progress 10 -Category Projects

Get the task with ID 9 and pipe to Set-MyTask which changes the progress value and category.

PARAMETERS

-Category

Set the task category.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: your defined categories

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

-Description

Set the comment or description for the task.

Type: String
Parameter Sets: (All)
Aliases:

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

-DueDate

Set when the task is due for completion.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-ID

Enter the task ID to identify the task you wish to modify.

Type: Int32
Parameter Sets: ID
Aliases:

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

-Name

Enter the name of a task to modify.

Type: String
Parameter Sets: Name
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NewName

Give the task a new name.

Type: String
Parameter Sets: (All)
Aliases:

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

-Passthru

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Progress

Set a progress completion value between 0 and 100.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Task

A task object usually piped from Get-MyTask.

Type: MyTask
Parameter Sets: Task
Aliases:

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

-Confirm

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

System.Int

MyTask

OUTPUTS

MyTask

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Get-MyTask

Complete-MyTask