@pnp/cli-microsoft365 5.4.0-beta.fdd7cb1 → 5.5.0-beta.3b0d087

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/dist/Auth.js +3 -3
  2. package/dist/Command.js +22 -0
  3. package/dist/m365/aad/commands/app/app-set.js +4 -1
  4. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-remove.js +129 -0
  5. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  6. package/dist/m365/aad/commands.js +1 -0
  7. package/dist/m365/base/PowerAppsCommand.js +10 -0
  8. package/dist/m365/flow/commands/flow-export.js +3 -0
  9. package/dist/m365/pa/commands/app/app-get.js +3 -5
  10. package/dist/m365/pa/commands/app/app-list.js +10 -9
  11. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  12. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  13. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  14. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  15. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  16. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  17. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  18. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  19. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  20. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  21. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  22. package/dist/m365/planner/commands/plan/plan-get.js +58 -17
  23. package/dist/m365/planner/commands/plan/plan-remove.js +141 -0
  24. package/dist/m365/planner/commands/task/task-add.js +73 -24
  25. package/dist/m365/planner/commands/task/task-checklistitem-list.js +53 -0
  26. package/dist/m365/planner/commands/task/task-checklistitem-remove.js +85 -0
  27. package/dist/m365/planner/commands/task/task-get.js +14 -9
  28. package/dist/m365/planner/commands/task/task-list.js +19 -11
  29. package/dist/m365/planner/commands/task/task-reference-add.js +1 -7
  30. package/dist/m365/planner/commands/task/task-reference-remove.js +122 -0
  31. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  32. package/dist/m365/planner/commands/task/task-set.js +34 -24
  33. package/dist/m365/planner/commands/tenant/tenant-settings-set.js +95 -0
  34. package/dist/m365/planner/commands.js +6 -1
  35. package/dist/m365/planner/taskPriority.js +27 -0
  36. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  37. package/dist/m365/search/commands.js +1 -0
  38. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.15.0.js +23 -0
  39. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  40. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN015008_FILE_eslintrc_js.js +7 -0
  41. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.15.0-rc.0.js → upgrade-1.15.0.js} +34 -32
  42. package/dist/m365/spfx/commands/project/project-upgrade.js +13 -15
  43. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  44. package/dist/m365/spo/base-permissions.js +9 -0
  45. package/dist/m365/spo/commands/customaction/customaction-get.js +32 -4
  46. package/dist/m365/spo/commands/customaction/customaction-remove.js +43 -8
  47. package/dist/m365/spo/commands/field/field-set.js +16 -9
  48. package/dist/m365/spo/commands/group/group-add.js +96 -0
  49. package/dist/m365/spo/commands/group/group-set.js +167 -0
  50. package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
  51. package/dist/m365/spo/commands/hubsite/hubsite-list.js +1 -1
  52. package/dist/m365/spo/commands/list/ListPrincipalType.js +13 -0
  53. package/dist/m365/spo/commands/list/list-get.js +6 -0
  54. package/dist/m365/spo/commands/list/list-list.js +10 -1
  55. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  56. package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
  57. package/dist/m365/spo/commands/listitem/listitem-set.js +2 -2
  58. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  59. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  60. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  61. package/dist/m365/spo/commands/site/site-classic-list.js +1 -0
  62. package/dist/m365/spo/commands/site/site-classic-set.js +1 -0
  63. package/dist/m365/spo/commands/site/site-list.js +59 -17
  64. package/dist/m365/spo/commands/site/site-set.js +322 -162
  65. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +9 -6
  66. package/dist/m365/spo/commands.js +3 -0
  67. package/dist/m365/teams/commands/cache/cache-remove.js +155 -0
  68. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  69. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  70. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  71. package/dist/m365/teams/commands.js +1 -0
  72. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +1 -9
  73. package/dist/utils/accessToken.js +18 -0
  74. package/dist/utils/planner.js +9 -8
  75. package/dist/utils/validation.js +5 -1
  76. package/docs/docs/cmd/aad/app/app-set.md +1 -1
  77. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-remove.md +45 -0
  78. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  79. package/docs/docs/cmd/aad/user/user-get.md +12 -0
  80. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  81. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  82. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  83. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  84. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  85. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  86. package/docs/docs/cmd/planner/plan/plan-get.md +14 -2
  87. package/docs/docs/cmd/planner/plan/plan-remove.md +48 -0
  88. package/docs/docs/cmd/planner/task/task-add.md +51 -12
  89. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +24 -0
  90. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +36 -0
  91. package/docs/docs/cmd/planner/task/task-get.md +17 -8
  92. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  93. package/docs/docs/cmd/planner/task/task-reference-remove.md +39 -0
  94. package/docs/docs/cmd/planner/task/task-set.md +20 -7
  95. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +56 -0
  96. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  97. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  98. package/docs/docs/cmd/spo/customaction/customaction-get.md +15 -2
  99. package/docs/docs/cmd/spo/customaction/customaction-remove.md +33 -2
  100. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  101. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  102. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  103. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
  104. package/docs/docs/cmd/spo/hubsite/hubsite-list.md +1 -4
  105. package/docs/docs/cmd/spo/list/list-list.md +3 -0
  106. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  107. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
  108. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  109. package/docs/docs/cmd/spo/site/site-classic-list.md +3 -0
  110. package/docs/docs/cmd/spo/site/site-classic-set.md +3 -0
  111. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  112. package/docs/docs/cmd/spo/site/site-set.md +50 -6
  113. package/docs/docs/cmd/teams/cache/cache-remove.md +46 -0
  114. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  115. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  116. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  117. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +1 -1
  118. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +1 -1
  119. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +1 -1
  120. package/npm-shrinkwrap.json +175 -160
  121. package/package.json +13 -13
  122. package/dist/m365/planner/commands/plan/plan-details-get.js +0 -116
  123. package/docs/docs/cmd/planner/plan/plan-details-get.md +0 -45
@@ -16,15 +16,33 @@ m365 aad o365group restore [options]
16
16
 
17
17
  ## Options
18
18
 
19
- `-i, --id <id>`
20
- : The ID of the Microsoft 365 Group to restore
19
+ `-i, --id [id]`
20
+ : The ID of the Microsoft 365 Group to restore. Specify either `id`, `displayName` or `mailNickname` but not multiple.
21
+
22
+ `-d, --displayName [displayName]`
23
+ : Display name for the Microsoft 365 Group to restore. Specify either `id`, `displayName` or `mailNickname` but not multiple.
24
+
25
+ `-m, --mailNickname [mailNickname]`
26
+ : Name of the group e-mail (part before the @). Specify either `id`, `displayName` or `mailNickname` but not multiple.
21
27
 
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
24
30
  ## Examples
25
31
 
26
- Restores the Microsoft 365 Group with id _28beab62-7540-4db1-a23f-29a6018a3848_
32
+ Restores the Microsoft 365 Group with specific ID
27
33
 
28
34
  ```sh
29
35
  m365 aad o365group recyclebinitem restore --id 28beab62-7540-4db1-a23f-29a6018a3848
30
36
  ```
37
+
38
+ Restores the Microsoft 365 Group with specific name
39
+
40
+ ```sh
41
+ m365 aad o365group recyclebinitem restore --displayName "My Group"
42
+ ```
43
+
44
+ Restores the Microsoft 365 Group with specific mail nickname
45
+
46
+ ```sh
47
+ m365 aad o365group recyclebinitem restore --mailNickname "Mygroup"
48
+ ```
@@ -56,6 +56,18 @@ For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user na
56
56
  m365 aad user get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --properties "userPrincipalName,mail,displayName"
57
57
  ```
58
58
 
59
+ Get information about the currently logged user using the Id token
60
+
61
+ ```sh
62
+ m365 aad user get --id "@meId"
63
+ ```
64
+
65
+ Get information about the currently logged in user using the UserName token
66
+
67
+ ```sh
68
+ m365 aad user get --userName "@meUserName"
69
+ ```
70
+
59
71
  ## More information
60
72
 
61
73
  - Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)
@@ -14,16 +14,19 @@ m365 planner bucket add [options]
14
14
  : Name of the bucket to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--orderHint [orderHint]`
29
32
  : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
@@ -38,8 +41,8 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
38
41
  m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
39
42
  ```
40
43
 
41
- Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_
44
+ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
42
45
 
43
46
  ```sh
44
- m365 planner bucket add --name "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
47
+ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
45
48
  ```
@@ -17,16 +17,19 @@ m365 planner bucket get [options]
17
17
  : Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -47,11 +50,11 @@ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIF
47
50
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
53
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
51
54
  ```
52
55
 
53
56
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
54
57
 
55
58
  ```sh
56
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
- ```
59
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
60
+ ```
@@ -11,16 +11,19 @@ m365 planner bucket list [options]
11
11
  ## Options
12
12
 
13
13
  `--planId [planId]`
14
- : ID of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
14
+ : ID of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
+
16
+ `--planTitle [planTitle]`
17
+ : Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
18
 
16
19
  `--planName [planName]`
17
- : Name of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
20
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -35,5 +38,5 @@ m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
35
38
  Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
36
39
 
37
40
  ```sh
38
- m365 planner bucket list --planName "My Plan" --ownerGroupName "My Group"
41
+ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
39
42
  ```
@@ -17,16 +17,19 @@ m365 planner bucket remove [options]
17
17
  : Name of the bucket to remove. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--confirm`
32
35
  : Don't prompt for confirmation
@@ -56,5 +59,5 @@ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcA
56
59
  Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
57
60
 
58
61
  ```sh
59
- m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
62
+ m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
60
63
  ```
@@ -17,16 +17,19 @@ m365 planner bucket set [options]
17
17
  : Name of the bucket. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--newName [newName]`
32
35
  : New name of the bucket.
@@ -47,11 +50,11 @@ m365 planner bucket set --id "vncYUXCRBke28qMLB-d4xJcACtNz" --newName "New bucke
47
50
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
53
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
51
54
  ```
52
55
 
53
56
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
54
57
 
55
58
  ```sh
56
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
59
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
57
60
  ```
@@ -19,18 +19,34 @@ m365 planner plan add [options]
19
19
  `--ownerGroupName [ownerGroupName]`
20
20
  : Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
21
21
 
22
+ `--shareWithUserIds [shareWithUserIds]`
23
+ : The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
24
+
25
+ `--shareWithUserNames [shareWithUserNames]`
26
+ : The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
27
+
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
30
+ ## Remarks
31
+
32
+ Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
33
+
24
34
  ## Examples
25
35
 
26
36
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
27
37
 
28
38
  ```sh
29
- m365 planner plan add --title "My Planner Plan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
39
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
30
40
  ```
31
41
 
32
42
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_
33
43
 
34
44
  ```sh
35
- m365 planner plan add --title "My Planner Plan" --ownerGroupName "My Planner Group"
45
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
46
+ ```
47
+
48
+ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_ and share it with the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_
49
+
50
+ ```sh
51
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
36
52
  ```
@@ -8,6 +8,12 @@ Retrieve information about the specified plan
8
8
  m365 planner plan get [options]
9
9
  ```
10
10
 
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 planner plan details get [options]
15
+ ```
16
+
11
17
  ## Options
12
18
 
13
19
  `-i, --id [id]`
@@ -16,11 +22,17 @@ m365 planner plan get [options]
16
22
  `-t, --title [title]`
17
23
  : Title of the plan. Specify either `id` or `title` but not both.
18
24
 
25
+ `--planId [planId]`
26
+ : (deprecated. Use `id` instead) ID of the plan. Specify either `planId` or `planTitle` but not both.
27
+
28
+ `---planTitle [planTitle]`
29
+ : (deprecated. Use `title` instead) Title of the plan. Specify either `planId` or `planTitle` but not both.
30
+
19
31
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
32
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` or the deprecated `planTitle`.
21
33
 
22
34
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
35
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` or the deprecated `planTitle`.
24
36
 
25
37
  --8<-- "docs/cmd/_global.md"
26
38
 
@@ -0,0 +1,48 @@
1
+ # planner plan remove
2
+
3
+ Removes the Microsoft Planner plan
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner plan remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `i, --id [id]`
14
+ : ID of the plan to remove. Specify either `id` or `title` but not both.
15
+
16
+ `-t, --title [title]`
17
+ : Title of the plan to remove. Specify either `id` or `title` but not both.
18
+
19
+ `--ownerGroupId [ownerGroupId]`
20
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
21
+
22
+ `--ownerGroupName [ownerGroupName]`
23
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes the Microsoft Planner plan by ID
33
+
34
+ ```sh
35
+ m365 planner plan remove --id gndWOTSK60GfPQfiDDj43JgACDCb
36
+ ```
37
+
38
+ Removes the Microsoft Planner plan with title _My Plan_ in group with specific ID
39
+
40
+ ```sh
41
+ m365 planner plan remove --title "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000
42
+ ```
43
+
44
+ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My Planner Group_ without confirmation prompt
45
+
46
+ ```sh
47
+ m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
48
+ ```
@@ -14,22 +14,25 @@ m365 planner task add [options]
14
14
  : Title of the task to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--bucketId [bucketId]`
29
- : Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
32
+ : ID of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
30
33
 
31
34
  `--bucketName [bucketName]`
32
- : Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
35
+ : Name of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
33
36
 
34
37
  `--startDateTime [startDateTime]`
35
38
  : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
@@ -39,9 +42,6 @@ m365 planner task add [options]
39
42
 
40
43
  `--percentComplete [percentComplete]`
41
44
  : Percentage of task completion. Number between 0 and 100.
42
- - When set to 0, the task is considered _Not started_.
43
- - When set between 1 and 99, the task is considered _In progress_.
44
- - When set to 100, the task is considered _Completed_.
45
45
 
46
46
  `--assignedToUserIds [assignedToUserIds]`
47
47
  : The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
@@ -49,14 +49,41 @@ m365 planner task add [options]
49
49
  `--assignedToUserNames [assignedToUserNames]`
50
50
  : The comma-separated UPNs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
51
51
 
52
+ `--assigneePriority [assigneePriority]`
53
+ : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
54
+
52
55
  `--description [description]`
53
56
  : Description of the task
54
57
 
58
+ `--appliedCategories [appliedCategories]`
59
+ : Comma-separated categories that should be added to the task. The possible options are: `category1`, `category2`, `category3`, `category4`, `category5` and/or `category6`. Additional info defined [here](https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0).
60
+
61
+ `--previewType [previewType]`
62
+ : 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. Default `automatic`.
63
+
55
64
  `--orderHint [orderHint]`
56
- : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
65
+ : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
66
+
67
+ `--priority [priority]`
68
+ : 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.
57
69
 
58
70
  --8<-- "docs/cmd/_global.md"
59
71
 
72
+ ## Remarks
73
+
74
+ When you specify the value for `percentComplete`, consider the following:
75
+
76
+ - when set to 0, the task is considered _Not started_
77
+ - when set between 1 and 99, the task is considered _In progress_
78
+ - when set to 100, the task is considered _Completed_
79
+
80
+ When you specify an integer value for `priority`, consider the following:
81
+
82
+ - values 0 and 1 are interpreted as _Urgent_
83
+ - values 2, 3 and 4 are interpreted as _Important_
84
+ - values 5, 6 and 7 are interpreted as _Medium_
85
+ - values 8, 9 and 10 are interpreted as _Low_
86
+
60
87
  ## Examples
61
88
 
62
89
  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_
@@ -65,10 +92,10 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
65
92
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
66
93
  ```
67
94
 
68
- 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_
95
+ Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
69
96
 
70
97
  ```sh
71
- m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
98
+ m365 planner task add --title "My Planner task" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
72
99
  ```
73
100
 
74
101
  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_
@@ -76,3 +103,15 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
76
103
  ```sh
77
104
  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"
78
105
  ```
106
+
107
+ 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 _' !'_
108
+
109
+ ```sh
110
+ m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --asssigneePriority ' !'
111
+ ```
112
+
113
+ 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_
114
+
115
+ ```sh
116
+ m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --appliedCategories "category1,category3" --previewType "noPreview"
117
+ ```
@@ -0,0 +1,24 @@
1
+ # planner task checklistitem list
2
+
3
+ Lists the checklist items of a Planner task.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task checklistitem list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --taskId <taskId>`
14
+ : ID of the task
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Lists the checklist items of a Planner task.
21
+
22
+ ```sh
23
+ m365 planner task checklistitem list --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
24
+ ```
@@ -0,0 +1,36 @@
1
+ # planner task checklistitem remove
2
+
3
+ Removes the checklist item from the Planner task.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task checklistitem remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the checklist item.
15
+
16
+ `--taskId <taskId>`
17
+ : ID of the task.
18
+
19
+ `--confirm`
20
+ : Don't prompt for confirmation
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Examples
25
+
26
+ Removes a checklist item with the id _40012_ from the Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
27
+
28
+ ```sh
29
+ m365 planner task checklistitem remove --id "40012" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
30
+ ```
31
+
32
+ Removes a checklist item with the id _40012_ from the Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_ without prompt
33
+
34
+ ```sh
35
+ m365 planner task checklistitem remove --id "40012" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --confirm
36
+ ```
@@ -8,6 +8,12 @@ Retrieve the specified planner task
8
8
  m365 planner task get [options]
9
9
  ```
10
10
 
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 planner task details get [options]
15
+ ```
16
+
11
17
  ## Options
12
18
 
13
19
  `-i, --id [id]`
@@ -20,22 +26,25 @@ m365 planner task get [options]
20
26
  : (deprecated. Use `id` instead) ID of the task.
21
27
 
22
28
  `--bucketId [bucketId]`
23
- : Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
29
+ : ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
24
30
 
25
31
  `--bucketName [bucketName]`
26
- : Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
32
+ : Name of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
27
33
 
28
34
  `--planId [planId]`
29
- : Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
35
+ : ID of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
36
+
37
+ `--planTitle [planTitle]`
38
+ : Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
30
39
 
31
40
  `--planName [planName]`
32
- : Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
41
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
33
42
 
34
43
  `--ownerGroupId [ownerGroupId]`
35
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
44
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
36
45
 
37
46
  `--ownerGroupName [ownerGroupName]`
38
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
47
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
39
48
 
40
49
  --8<-- "docs/cmd/_global.md"
41
50
 
@@ -47,8 +56,8 @@ Retrieve the specified planner task by id
47
56
  m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"
48
57
  ```
49
58
 
50
- Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_ based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
59
+ Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_.
51
60
 
52
61
  ```sh
53
- m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
62
+ m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
54
63
  ```
@@ -17,16 +17,19 @@ m365 planner task list [options]
17
17
  : Name of the bucket to list the tasks of. To retrieve tasks from a bucket, specify `bucketId` or `bucketName`, but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
20
+ : ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -52,7 +55,7 @@ m365 planner task list --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"`
52
55
  List the Microsoft Planner tasks in the plan _My Plan_ in group _My Group_
53
56
 
54
57
  ```sh
55
- m365 planner task list --planName "My Plan" --ownerGroupName "My Group"
58
+ m365 planner task list --planTitle "My Plan" --ownerGroupName "My Group"
56
59
  ```
57
60
 
58
61
  List the Microsoft Planner tasks in the bucket _FtzysDykv0-9s9toWiZhdskAD67z_
@@ -70,5 +73,5 @@ m365 planner task list --bucketName "My Bucket" --planId "iVPMIgdku0uFlou-KLNg6M
70
73
  List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My Plan_ in group _My Group_
71
74
 
72
75
  ```sh
73
- m365 planner task list --bucketName "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
76
+ m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
74
77
  ```