@pnp/cli-microsoft365 6.3.0 → 6.4.0-beta.39e5130

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 (185) hide show
  1. package/.eslintrc.js +1 -0
  2. package/README.md +12 -1
  3. package/dist/Command.js +1 -0
  4. package/dist/m365/aad/commands/user/user-get.js +3 -0
  5. package/dist/m365/aad/commands/user/user-license-remove.js +2 -1
  6. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +2 -9
  7. package/dist/m365/aad/commands/user/user-set.js +3 -0
  8. package/dist/m365/aad/commands/user/user-signin-list.js +3 -0
  9. package/dist/m365/flow/commands/flow-disable.js +9 -2
  10. package/dist/m365/flow/commands/flow-enable.js +9 -2
  11. package/dist/m365/flow/commands/flow-get.js +9 -2
  12. package/dist/m365/flow/commands/flow-list.js +1 -1
  13. package/dist/m365/flow/commands/flow-remove.js +2 -2
  14. package/dist/m365/flow/commands/owner/owner-add.js +147 -0
  15. package/dist/m365/flow/commands/owner/owner-list.js +89 -0
  16. package/dist/m365/flow/commands/owner/owner-remove.js +147 -0
  17. package/dist/m365/flow/commands/run/run-cancel.js +9 -2
  18. package/dist/m365/flow/commands/run/run-list.js +5 -2
  19. package/dist/m365/flow/commands.js +3 -0
  20. package/dist/m365/planner/commands/roster/roster-member-add.js +3 -0
  21. package/dist/m365/planner/commands/roster/roster-member-get.js +98 -0
  22. package/dist/m365/planner/commands.js +1 -0
  23. package/dist/m365/spfx/commands/spfx-doctor.js +43 -29
  24. package/dist/m365/spo/commands/customaction/customaction-get.js +27 -7
  25. package/dist/m365/spo/commands/file/file-move.js +1 -1
  26. package/dist/m365/spo/commands/group/group-member-add.js +54 -95
  27. package/dist/m365/spo/commands/list/list-add.js +11 -8
  28. package/dist/m365/spo/commands/list/list-set.js +3 -3
  29. package/dist/m365/spo/commands/navigation/navigation-node-add.js +5 -4
  30. package/dist/m365/spo/commands/navigation/navigation-node-set.js +5 -1
  31. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +118 -0
  32. package/dist/m365/spo/commands/term/term-get.js +68 -48
  33. package/dist/m365/spo/commands.js +1 -0
  34. package/dist/utils/aadGroup.js +18 -0
  35. package/dist/utils/aadUser.js +20 -0
  36. package/dist/utils/md.js +7 -0
  37. package/dist/utils/spo.js +32 -0
  38. package/docs/docs/cmd/aad/approleassignment/approleassignment-add.md +5 -5
  39. package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +3 -3
  40. package/docs/docs/cmd/aad/user/user-remove.md +1 -1
  41. package/docs/docs/cmd/cli/completion/completion-clink-update.md +4 -4
  42. package/docs/docs/cmd/flow/owner/owner-add.md +61 -0
  43. package/docs/docs/cmd/flow/owner/owner-list.md +90 -0
  44. package/docs/docs/cmd/flow/owner/owner-remove.md +67 -0
  45. package/docs/docs/cmd/flow/run/run-list.md +28 -0
  46. package/docs/docs/cmd/onenote/page/page-list.md +1 -1
  47. package/docs/docs/cmd/outlook/mail/mail-send.md +7 -3
  48. package/docs/docs/cmd/outlook/message/message-get.md +143 -0
  49. package/docs/docs/cmd/outlook/message/message-list.md +119 -0
  50. package/docs/docs/cmd/outlook/message/message-move.md +4 -0
  51. package/docs/docs/cmd/outlook/report/report-mailactivitycounts.md +40 -0
  52. package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.md +40 -0
  53. package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.md +45 -0
  54. package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.md +43 -0
  55. package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.md +44 -0
  56. package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.md +48 -0
  57. package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.md +41 -0
  58. package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.md +49 -0
  59. package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.md +37 -0
  60. package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.md +40 -0
  61. package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.md +36 -0
  62. package/docs/docs/cmd/outlook/room/room-list.md +81 -0
  63. package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +58 -0
  64. package/docs/docs/cmd/planner/plan/plan-add.md +3 -3
  65. package/docs/docs/cmd/planner/plan/plan-set.md +73 -7
  66. package/docs/docs/cmd/planner/roster/roster-add.md +16 -1
  67. package/docs/docs/cmd/planner/roster/roster-member-get.md +87 -0
  68. package/docs/docs/cmd/planner/task/task-add.md +230 -0
  69. package/docs/docs/cmd/planner/task/task-checklistitem-add.md +55 -0
  70. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +55 -0
  71. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +4 -0
  72. package/docs/docs/cmd/planner/task/task-get.md +131 -0
  73. package/docs/docs/cmd/planner/task/task-list.md +92 -0
  74. package/docs/docs/cmd/planner/task/task-reference-add.md +46 -0
  75. package/docs/docs/cmd/planner/task/task-reference-list.md +46 -0
  76. package/docs/docs/cmd/planner/task/task-reference-remove.md +4 -0
  77. package/docs/docs/cmd/planner/task/task-remove.md +4 -0
  78. package/docs/docs/cmd/planner/task/task-set.md +230 -0
  79. package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +55 -0
  80. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +55 -0
  81. package/docs/docs/cmd/pp/card/card-get.md +2 -2
  82. package/docs/docs/cmd/pp/card/card-list.md +2 -2
  83. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +7 -7
  84. package/docs/docs/cmd/skype/report/report-activitycounts.md +38 -0
  85. package/docs/docs/cmd/skype/report/report-activityusercounts.md +38 -0
  86. package/docs/docs/cmd/skype/report/report-activityuserdetail.md +67 -0
  87. package/docs/docs/cmd/spfx/project/project-doctor.md +3 -3
  88. package/docs/docs/cmd/spfx/project/project-externalize.md +3 -3
  89. package/docs/docs/cmd/spfx/project/project-upgrade.md +3 -3
  90. package/docs/docs/cmd/spfx/spfx-doctor.md +3 -3
  91. package/docs/docs/cmd/spo/cdn/cdn-get.md +6 -6
  92. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +3 -3
  93. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +3 -3
  94. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +3 -3
  95. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +3 -3
  96. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +3 -3
  97. package/docs/docs/cmd/spo/cdn/cdn-set.md +3 -3
  98. package/docs/docs/cmd/spo/customaction/customaction-get.md +113 -11
  99. package/docs/docs/cmd/spo/externaluser/externaluser-list.md +2 -0
  100. package/docs/docs/cmd/spo/group/group-member-add.md +26 -4
  101. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.md +2 -0
  102. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md +2 -0
  103. package/docs/docs/cmd/spo/homesite/homesite-remove.md +2 -0
  104. package/docs/docs/cmd/spo/homesite/homesite-set.md +2 -0
  105. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +2 -0
  106. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +2 -0
  107. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +3 -3
  108. package/docs/docs/cmd/spo/list/list-add.md +2 -2
  109. package/docs/docs/cmd/spo/list/list-set.md +2 -2
  110. package/docs/docs/cmd/spo/listitem/listitem-add.md +1 -1
  111. package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +1 -1
  112. package/docs/docs/cmd/spo/listitem/listitem-set.md +1 -1
  113. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +3 -3
  114. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +2 -2
  115. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +2 -0
  116. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +2 -0
  117. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +2 -0
  118. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +2 -0
  119. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +2 -0
  120. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +3 -3
  121. package/docs/docs/cmd/spo/site/site-appcatalog-add.md +2 -0
  122. package/docs/docs/cmd/spo/site/site-appcatalog-remove.md +3 -3
  123. package/docs/docs/cmd/spo/site/site-commsite-enable.md +2 -0
  124. package/docs/docs/cmd/spo/site/site-list.md +3 -3
  125. package/docs/docs/cmd/spo/site/site-remove.md +3 -3
  126. package/docs/docs/cmd/spo/site/site-rename.md +3 -3
  127. package/docs/docs/cmd/spo/site/site-set.md +5 -5
  128. package/docs/docs/cmd/spo/storageentity/storageentity-remove.md +3 -3
  129. package/docs/docs/cmd/spo/storageentity/storageentity-set.md +3 -3
  130. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.md +3 -3
  131. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.md +2 -0
  132. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +3 -3
  133. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.md +142 -0
  134. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.md +2 -0
  135. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.md +3 -3
  136. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md +3 -3
  137. package/docs/docs/cmd/spo/tenant/tenant-settings-list.md +2 -0
  138. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +28 -26
  139. package/docs/docs/cmd/spo/term/term-add.md +3 -3
  140. package/docs/docs/cmd/spo/term/term-get.md +3 -3
  141. package/docs/docs/cmd/spo/term/term-group-add.md +2 -0
  142. package/docs/docs/cmd/spo/term/term-group-get.md +2 -0
  143. package/docs/docs/cmd/spo/term/term-group-list.md +2 -0
  144. package/docs/docs/cmd/spo/term/term-list.md +3 -1
  145. package/docs/docs/cmd/spo/term/term-set-add.md +3 -3
  146. package/docs/docs/cmd/spo/term/term-set-get.md +2 -0
  147. package/docs/docs/cmd/spo/term/term-set-list.md +2 -0
  148. package/docs/docs/cmd/spo/theme/theme-apply.md +3 -3
  149. package/docs/docs/cmd/spo/theme/theme-get.md +2 -0
  150. package/docs/docs/cmd/spo/theme/theme-list.md +2 -0
  151. package/docs/docs/cmd/spo/theme/theme-remove.md +2 -0
  152. package/docs/docs/cmd/spo/theme/theme-set.md +3 -3
  153. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  154. package/docs/docs/cmd/teams/channel/channel-member-add.md +2 -2
  155. package/docs/docs/cmd/teams/message/message-get.md +39 -4
  156. package/docs/docs/cmd/teams/message/message-list.md +41 -6
  157. package/docs/docs/cmd/teams/message/message-reply-list.md +39 -4
  158. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +20 -2
  159. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +8 -8
  160. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +12 -5
  161. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +13 -6
  162. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +14 -7
  163. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +13 -6
  164. package/docs/docs/cmd/teams/report/report-pstncalls.md +13 -6
  165. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +13 -6
  166. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +13 -6
  167. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +13 -6
  168. package/docs/docs/cmd/teams/tab/tab-add.md +16 -0
  169. package/docs/docs/cmd/teams/tab/tab-get.md +17 -0
  170. package/docs/docs/cmd/teams/tab/tab-list.md +19 -0
  171. package/docs/docs/cmd/teams/team/team-add.md +77 -8
  172. package/docs/docs/cmd/teams/team/team-app-list.md +18 -2
  173. package/docs/docs/cmd/teams/team/team-archive.md +2 -2
  174. package/docs/docs/cmd/teams/team/team-clone.md +8 -8
  175. package/docs/docs/cmd/teams/team/team-get.md +34 -4
  176. package/docs/docs/cmd/teams/team/team-list.md +34 -3
  177. package/docs/docs/cmd/teams/team/team-remove.md +3 -3
  178. package/docs/docs/cmd/teams/team/team-set.md +8 -8
  179. package/docs/docs/cmd/teams/team/team-unarchive.md +3 -2
  180. package/docs/docs/cmd/teams/user/user-app-add.md +3 -3
  181. package/docs/docs/cmd/teams/user/user-app-list.md +18 -2
  182. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -4
  183. package/docs/docs/cmd/teams/user/user-list.md +21 -4
  184. package/npm-shrinkwrap.json +279 -194
  185. package/package.json +14 -14
@@ -66,14 +66,74 @@ Updates a Microsoft Planner plan category labels
66
66
  m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --category25 'Urgent'
67
67
  ```
68
68
 
69
- ## More information
69
+ ## Response
70
70
 
71
- - Update plannerPlan: [https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http)
72
- - plannerPlanDetails resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0)
73
- - plannerCategoryDescriptions resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0)
71
+ ### Standard response
74
72
 
73
+ === "JSON"
75
74
 
76
- ## Response
75
+ ```json
76
+ {
77
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
78
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
79
+ "title": "My Planner Plan",
80
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
81
+ "createdBy": {
82
+ "user": {
83
+ "displayName": null,
84
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
85
+ },
86
+ "application": {
87
+ "displayName": null,
88
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
89
+ }
90
+ },
91
+ "container": {
92
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
93
+ "type": "group",
94
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
95
+ }
96
+ }
97
+ ```
98
+
99
+ === "Text"
100
+
101
+ ```text
102
+ createdDateTime: 2015-03-30T18:36:49.2407981Z
103
+ id : xqQg5FS2LkCp935s-FIFm2QAFkHM
104
+ owner : ebf3b108-5234-4e22-b93d-656d7dae5874
105
+ title : My Planner Plan
106
+ ```
107
+
108
+ === "CSV"
109
+
110
+ ```csv
111
+ id,title,createdDateTime,owner
112
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
113
+ ```
114
+
115
+ === "Markdown"
116
+
117
+ ```md
118
+ # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
119
+
120
+ Date: 30/03/2015
121
+
122
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
123
+
124
+ Property | Value
125
+ ---------|-------
126
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
127
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
128
+ title | My Planner Plan
129
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
130
+ createdBy | {"user":{"displayName":null,"id":"95e27074-6c4a-447a-aa24-9d718a0b86fa"},"application":{"displayName":null,"id":"ebf3b108-5234-4e22-b93d-656d7dae5874"}}
131
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
132
+ ```
133
+
134
+ ### `shareWithUserIds`, `shareWithUserNames` response
135
+
136
+ When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ.
77
137
 
78
138
  === "JSON"
79
139
 
@@ -151,9 +211,9 @@ m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --
151
211
  === "Markdown"
152
212
 
153
213
  ```md
154
- # planner plan set --id "xqQg5FS2LkCp935s-FIFm2QAFkHM" --newTitle "My Planner Plan"
214
+ # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874" --shareWithUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com"
155
215
 
156
- Date: 27/12/2022
216
+ Date: 30/03/2015
157
217
 
158
218
  ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
159
219
 
@@ -168,3 +228,9 @@ m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --
168
228
  sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
169
229
  categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
170
230
  ```
231
+
232
+ ## More information
233
+
234
+ - Update plannerPlan: [https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http)
235
+ - plannerPlanDetails resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0)
236
+ - plannerCategoryDescriptions resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0)
@@ -55,6 +55,21 @@ m365 planner roster add
55
55
  id,assignedSensitivityLabel
56
56
  e6fmvM_yi0OJgvmepE5uj5cAE6qX,
57
57
  ```
58
-
58
+
59
+ === "Markdown"
60
+
61
+ ```md
62
+ # planner roster add
63
+
64
+ Date: 7/2/2023
65
+
66
+ ## e6fmvM_yi0OJgvmepE5uj5cAE6qX
67
+
68
+ Property | Value
69
+ ---------|-------
70
+ id | e6fmvM_yi0OJgvmepE5uj5cAE6qX
71
+ assignedSensitivityLabel | null
72
+ ```
73
+
59
74
  ## Additional information
60
75
  Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
@@ -0,0 +1,87 @@
1
+ # planner roster member get
2
+
3
+ Gets a member of the specified Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster member get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--rosterId <rosterId>`
14
+ : ID of the Planner Roster.
15
+
16
+ `--userId [userId]`
17
+ : User's Azure AD ID. Specify either `userId` or `userName` but not both.
18
+
19
+ `--userName [userName]`
20
+ : User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId` or `userName` but not both.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! attention
27
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
28
+
29
+ ## Examples
30
+
31
+ Gets a specific user by user name as member of the Planner Roster
32
+
33
+ ```sh
34
+ m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
35
+ ```
36
+
37
+ Gets a specific user by ID as member of the Planner Roster
38
+
39
+ ```sh
40
+ m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
41
+ ```
42
+
43
+ ## Response
44
+
45
+ === "JSON"
46
+
47
+ ```json
48
+ {
49
+ "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
50
+ "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
51
+ "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
52
+ "roles": []
53
+ }
54
+ ```
55
+
56
+ === "Text"
57
+
58
+ ```text
59
+ id : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
60
+ roles : []
61
+ tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
62
+ userId : 2056d2f6-3257-4253-8cfc-b73393e414e5
63
+ ```
64
+
65
+ === "CSV"
66
+
67
+ ```csv
68
+ id,userId,tenantId,roles
69
+ b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
70
+ ```
71
+
72
+ === "Markdown"
73
+
74
+ ```md
75
+ # planner roster member get --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
76
+
77
+ Date: 18/2/2023
78
+
79
+ ## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
80
+
81
+ Property | Value
82
+ ---------|-------
83
+ id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
84
+ userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
85
+ tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
86
+ roles | []
87
+ ```
@@ -112,3 +112,233 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
112
112
  ```sh
113
113
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --appliedCategories "category1,category3" --previewType "noPreview"
114
114
  ```
115
+
116
+ ## Response
117
+
118
+ ### Standard response
119
+
120
+ === "JSON"
121
+
122
+ ```json
123
+ {
124
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
125
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
126
+ "title": "Important task",
127
+ "orderHint": "8585269241124027581",
128
+ "assigneePriority": "",
129
+ "percentComplete": 50,
130
+ "startDateTime": "2023-01-20T00:00:00Z",
131
+ "createdDateTime": "2023-01-25T21:39:33.0748226Z",
132
+ "dueDateTime": "2023-02-15T00:00:00Z",
133
+ "hasDescription": false,
134
+ "previewType": "automatic",
135
+ "completedDateTime": null,
136
+ "completedBy": null,
137
+ "referenceCount": 0,
138
+ "checklistItemCount": 0,
139
+ "activeChecklistItemCount": 0,
140
+ "conversationThreadId": null,
141
+ "priority": 5,
142
+ "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
143
+ "createdBy": {
144
+ "user": {
145
+ "displayName": null,
146
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
147
+ },
148
+ "application": {
149
+ "displayName": null,
150
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
151
+ }
152
+ },
153
+ "appliedCategories": {},
154
+ "assignments": {}
155
+ }
156
+ ```
157
+
158
+ === "Text"
159
+
160
+ ```text
161
+ activeChecklistItemCount: 0
162
+ appliedCategories : {}
163
+ assigneePriority :
164
+ assignments : {}
165
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
166
+ checklistItemCount : 0
167
+ completedBy : null
168
+ completedDateTime : null
169
+ conversationThreadId : null
170
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
171
+ createdDateTime : 2023-01-25T21:44:10.6044385Z
172
+ dueDateTime : 2023-02-15T00:00:00Z
173
+ hasDescription : false
174
+ id : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
175
+ orderHint : 8585269238348731422
176
+ percentComplete : 50
177
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
178
+ previewType : automatic
179
+ priority : 5
180
+ referenceCount : 0
181
+ references : {}
182
+ startDateTime : 2023-01-20T00:00:00Z
183
+ title : Important task
184
+ ```
185
+
186
+ === "CSV"
187
+
188
+ ```csv
189
+ planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments
190
+ oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269237867589640,,50,2023-01-20T00:00:00Z,2023-01-25T21:44:58.7186167Z,2023-02-15T00:00:00Z,,automatic,,,0,0,0,,5,D-ys8Ef4kEuwYG4r68Um3pcAAe9M,"{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""},""application"":{""displayName"":null,""id"":""31359c7f-bd7e-475c-86db-fdb8c937548e""}}",{},{}
191
+ ```
192
+
193
+ === "Markdown"
194
+
195
+ ```md
196
+ # planner task add --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b" --bucketName "To do" --startDateTime "2023-01-20" --dueDateTime "2023-02-15" --percentComplete "50" --title "Important task"
197
+
198
+ Date: 25/1/2023
199
+
200
+ ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
201
+
202
+ Property | Value
203
+ ---------|-------
204
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
205
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
206
+ title | Important task
207
+ orderHint | 8585269235419217847
208
+ assigneePriority |
209
+ percentComplete | 50
210
+ startDateTime | 2023-01-20T00:00:00Z
211
+ createdDateTime | 2023-01-25T21:49:03.555796Z
212
+ dueDateTime | 2023-02-15T00:00:00Z
213
+ hasDescription | false
214
+ previewType | automatic
215
+ completedDateTime | null
216
+ completedBy | null
217
+ referenceCount | 0
218
+ checklistItemCount | 0
219
+ activeChecklistItemCount | 0
220
+ conversationThreadId | null
221
+ priority | 5
222
+ id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
223
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
224
+ appliedCategories | {}
225
+ assignments | {}
226
+ ```
227
+
228
+ ### `description`, `previewType` response
229
+
230
+ === "JSON"
231
+
232
+ ```json
233
+ {
234
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
235
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
236
+ "title": "Important task",
237
+ "orderHint": "8585269241124027581",
238
+ "assigneePriority": "",
239
+ "percentComplete": 50,
240
+ "startDateTime": "2023-01-20T00:00:00Z",
241
+ "createdDateTime": "2023-01-25T21:39:33.0748226Z",
242
+ "dueDateTime": "2023-02-15T00:00:00Z",
243
+ "hasDescription": true,
244
+ "previewType": "automatic",
245
+ "completedDateTime": null,
246
+ "completedBy": null,
247
+ "referenceCount": 0,
248
+ "checklistItemCount": 0,
249
+ "activeChecklistItemCount": 0,
250
+ "conversationThreadId": null,
251
+ "priority": 5,
252
+ "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
253
+ "createdBy": {
254
+ "user": {
255
+ "displayName": null,
256
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
257
+ },
258
+ "application": {
259
+ "displayName": null,
260
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
261
+ }
262
+ },
263
+ "appliedCategories": {},
264
+ "assignments": {},
265
+ "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
266
+ "references": {},
267
+ "checklist": {}
268
+ }
269
+ ```
270
+
271
+ === "Text"
272
+
273
+ ```txt
274
+ activeChecklistItemCount: 0
275
+ appliedCategories : {}
276
+ assigneePriority :
277
+ assignments : {}
278
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
279
+ checklist : {}
280
+ checklistItemCount : 0
281
+ completedBy : null
282
+ completedDateTime : null
283
+ conversationThreadId : null
284
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
285
+ createdDateTime : 2023-01-25T21:44:10.6044385Z
286
+ description : Lorem ipsum dolor sit amet, consectetur adipiscing elit.
287
+ dueDateTime : 2023-02-15T00:00:00Z
288
+ hasDescription : true
289
+ id : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
290
+ orderHint : 8585269238348731422
291
+ percentComplete : 50
292
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
293
+ previewType : automatic
294
+ priority : 5
295
+ referenceCount : 0
296
+ references : {}
297
+ startDateTime : 2023-01-20T00:00:00Z
298
+ title : Important task
299
+ ```
300
+
301
+ === "CSV"
302
+
303
+ ```csv
304
+ planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments,description,references,checklist
305
+ oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269237867589640,,50,2023-01-20T00:00:00Z,2023-01-25T21:44:58.7186167Z,2023-02-15T00:00:00Z,1,automatic,,,0,0,0,,5,D-ys8Ef4kEuwYG4r68Um3pcAAe9M,"{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""},""application"":{""displayName"":null,""id"":""31359c7f-bd7e-475c-86db-fdb8c937548e""}}",{},{},"Lorem ipsum dolor sit amet, consectetur adipiscing elit.",{},{}
306
+ ```
307
+
308
+ === "Markdown"
309
+
310
+ ```md
311
+ # planner task add --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b" --bucketName "To do" --startDateTime "2023-01-20" --dueDateTime "2023-02-15" --percentComplete "50" --title "Important task" --description "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
312
+
313
+ Date: 25/1/2023
314
+
315
+ ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
316
+
317
+ Property | Value
318
+ ---------|-------
319
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
320
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
321
+ title | Important task
322
+ orderHint | 8585269235419217847
323
+ assigneePriority |
324
+ percentComplete | 50
325
+ startDateTime | 2023-01-20T00:00:00Z
326
+ createdDateTime | 2023-01-25T21:49:03.555796Z
327
+ dueDateTime | 2023-02-15T00:00:00Z
328
+ hasDescription | true
329
+ previewType | automatic
330
+ completedDateTime | null
331
+ completedBy | null
332
+ referenceCount | 0
333
+ checklistItemCount | 0
334
+ activeChecklistItemCount | 0
335
+ conversationThreadId | null
336
+ priority | 5
337
+ id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
338
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
339
+ appliedCategories | {}
340
+ assignments | {}
341
+ description | Lorem ipsum dolor sit amet, consectetur adipiscing elit.
342
+ references | {}
343
+ checklist | {}
344
+ ```
@@ -34,3 +34,58 @@ Adds a checked checklist item with title _My checklist item_ to a Microsoft Plan
34
34
  ```sh
35
35
  m365 planner task checklistitem add --taskId 2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2 --title "My checklist item" --isChecked
36
36
  ```
37
+
38
+ ## Response
39
+
40
+ === "JSON"
41
+
42
+ ```json
43
+ {
44
+ "b65db83e-d777-49db-8cdd-57a41b86f48c": {
45
+ "isChecked": false,
46
+ "title": "Communicate with customer",
47
+ "orderHint": "8585269221832287402",
48
+ "lastModifiedDateTime": "2023-01-25T22:11:42.2488405Z",
49
+ "lastModifiedBy": {
50
+ "user": {
51
+ "displayName": null,
52
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
53
+ }
54
+ }
55
+ }
56
+ }
57
+ ```
58
+
59
+ === "Text"
60
+
61
+ ```txt
62
+ id : b65db83e-d777-49db-8cdd-57a41b86f48c
63
+ isChecked: false
64
+ title : Communicate with customer
65
+ ```
66
+
67
+ === "CSV"
68
+
69
+ ```csv
70
+ id,title,isChecked
71
+ b65db83e-d777-49db-8cdd-57a41b86f48c,Communicate with customer,
72
+ ```
73
+
74
+ === "Markdown"
75
+
76
+ ```md
77
+ # planner task checklistitem add --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ" --title "Communicate with customer"
78
+
79
+ Date: 25/1/2023
80
+
81
+ ## Communicate with customer (b65db83e-d777-49db-8cdd-57a41b86f48c)
82
+
83
+ Property | Value
84
+ ---------|-------
85
+ id | b65db83e-d777-49db-8cdd-57a41b86f48c
86
+ isChecked | false
87
+ title | Communicate with customer
88
+ orderHint | 8585269209601773376
89
+ lastModifiedDateTime | 2023-01-25T22:32:05.3002431Z
90
+ lastModifiedBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}
91
+ ```
@@ -22,3 +22,58 @@ Lists the checklist items of a Planner task.
22
22
  ```sh
23
23
  m365 planner task checklistitem list --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
24
24
  ```
25
+
26
+ ## Response
27
+
28
+ === "JSON"
29
+
30
+ ```json
31
+ {
32
+ "4e3c8841-560c-436e-ba06-cc7731680d59": {
33
+ "isChecked": false,
34
+ "title": "Communicate with customer",
35
+ "orderHint": "8585269209601773376",
36
+ "lastModifiedDateTime": "2023-01-25T22:32:05.3002431Z",
37
+ "lastModifiedBy": {
38
+ "user": {
39
+ "displayName": null,
40
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
41
+ }
42
+ }
43
+ }
44
+ }
45
+ ```
46
+
47
+ === "Text"
48
+
49
+ ```txt
50
+ id title isChecked
51
+ ------------------------------------ ------------------------- ---------
52
+ 4e3c8841-560c-436e-ba06-cc7731680d59 Communicate with customer false
53
+ ```
54
+
55
+ === "CSV"
56
+
57
+ ```csv
58
+ id,title,isChecked
59
+ 4e3c8841-560c-436e-ba06-cc7731680d59,Communicate with customer,
60
+ ```
61
+
62
+ === "Markdown"
63
+
64
+ ```md
65
+ # planner task checklistitem list --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ"
66
+
67
+ Date: 25/1/2023
68
+
69
+ ## Communicate with customer (4e3c8841-560c-436e-ba06-cc7731680d59)
70
+
71
+ Property | Value
72
+ ---------|-------
73
+ id | 4e3c8841-560c-436e-ba06-cc7731680d59
74
+ isChecked | false
75
+ title | Communicate with customer
76
+ orderHint | 8585269209601773376
77
+ lastModifiedDateTime | 2023-01-25T22:32:05.3002431Z
78
+ lastModifiedBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}
79
+ ```
@@ -34,3 +34,7 @@ Removes a checklist item with the id _40012_ from the Planner task with the id _
34
34
  ```sh
35
35
  m365 planner task checklistitem remove --id "40012" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --confirm
36
36
  ```
37
+
38
+ ## Response
39
+
40
+ The command won't return a response on success.