@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
@@ -55,3 +55,134 @@ Retrieve the specified planner task with the title _My Planner Task_ from the bu
55
55
  ```sh
56
56
  m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
57
57
  ```
58
+
59
+ ## Response
60
+
61
+ === "JSON"
62
+
63
+ ```json
64
+ {
65
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
66
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
67
+ "title": "Important task",
68
+ "orderHint": "8585269235419217847",
69
+ "assigneePriority": "",
70
+ "percentComplete": 50,
71
+ "startDateTime": "2023-01-20T00:00:00Z",
72
+ "createdDateTime": "2023-01-25T21:49:03.555796Z",
73
+ "dueDateTime": "2023-02-15T00:00:00Z",
74
+ "hasDescription": true,
75
+ "previewType": "automatic",
76
+ "completedDateTime": null,
77
+ "completedBy": null,
78
+ "referenceCount": 0,
79
+ "checklistItemCount": 2,
80
+ "activeChecklistItemCount": 2,
81
+ "conversationThreadId": null,
82
+ "priority": 5,
83
+ "id": "OopX1ANphEu7Lm4-0tVtl5cAFRGQ",
84
+ "createdBy": {
85
+ "user": {
86
+ "displayName": null,
87
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
88
+ },
89
+ "application": {
90
+ "displayName": null,
91
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
92
+ }
93
+ },
94
+ "appliedCategories": {},
95
+ "assignments": {},
96
+ "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
97
+ "references": {},
98
+ "checklist": {
99
+ "4e3c8841-560c-436e-ba06-cc7731680d59": {
100
+ "isChecked": false,
101
+ "title": "Communicate with customer",
102
+ "orderHint": "8585269209601773376",
103
+ "lastModifiedDateTime": "2023-01-25T22:32:05.3002431Z",
104
+ "lastModifiedBy": {
105
+ "user": {
106
+ "displayName": null,
107
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
108
+ }
109
+ }
110
+ }
111
+ }
112
+ }
113
+ ```
114
+
115
+ === "Text"
116
+
117
+ ```txt
118
+ activeChecklistItemCount: 1
119
+ appliedCategories : {}
120
+ assigneePriority :
121
+ assignments : {}
122
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
123
+ checklist : {"4e3c8841-560c-436e-ba06-cc7731680d59":{"isChecked":false,"title":"Communicate with customer","orderHint":"8585269209601773376","lastModifiedDateTime":"2023-01-25T22:32:05.3002431Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}}
124
+ checklistItemCount : 1
125
+ completedBy : null
126
+ completedDateTime : null
127
+ conversationThreadId : null
128
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
129
+ createdDateTime : 2023-01-25T21:49:03.555796Z
130
+ description : Lorem ipsum dolor sit amet, consectetur adipiscing elit.
131
+ dueDateTime : 2023-02-15T00:00:00Z
132
+ hasDescription : true
133
+ id : OopX1ANphEu7Lm4-0tVtl5cAFRGQ
134
+ orderHint : 8585269235419217847
135
+ percentComplete : 50
136
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
137
+ previewType : automatic
138
+ priority : 5
139
+ referenceCount : 0
140
+ references : {}
141
+ startDateTime : 2023-01-20T00:00:00Z
142
+ title : Important task
143
+ ```
144
+
145
+ === "CSV"
146
+
147
+ ```csv
148
+ 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
149
+ oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269235419217847,,50,2023-01-20T00:00:00Z,2023-01-25T21:49:03.555796Z,2023-02-15T00:00:00Z,1,automatic,,,0,1,1,,5,OopX1ANphEu7Lm4-0tVtl5cAFRGQ,"{""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.",{},"{""4e3c8841-560c-436e-ba06-cc7731680d59"":{""isChecked"":false,""title"":""Communicate with customer"",""orderHint"":""8585269209601773376"",""lastModifiedDateTime"":""2023-01-25T22:32:05.3002431Z"",""lastModifiedBy"":{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""}}}}"
150
+ ```
151
+
152
+ === "Markdown"
153
+
154
+ ```md
155
+ # planner task get --id "OopX1ANphEu7Lm4-0tVtl5cAFRGQ"
156
+
157
+ Date: 25/1/2023
158
+
159
+ ## Important task (OopX1ANphEu7Lm4-0tVtl5cAFRGQ)
160
+
161
+ Property | Value
162
+ ---------|-------
163
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
164
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
165
+ title | Important task
166
+ orderHint | 8585269235419217847
167
+ assigneePriority |
168
+ percentComplete | 50
169
+ startDateTime | 2023-01-20T00:00:00Z
170
+ createdDateTime | 2023-01-25T21:49:03.555796Z
171
+ dueDateTime | 2023-02-15T00:00:00Z
172
+ hasDescription | true
173
+ previewType | automatic
174
+ completedDateTime | null
175
+ completedBy | null
176
+ referenceCount | 0
177
+ checklistItemCount | 1
178
+ activeChecklistItemCount | 1
179
+ conversationThreadId | null
180
+ priority | 5
181
+ id | OopX1ANphEu7Lm4-0tVtl5cAFRGQ
182
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
183
+ appliedCategories | {}
184
+ assignments | {}
185
+ description | Lorem ipsum dolor sit amet, consectetur adipiscing elit.
186
+ references | {}
187
+ checklist | {"4e3c8841-560c-436e-ba06-cc7731680d59":{"isChecked":false,"title":"Communicate with customer","orderHint":"8585269209601773376","lastModifiedDateTime":"2023-01-25T22:32:05.3002431Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}}
188
+ ```
@@ -72,3 +72,95 @@ List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My
72
72
  ```sh
73
73
  m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
74
74
  ```
75
+
76
+ ## Response
77
+
78
+ === "JSON"
79
+
80
+ ```json
81
+ [
82
+ {
83
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
84
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
85
+ "title": "Important task",
86
+ "orderHint": "8585269235419217847",
87
+ "assigneePriority": "",
88
+ "percentComplete": 50,
89
+ "startDateTime": "2023-01-20T00:00:00Z",
90
+ "createdDateTime": "2023-01-25T21:49:03.555796Z",
91
+ "dueDateTime": "2023-02-15T00:00:00Z",
92
+ "hasDescription": true,
93
+ "previewType": "automatic",
94
+ "completedDateTime": null,
95
+ "completedBy": null,
96
+ "referenceCount": 0,
97
+ "checklistItemCount": 1,
98
+ "activeChecklistItemCount": 1,
99
+ "conversationThreadId": null,
100
+ "priority": 5,
101
+ "id": "OopX1ANphEu7Lm4-0tVtl5cAFRGQ",
102
+ "createdBy": {
103
+ "user": {
104
+ "displayName": null,
105
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
106
+ },
107
+ "application": {
108
+ "displayName": null,
109
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
110
+ }
111
+ },
112
+ "appliedCategories": {},
113
+ "assignments": {}
114
+ }
115
+ ]
116
+ ```
117
+
118
+ === "Text"
119
+
120
+ ```txt
121
+ id title startDateTime dueDateTime completedDateTime
122
+ ---------------------------- -------------- -------------------- -------------------- -----------------
123
+ OopX1ANphEu7Lm4-0tVtl5cAFRGQ Important task 2023-01-20T00:00:00Z 2023-02-15T00:00:00Z null
124
+ ```
125
+
126
+ === "CSV"
127
+
128
+ ```csv
129
+ id,title,startDateTime,dueDateTime,completedDateTime
130
+ OopX1ANphEu7Lm4-0tVtl5cAFRGQ,Important task,2023-01-20T00:00:00Z,2023-02-15T00:00:00Z,
131
+ ```
132
+
133
+ === "Markdown"
134
+
135
+ ```md
136
+ # planner task list --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b" --bucketName "To do"
137
+
138
+ Date: 25/1/2023
139
+
140
+ ## Important task (OopX1ANphEu7Lm4-0tVtl5cAFRGQ)
141
+
142
+ Property | Value
143
+ ---------|-------
144
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
145
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
146
+ title | Important task
147
+ orderHint | 8585269235419217847
148
+ assigneePriority |
149
+ percentComplete | 50
150
+ startDateTime | 2023-01-20T00:00:00Z
151
+ createdDateTime | 2023-01-25T21:49:03.555796Z
152
+ dueDateTime | 2023-02-15T00:00:00Z
153
+ hasDescription | true
154
+ previewType | automatic
155
+ completedDateTime | null
156
+ completedBy | null
157
+ referenceCount | 0
158
+ checklistItemCount | 1
159
+ activeChecklistItemCount | 1
160
+ conversationThreadId | null
161
+ priority | 5
162
+ id | OopX1ANphEu7Lm4-0tVtl5cAFRGQ
163
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
164
+ appliedCategories | {}
165
+ assignments | {}
166
+ ```
@@ -43,3 +43,49 @@ Add a new reference with the url _https://www.microsoft.com_ and with the type E
43
43
  ```sh
44
44
  m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
45
45
  ```
46
+
47
+ ## Response
48
+
49
+ === "JSON"
50
+
51
+ ```json
52
+ {
53
+ "https%3A//microsoft%2Ecom": {
54
+ "alias": null,
55
+ "type": null,
56
+ "previewPriority": "8585269190192498871PB",
57
+ "lastModifiedDateTime": "2023-01-25T23:05:26.24332Z",
58
+ "lastModifiedBy": {
59
+ "user": {
60
+ "displayName": null,
61
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
62
+ }
63
+ }
64
+ }
65
+ }
66
+ ```
67
+
68
+ === "Text"
69
+
70
+ ```txt
71
+ https%3A//microsoft%2Ecom: {"alias":null,"type":null,"previewPriority":"8585269190192498871PB","lastModifiedDateTime":"2023-01-25T23:05:26.24332Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
72
+ ```
73
+
74
+ === "CSV"
75
+
76
+ ```csv
77
+ https%3A//microsoft%2Ecom
78
+ "{""alias"":null,""type"":null,""previewPriority"":""8585269190192498871PB"",""lastModifiedDateTime"":""2023-01-25T23:05:26.24332Z"",""lastModifiedBy"":{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""}}}"
79
+ ```
80
+
81
+ === "Markdown"
82
+
83
+ ```md
84
+ # planner task reference add --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ" --url "https://microsoft.com"
85
+
86
+ Date: 4/2/2023
87
+
88
+ Property | Value
89
+ ---------|-------
90
+ https%3A//microsoft%2Ecom | {"alias":null,"type":null,"previewPriority":"8585269190192498871PB;","lastModifiedDateTime":"2023-01-25T23:05:26.24332Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
91
+ ```
@@ -22,3 +22,49 @@ Retrieve the references of the specified planner task
22
22
  ```sh
23
23
  m365 planner task reference list --taskId uBk5fK_MHkeyuPYlCo4OFpcAM
24
24
  ```
25
+
26
+ ## Response
27
+
28
+ === "JSON"
29
+
30
+ ```json
31
+ {
32
+ "https%3A//microsoft%2Ecom": {
33
+ "alias": null,
34
+ "type": null,
35
+ "previewPriority": "8585269191724168649Pp",
36
+ "lastModifiedDateTime": "2023-01-25T23:02:53.107589Z",
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
+ https%3A//microsoft%2Ecom: {"alias":null,"type":null,"previewPriority":"8585269191724168649Pp","lastModifiedDateTime":"2023-01-25T23:02:53.107589Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
51
+ ```
52
+
53
+ === "CSV"
54
+
55
+ ```csv
56
+ https%3A//microsoft%2Ecom
57
+ "{""alias"":null,""type"":null,""previewPriority"":""8585269191724168649Pp"",""lastModifiedDateTime"":""2023-01-25T23:02:53.107589Z"",""lastModifiedBy"":{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""}}}"
58
+ ```
59
+
60
+ === "Markdown"
61
+
62
+ ```md
63
+ # planner task reference list --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ"
64
+
65
+ Date: 4/2/2023
66
+
67
+ Property | Value
68
+ ---------|-------
69
+ https%3A//microsoft%2Ecom | {"alias":null,"type":null,"previewPriority":"8585269191724168649Pp;","lastModifiedDateTime":"2023-01-25T23:02:53.107589Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
70
+ ```
@@ -37,3 +37,7 @@ Removes a reference with the alias _Parker_ from the Planner task with the id _2
37
37
  ```sh
38
38
  m365 planner task reference remove --alias "Parker" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.
@@ -76,3 +76,7 @@ Removes the Microsoft Planner task with title _My Task_ in the bucket with name
76
76
  ```sh
77
77
  m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupId "00000000-0000-0000-0000-000000000000"
78
78
  ```
79
+
80
+ ## Response
81
+
82
+ The command won't return a response on success.
@@ -103,6 +103,236 @@ Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50%
103
103
  m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
104
104
  ```
105
105
 
106
+ ## Response
107
+
108
+ ### Standard response
109
+
110
+ === "JSON"
111
+
112
+ ```json
113
+ {
114
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
115
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
116
+ "title": "Important task",
117
+ "orderHint": "8585269241124027581",
118
+ "assigneePriority": "",
119
+ "percentComplete": 50,
120
+ "startDateTime": "2023-01-20T00:00:00Z",
121
+ "createdDateTime": "2023-01-25T21:39:33.0748226Z",
122
+ "dueDateTime": "2023-02-15T00:00:00Z",
123
+ "hasDescription": false,
124
+ "previewType": "automatic",
125
+ "completedDateTime": null,
126
+ "completedBy": null,
127
+ "referenceCount": 0,
128
+ "checklistItemCount": 0,
129
+ "activeChecklistItemCount": 0,
130
+ "conversationThreadId": null,
131
+ "priority": 5,
132
+ "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
133
+ "createdBy": {
134
+ "user": {
135
+ "displayName": null,
136
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
137
+ },
138
+ "application": {
139
+ "displayName": null,
140
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
141
+ }
142
+ },
143
+ "appliedCategories": {},
144
+ "assignments": {}
145
+ }
146
+ ```
147
+
148
+ === "Text"
149
+
150
+ ```text
151
+ activeChecklistItemCount: 0
152
+ appliedCategories : {}
153
+ assigneePriority :
154
+ assignments : {}
155
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
156
+ checklistItemCount : 0
157
+ completedBy : null
158
+ completedDateTime : null
159
+ conversationThreadId : null
160
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
161
+ createdDateTime : 2023-01-25T21:44:10.6044385Z
162
+ dueDateTime : 2023-02-15T00:00:00Z
163
+ hasDescription : false
164
+ id : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
165
+ orderHint : 8585269238348731422
166
+ percentComplete : 50
167
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
168
+ previewType : automatic
169
+ priority : 5
170
+ referenceCount : 0
171
+ references : {}
172
+ startDateTime : 2023-01-20T00:00:00Z
173
+ title : Important task
174
+ ```
175
+
176
+ === "CSV"
177
+
178
+ ```csv
179
+ planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments
180
+ 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""}}",{},{}
181
+ ```
182
+
183
+ === "Markdown"
184
+
185
+ ```md
186
+ # planner task set --id "D-ys8Ef4kEuwYG4r68Um3pcAAe9M" --startDateTime "2023-01-20" --dueDateTime "2023-02-15" --percentComplete "50" --title "Important task"
187
+
188
+ Date: 25/1/2023
189
+
190
+ ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
191
+
192
+ Property | Value
193
+ ---------|-------
194
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
195
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
196
+ title | Important task
197
+ orderHint | 8585269235419217847
198
+ assigneePriority |
199
+ percentComplete | 50
200
+ startDateTime | 2023-01-20T00:00:00Z
201
+ createdDateTime | 2023-01-25T21:49:03.555796Z
202
+ dueDateTime | 2023-02-15T00:00:00Z
203
+ hasDescription | false
204
+ previewType | automatic
205
+ completedDateTime | null
206
+ completedBy | null
207
+ referenceCount | 0
208
+ checklistItemCount | 0
209
+ activeChecklistItemCount | 0
210
+ conversationThreadId | null
211
+ priority | 5
212
+ id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
213
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
214
+ appliedCategories | {}
215
+ assignments | {}
216
+ ```
217
+
218
+ ### `description`, `previewType` response
219
+
220
+ === "JSON"
221
+
222
+ ```json
223
+ {
224
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
225
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
226
+ "title": "Important task",
227
+ "orderHint": "8585269241124027581",
228
+ "assigneePriority": "",
229
+ "percentComplete": 50,
230
+ "startDateTime": "2023-01-20T00:00:00Z",
231
+ "createdDateTime": "2023-01-25T21:39:33.0748226Z",
232
+ "dueDateTime": "2023-02-15T00:00:00Z",
233
+ "hasDescription": true,
234
+ "previewType": "automatic",
235
+ "completedDateTime": null,
236
+ "completedBy": null,
237
+ "referenceCount": 0,
238
+ "checklistItemCount": 0,
239
+ "activeChecklistItemCount": 0,
240
+ "conversationThreadId": null,
241
+ "priority": 5,
242
+ "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
243
+ "createdBy": {
244
+ "user": {
245
+ "displayName": null,
246
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
247
+ },
248
+ "application": {
249
+ "displayName": null,
250
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
251
+ }
252
+ },
253
+ "appliedCategories": {},
254
+ "assignments": {},
255
+ "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
256
+ "references": {},
257
+ "checklist": {}
258
+ }
259
+ ```
260
+
261
+ === "Text"
262
+
263
+ ```txt
264
+ activeChecklistItemCount: 0
265
+ appliedCategories : {}
266
+ assigneePriority :
267
+ assignments : {}
268
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
269
+ checklist : {}
270
+ checklistItemCount : 0
271
+ completedBy : null
272
+ completedDateTime : null
273
+ conversationThreadId : null
274
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
275
+ createdDateTime : 2023-01-25T21:44:10.6044385Z
276
+ description : Lorem ipsum dolor sit amet, consectetur adipiscing elit.
277
+ dueDateTime : 2023-02-15T00:00:00Z
278
+ hasDescription : true
279
+ id : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
280
+ orderHint : 8585269238348731422
281
+ percentComplete : 50
282
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
283
+ previewType : automatic
284
+ priority : 5
285
+ referenceCount : 0
286
+ references : {}
287
+ startDateTime : 2023-01-20T00:00:00Z
288
+ title : Important task
289
+ ```
290
+
291
+ === "CSV"
292
+
293
+ ```csv
294
+ 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
295
+ 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.",{},{}
296
+ ```
297
+
298
+ === "Markdown"
299
+
300
+ ```md
301
+ # planner task set --id "D-ys8Ef4kEuwYG4r68Um3pcAAe9M" --title "Important task" --description "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
302
+
303
+ Date: 25/1/2023
304
+
305
+ ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
306
+
307
+ Property | Value
308
+ ---------|-------
309
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
310
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
311
+ title | Important task
312
+ orderHint | 8585269235419217847
313
+ assigneePriority |
314
+ percentComplete | 50
315
+ startDateTime | 2023-01-20T00:00:00Z
316
+ createdDateTime | 2023-01-25T21:49:03.555796Z
317
+ dueDateTime | 2023-02-15T00:00:00Z
318
+ hasDescription | true
319
+ previewType | automatic
320
+ completedDateTime | null
321
+ completedBy | null
322
+ referenceCount | 0
323
+ checklistItemCount | 0
324
+ activeChecklistItemCount | 0
325
+ conversationThreadId | null
326
+ priority | 5
327
+ id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
328
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
329
+ appliedCategories | {}
330
+ assignments | {}
331
+ description | Lorem ipsum dolor sit amet, consectetur adipiscing elit.
332
+ references | {}
333
+ checklist | {}
334
+ ```
335
+
106
336
  ## Additional information
107
337
 
108
338
  - Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
@@ -26,3 +26,58 @@ Lists the Microsoft Planner settings of the tenant
26
26
  ```sh
27
27
  m365 planner tenant settings list
28
28
  ```
29
+
30
+ ## Response
31
+
32
+ === "JSON"
33
+
34
+ ```json
35
+ {
36
+ "id": "1",
37
+ "isPlannerAllowed": true,
38
+ "allowCalendarSharing": true,
39
+ "allowTenantMoveWithDataLoss": false,
40
+ "allowTenantMoveWithDataMigration": false,
41
+ "allowRosterCreation": true,
42
+ "allowPlannerMobilePushNotifications": true
43
+ }
44
+ ```
45
+
46
+ === "Text"
47
+
48
+ ```txt
49
+ allowCalendarSharing : true
50
+ allowPlannerMobilePushNotifications: true
51
+ allowRosterCreation : true
52
+ allowTenantMoveWithDataLoss : false
53
+ allowTenantMoveWithDataMigration : false
54
+ isPlannerAllowed : true
55
+ ```
56
+
57
+ === "CSV"
58
+
59
+ ```csv
60
+ isPlannerAllowed,allowCalendarSharing,allowTenantMoveWithDataLoss,allowTenantMoveWithDataMigration,allowRosterCreation,allowPlannerMobilePushNotifications
61
+ 1,1,,,1,1
62
+ ```
63
+
64
+ === "Markdown"
65
+
66
+ ```md
67
+ # planner tenant settings list
68
+
69
+ Date: 4/2/2023
70
+
71
+ ## 1
72
+
73
+ Property | Value
74
+ ---------|-------
75
+ id | 1
76
+ isPlannerAllowed | true
77
+ allowCalendarSharing | true
78
+ allowTenantMoveWithDataLoss | false
79
+ allowTenantMoveWithDataMigration | false
80
+ allowRosterCreation | true
81
+ allowPlannerMobilePushNotifications | true
82
+ disallowedSharedWithContainerTypes | []
83
+ ```