planner task add¶
Adds a new Microsoft Planner task
Usage¶
m365 planner task add [options]
Options¶
-t, --title <title>
- Title of the task to add.
--planId [planId]
- Plan ID to which the task belongs. Specify either
planId
orplanName
but not both. --planName [planName]
- Plan Name to which the task belongs. Specify either
planId
orplanName
but not both. --ownerGroupId [ownerGroupId]
- ID of the group to which the plan belongs. Specify
ownerGroupId
orownerGroupName
when usingplanName
. --ownerGroupName [ownerGroupName]
- Name of the group to which the plan belongs. Specify
ownerGroupId
orownerGroupName
when usingplanName
. --bucketId [bucketId]
- Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either
bucketId
orbucketName
but not both. --bucketName [bucketName]
- Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either
bucketId
orbucketName
but not both. --startDateTime [startDateTime]
- The date and time when the task started. This should be defined as a valid ISO 8601 string.
2021-12-16T18:28:48.6964197Z
--dueDateTime [dueDateTime]
- The date and time when the task is due. This should be defined as a valid ISO 8601 string.
2021-12-16T18:28:48.6964197Z
--percentComplete [percentComplete]
- Percentage of task completion. Number between 0 and 100.
--assignedToUserIds [assignedToUserIds]
- The comma-separated IDs of the assignees the task is assigned to. Specify either
assignedToUserIds
orassignedToUserNames
but not both. --assignedToUserNames [assignedToUserNames]
- The comma-separated UPNs of the assignees the task is assigned to. Specify either
assignedToUserIds
orassignedToUserNames
but not both. --assigneePriority [assigneePriority]
- Hint used to order items of this type in a list view. The format is defined as outlined here.
--description [description]
- Description of the task
--appliedCategories [appliedCategories]
- Comma-separated categories that should be added to the task. The possible options are:
category1
,category2
,category3
,category4
,category5
and/orcategory6
. Additional info defined here. --previewType [previewType]
- This sets the type of preview that shows up on the task. The possible values are:
automatic
,noPreview
,checklist
,description
,reference
. When set to automatic the displayed preview is chosen by the app viewing the task. Defaultautomatic
. --orderHint [orderHint]
- Hint used to order items of this type in a list view. The format is defined as outlined here.
--priority [priority]
- Priority of the task: Urgent, Important, Medium, Low. Or an integer between 0 and 10 (check remarks section for more info). Default value is Medium.
-h, --help
- output usage information
--query [query]
- JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
- Output type.
json,text,csv
. Defaultjson
--verbose
- Runs command with verbose logging
--debug
- Runs command with debug logging
Remarks¶
When you specify the value for percentComplete
, consider the following:
- when set to 0, the task is considered Not started
- when set between 1 and 99, the task is considered In progress
- when set to 100, the task is considered Completed
When you specify an integer value for priority
, consider the following:
- values 0 and 1 are interpreted as Urgent
- values 2, 3 and 4 are interpreted as Important
- values 5, 6 and 7 are interpreted as Medium
- values 8, 9 and 10 are interpreted as Low
Examples¶
Adds a Microsoft Planner task with the name My Planner Task for plan with the ID 8QZEH7b3wkSbGQobscsM5gADCBa and for the bucket with the ID IK8tuFTwQEa5vTonM7ZMRZgAKdna
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
Adds a Completed Microsoft Planner task with the name My Planner Task for plan with the name My Planner Plan owned by group My Planner Group and for the bucket with the ID IK8tuFTwQEa5vTonM7ZMRZgAKdna
m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
Adds a Microsoft Planner task with the name My Planner Task for plan with the ID 8QZEH7b3wkbGQobscsM5gADCBa and for the bucket with the ID IK8tuFTwQEa5vTonM7ZMRZgAKdna. The new task will be assigned to the users Allan.Carroll@contoso.com and Ida.Stevens@contoso.com and receive a due date for 2021-12-16
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
Adds a Microsoft Planner task with the name My Planner Task for plan with the ID 8QZEH7b3wkbGQobscsM5gADCBa and for the bucket with the ID IK8tuFTwQEa5vTonM7ZMRZgAKdna. The new task will be assigned to the users Allan.Carroll@contoso.com and Ida.Stevens@contoso.com who will appear first with the asssignee priority ' !'
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --asssigneePriority ' !'
Adds a Microsoft Planner task with the name My Planner Task for plan with the ID 8QZEH7b3wkbGQobscsM5gADCBa and for the bucket with the ID IK8tuFTwQEa5vTonM7ZMRZgAKdna. The new task will receive the categories category1,category3 and get a preview with the type noPreview
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --appliedCategories "category1,category3" --previewType "noPreview"