@pnp/cli-microsoft365 6.3.0 → 6.4.0-beta.140530d

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 (212) hide show
  1. package/.devcontainer/Dockerfile +5 -2
  2. package/.eslintrc.js +4 -0
  3. package/Dockerfile +6 -3
  4. package/README.md +12 -1
  5. package/dist/Auth.js +1 -3
  6. package/dist/Command.js +1 -0
  7. package/dist/m365/aad/commands/user/user-get.js +3 -0
  8. package/dist/m365/aad/commands/user/user-license-remove.js +2 -1
  9. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +2 -9
  10. package/dist/m365/aad/commands/user/user-set.js +3 -0
  11. package/dist/m365/aad/commands/user/user-signin-list.js +3 -0
  12. package/dist/m365/file/commands/file-list.js +5 -1
  13. package/dist/m365/flow/commands/flow-disable.js +9 -2
  14. package/dist/m365/flow/commands/flow-enable.js +9 -2
  15. package/dist/m365/flow/commands/flow-get.js +9 -2
  16. package/dist/m365/flow/commands/flow-list.js +1 -1
  17. package/dist/m365/flow/commands/flow-remove.js +2 -2
  18. package/dist/m365/flow/commands/owner/owner-ensure.js +147 -0
  19. package/dist/m365/flow/commands/owner/owner-list.js +89 -0
  20. package/dist/m365/flow/commands/owner/owner-remove.js +147 -0
  21. package/dist/m365/flow/commands/run/run-cancel.js +9 -2
  22. package/dist/m365/flow/commands/run/run-list.js +5 -2
  23. package/dist/m365/flow/commands.js +3 -0
  24. package/dist/m365/planner/commands/roster/roster-member-add.js +3 -0
  25. package/dist/m365/planner/commands/roster/roster-member-get.js +98 -0
  26. package/dist/m365/planner/commands.js +1 -0
  27. package/dist/m365/purview/commands/retentionevent/retentionevent-add.js +138 -0
  28. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +48 -14
  29. package/dist/m365/purview/commands.js +1 -0
  30. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.17.0-beta.1.js +59 -0
  31. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  32. package/dist/m365/spfx/commands/spfx-doctor.js +43 -29
  33. package/dist/m365/spo/commands/commandset/commandset-add.js +138 -0
  34. package/dist/m365/spo/commands/commandset/commandset-get.js +128 -0
  35. package/dist/m365/spo/commands/commandset/commandset-list.js +77 -0
  36. package/dist/m365/spo/commands/commandset/commandset-remove.js +146 -0
  37. package/dist/m365/spo/commands/commandset/commandset-set.js +182 -0
  38. package/dist/m365/spo/commands/customaction/customaction-get.js +27 -7
  39. package/dist/m365/spo/commands/file/file-move.js +1 -1
  40. package/dist/m365/spo/commands/group/group-member-add.js +54 -95
  41. package/dist/m365/spo/commands/list/list-add.js +11 -8
  42. package/dist/m365/spo/commands/list/list-set.js +3 -3
  43. package/dist/m365/spo/commands/navigation/navigation-node-add.js +5 -4
  44. package/dist/m365/spo/commands/navigation/navigation-node-set.js +5 -1
  45. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +118 -0
  46. package/dist/m365/spo/commands/term/term-get.js +68 -48
  47. package/dist/m365/spo/commands/user/user-ensure.js +105 -0
  48. package/dist/m365/spo/commands.js +7 -0
  49. package/dist/m365/todo/commands/task/task-add.js +35 -3
  50. package/dist/utils/aadGroup.js +18 -0
  51. package/dist/utils/aadUser.js +37 -0
  52. package/dist/utils/md.js +7 -0
  53. package/dist/utils/spo.js +32 -0
  54. package/docs/docs/cmd/aad/app/app-add.md +3 -3
  55. package/docs/docs/cmd/aad/approleassignment/approleassignment-add.md +5 -5
  56. package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +3 -3
  57. package/docs/docs/cmd/aad/user/user-remove.md +1 -1
  58. package/docs/docs/cmd/cli/completion/completion-clink-update.md +4 -4
  59. package/docs/docs/cmd/flow/owner/owner-ensure.md +61 -0
  60. package/docs/docs/cmd/flow/owner/owner-list.md +90 -0
  61. package/docs/docs/cmd/flow/owner/owner-remove.md +67 -0
  62. package/docs/docs/cmd/flow/run/run-list.md +28 -0
  63. package/docs/docs/cmd/onenote/page/page-list.md +1 -1
  64. package/docs/docs/cmd/outlook/mail/mail-send.md +7 -3
  65. package/docs/docs/cmd/outlook/message/message-get.md +143 -0
  66. package/docs/docs/cmd/outlook/message/message-list.md +119 -0
  67. package/docs/docs/cmd/outlook/message/message-move.md +4 -0
  68. package/docs/docs/cmd/outlook/report/report-mailactivitycounts.md +40 -0
  69. package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.md +40 -0
  70. package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.md +45 -0
  71. package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.md +43 -0
  72. package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.md +44 -0
  73. package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.md +48 -0
  74. package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.md +41 -0
  75. package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.md +49 -0
  76. package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.md +37 -0
  77. package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.md +40 -0
  78. package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.md +36 -0
  79. package/docs/docs/cmd/outlook/room/room-list.md +81 -0
  80. package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +58 -0
  81. package/docs/docs/cmd/planner/plan/plan-add.md +3 -3
  82. package/docs/docs/cmd/planner/plan/plan-set.md +73 -7
  83. package/docs/docs/cmd/planner/roster/roster-add.md +16 -1
  84. package/docs/docs/cmd/planner/roster/roster-member-get.md +87 -0
  85. package/docs/docs/cmd/planner/task/task-add.md +230 -0
  86. package/docs/docs/cmd/planner/task/task-checklistitem-add.md +55 -0
  87. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +55 -0
  88. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +4 -0
  89. package/docs/docs/cmd/planner/task/task-get.md +131 -0
  90. package/docs/docs/cmd/planner/task/task-list.md +92 -0
  91. package/docs/docs/cmd/planner/task/task-reference-add.md +46 -0
  92. package/docs/docs/cmd/planner/task/task-reference-list.md +46 -0
  93. package/docs/docs/cmd/planner/task/task-reference-remove.md +4 -0
  94. package/docs/docs/cmd/planner/task/task-remove.md +4 -0
  95. package/docs/docs/cmd/planner/task/task-set.md +230 -0
  96. package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +55 -0
  97. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +55 -0
  98. package/docs/docs/cmd/pp/card/card-get.md +2 -2
  99. package/docs/docs/cmd/pp/card/card-list.md +2 -2
  100. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +149 -0
  101. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +7 -7
  102. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -0
  103. package/docs/docs/cmd/skype/report/report-activitycounts.md +38 -0
  104. package/docs/docs/cmd/skype/report/report-activityusercounts.md +38 -0
  105. package/docs/docs/cmd/skype/report/report-activityuserdetail.md +67 -0
  106. package/docs/docs/cmd/spfx/project/project-doctor.md +3 -3
  107. package/docs/docs/cmd/spfx/project/project-externalize.md +3 -3
  108. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +21 -0
  109. package/docs/docs/cmd/spfx/project/project-upgrade.md +3 -3
  110. package/docs/docs/cmd/spfx/spfx-doctor.md +3 -3
  111. package/docs/docs/cmd/spo/cdn/cdn-get.md +6 -6
  112. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +3 -3
  113. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +3 -3
  114. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +3 -3
  115. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +3 -3
  116. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +3 -3
  117. package/docs/docs/cmd/spo/cdn/cdn-set.md +3 -3
  118. package/docs/docs/cmd/spo/commandset/commandset-add.md +159 -0
  119. package/docs/docs/cmd/spo/commandset/commandset-get.md +149 -0
  120. package/docs/docs/cmd/spo/commandset/commandset-list.md +109 -0
  121. package/docs/docs/cmd/spo/commandset/commandset-remove.md +55 -0
  122. package/docs/docs/cmd/spo/commandset/commandset-set.md +71 -0
  123. package/docs/docs/cmd/spo/customaction/customaction-get.md +113 -11
  124. package/docs/docs/cmd/spo/externaluser/externaluser-list.md +2 -0
  125. package/docs/docs/cmd/spo/group/group-member-add.md +26 -4
  126. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.md +2 -0
  127. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md +2 -0
  128. package/docs/docs/cmd/spo/homesite/homesite-remove.md +2 -0
  129. package/docs/docs/cmd/spo/homesite/homesite-set.md +2 -0
  130. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +2 -0
  131. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +2 -0
  132. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +3 -3
  133. package/docs/docs/cmd/spo/list/list-add.md +2 -2
  134. package/docs/docs/cmd/spo/list/list-set.md +2 -2
  135. package/docs/docs/cmd/spo/listitem/listitem-add.md +1 -1
  136. package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +1 -1
  137. package/docs/docs/cmd/spo/listitem/listitem-set.md +1 -1
  138. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +3 -3
  139. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +2 -2
  140. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +2 -0
  141. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +2 -0
  142. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +2 -0
  143. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +2 -0
  144. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +2 -0
  145. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +3 -3
  146. package/docs/docs/cmd/spo/site/site-appcatalog-add.md +2 -0
  147. package/docs/docs/cmd/spo/site/site-appcatalog-remove.md +3 -3
  148. package/docs/docs/cmd/spo/site/site-commsite-enable.md +2 -0
  149. package/docs/docs/cmd/spo/site/site-list.md +3 -3
  150. package/docs/docs/cmd/spo/site/site-remove.md +3 -3
  151. package/docs/docs/cmd/spo/site/site-rename.md +3 -3
  152. package/docs/docs/cmd/spo/site/site-set.md +5 -5
  153. package/docs/docs/cmd/spo/storageentity/storageentity-remove.md +3 -3
  154. package/docs/docs/cmd/spo/storageentity/storageentity-set.md +3 -3
  155. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.md +3 -3
  156. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.md +2 -0
  157. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +3 -3
  158. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.md +142 -0
  159. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.md +2 -0
  160. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.md +3 -3
  161. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md +3 -3
  162. package/docs/docs/cmd/spo/tenant/tenant-settings-list.md +2 -0
  163. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +28 -26
  164. package/docs/docs/cmd/spo/term/term-add.md +3 -3
  165. package/docs/docs/cmd/spo/term/term-get.md +3 -3
  166. package/docs/docs/cmd/spo/term/term-group-add.md +2 -0
  167. package/docs/docs/cmd/spo/term/term-group-get.md +2 -0
  168. package/docs/docs/cmd/spo/term/term-group-list.md +2 -0
  169. package/docs/docs/cmd/spo/term/term-list.md +3 -1
  170. package/docs/docs/cmd/spo/term/term-set-add.md +3 -3
  171. package/docs/docs/cmd/spo/term/term-set-get.md +2 -0
  172. package/docs/docs/cmd/spo/term/term-set-list.md +2 -0
  173. package/docs/docs/cmd/spo/theme/theme-apply.md +3 -3
  174. package/docs/docs/cmd/spo/theme/theme-get.md +2 -0
  175. package/docs/docs/cmd/spo/theme/theme-list.md +2 -0
  176. package/docs/docs/cmd/spo/theme/theme-remove.md +2 -0
  177. package/docs/docs/cmd/spo/theme/theme-set.md +3 -3
  178. package/docs/docs/cmd/spo/user/user-ensure.md +109 -0
  179. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  180. package/docs/docs/cmd/teams/channel/channel-member-add.md +2 -2
  181. package/docs/docs/cmd/teams/message/message-get.md +39 -4
  182. package/docs/docs/cmd/teams/message/message-list.md +41 -6
  183. package/docs/docs/cmd/teams/message/message-reply-list.md +39 -4
  184. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +20 -2
  185. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +8 -8
  186. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +12 -5
  187. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +13 -6
  188. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +14 -7
  189. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +13 -6
  190. package/docs/docs/cmd/teams/report/report-pstncalls.md +13 -6
  191. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +13 -6
  192. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +13 -6
  193. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +13 -6
  194. package/docs/docs/cmd/teams/tab/tab-add.md +16 -0
  195. package/docs/docs/cmd/teams/tab/tab-get.md +17 -0
  196. package/docs/docs/cmd/teams/tab/tab-list.md +19 -0
  197. package/docs/docs/cmd/teams/team/team-add.md +77 -8
  198. package/docs/docs/cmd/teams/team/team-app-list.md +18 -2
  199. package/docs/docs/cmd/teams/team/team-archive.md +2 -2
  200. package/docs/docs/cmd/teams/team/team-clone.md +8 -8
  201. package/docs/docs/cmd/teams/team/team-get.md +34 -4
  202. package/docs/docs/cmd/teams/team/team-list.md +34 -3
  203. package/docs/docs/cmd/teams/team/team-remove.md +3 -3
  204. package/docs/docs/cmd/teams/team/team-set.md +8 -8
  205. package/docs/docs/cmd/teams/team/team-unarchive.md +3 -2
  206. package/docs/docs/cmd/teams/user/user-app-add.md +3 -3
  207. package/docs/docs/cmd/teams/user/user-app-list.md +18 -2
  208. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -4
  209. package/docs/docs/cmd/teams/user/user-list.md +21 -4
  210. package/docs/docs/cmd/todo/task/task-add.md +47 -2
  211. package/npm-shrinkwrap.json +279 -194
  212. package/package.json +15 -14
@@ -37,6 +37,12 @@ m365 purview retentionlabel add [options]
37
37
  `--labelToBeApplied [labelToBeApplied]`
38
38
  : Specifies the replacement label to be applied automatically after the retention period of the current label ends.
39
39
 
40
+ `--eventTypeId [eventTypeId]`
41
+ : The Id of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
42
+
43
+ `--eventTypeName [eventTypeName]`
44
+ : The display name of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
45
+
40
46
  --8<-- "docs/cmd/_global.md"
41
47
 
42
48
  ## Examples
@@ -53,6 +59,12 @@ Create a retention label that retains documents as records and does not take any
53
59
  m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod none --retentionDuration 365 --retentionTrigger dateModified
54
60
  ```
55
61
 
62
+ Create an event-based retention label that retains documents as records and deletes them one year after a _Contract Expiry_ event date.
63
+
64
+ ```sh
65
+ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365 --retentionTrigger dateOfEvent --eventTypeName "Contract Expiry"
66
+ ```
67
+
56
68
  ## Remarks
57
69
 
58
70
  !!! attention
@@ -37,3 +37,41 @@ Gets the trends on how many users organized and participated in conference sessi
37
37
  ```sh
38
38
  m365 skype report activitycounts --period D7 --output json > "activitycounts.json"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "Report Refresh Date": "2023-01-25",
49
+ "Report Date": "2023-01-19",
50
+ "Report Period": "7",
51
+ "Peer-to-peer": "0",
52
+ "Organized": "0",
53
+ "Participated": "0"
54
+ }
55
+ ]
56
+ ```
57
+
58
+ === "Text"
59
+
60
+ ```txt
61
+ Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
62
+ 2023-01-25,2023-01-19,7,0,0,0
63
+ ```
64
+
65
+ === "CSV"
66
+
67
+ ```csv
68
+ Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
69
+ 2023-01-25,2023-01-19,7,0,0,0
70
+ ```
71
+
72
+ === "Markdown"
73
+
74
+ ```md
75
+ Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
76
+ 2023-01-25,2023-01-19,7,0,0,0
77
+ ```
@@ -37,3 +37,41 @@ Gets the trends on how many unique users organized and participated in conferenc
37
37
  ```sh
38
38
  m365 skype report activityusercounts --period D7 --output json > "activityusercounts.json"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "Report Refresh Date": "2023-01-25",
49
+ "Report Date": "2023-01-19",
50
+ "Report Period": "7",
51
+ "Peer-to-peer": "0",
52
+ "Organized": "0",
53
+ "Participated": "0"
54
+ }
55
+ ]
56
+ ```
57
+
58
+ === "Text"
59
+
60
+ ```txt
61
+ Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
62
+ 2023-01-25,2023-01-19,7,0,0,0
63
+ ```
64
+
65
+ === "CSV"
66
+
67
+ ```csv
68
+ Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
69
+ 2023-01-25,2023-01-19,7,0,0,0
70
+ ```
71
+
72
+ === "Markdown"
73
+
74
+ ```md
75
+ Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
76
+ 2023-01-25,2023-01-19,7,0,0,0
77
+ ```
@@ -46,3 +46,70 @@ Gets details about Skype for Business activity by user for the last week and exp
46
46
  ```sh
47
47
  m365 skype report activityuserdetail --period D7 --output json > "activityuserdetail.json"
48
48
  ```
49
+
50
+ ## Response
51
+
52
+ === "JSON"
53
+
54
+ ```json
55
+ [
56
+ {
57
+ "Report Refresh Date": "2023-01-25",
58
+ "User Principal Name": "john.doe@contoso.com",
59
+ "Is Deleted": "False",
60
+ "Deleted Date": "",
61
+ "Last Activity Date": "2021-03-22",
62
+ "Total Peer-to-peer Session Count": "0",
63
+ "Total Organized Conference Count": "0",
64
+ "Total Participated Conference Count": "0",
65
+ "Peer-to-peer Last Activity Date": "2021-03-22",
66
+ "Organized Conference Last Activity Date": "2021-02-15",
67
+ "Participated Conference Last Activity Date": "2021-02-15",
68
+ "Peer-to-peer IM Count": "0",
69
+ "Peer-to-peer Audio Count": "0",
70
+ "Peer-to-peer Audio Minutes": "0",
71
+ "Peer-to-peer Video Count": "0",
72
+ "Peer-to-peer Video Minutes": "0",
73
+ "Peer-to-peer App Sharing Count": "0",
74
+ "Peer-to-peer File Transfer Count": "0",
75
+ "Organized Conference IM Count": "0",
76
+ "Organized Conference Audio/Video Count": "0",
77
+ "Organized Conference Audio/Video Minutes": "0",
78
+ "Organized Conference App Sharing Count": "0",
79
+ "Organized Conference Web Count": "0",
80
+ "Organized Conference Dial-in/out 3rd Party Count": "0",
81
+ "Organized Conference Dial-in/out Microsoft Count": "0",
82
+ "Organized Conference Dial-in Microsoft Minutes": "0",
83
+ "Organized Conference Dial-out Microsoft Minutes": "0",
84
+ "Participated Conference IM Count": "0",
85
+ "Participated Conference Audio/Video Count": "0",
86
+ "Participated Conference Audio/Video Minutes": "0",
87
+ "Participated Conference App Sharing Count": "0",
88
+ "Participated Conference Web Count": "0",
89
+ "Participated Conference Dial-in/out 3rd Party Count": "0",
90
+ "Assigned Products": "MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN",
91
+ "Report Period": "7"
92
+ }
93
+ ]
94
+ ```
95
+
96
+ === "Text"
97
+
98
+ ```txt
99
+ Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Total Peer-to-peer Session Count,Total Organized Conference Count,Total Participated Conference Count,Peer-to-peer Last Activity Date,Organized Conference Last Activity Date,Participated Conference Last Activity Date,Peer-to-peer IM Count,Peer-to-peer Audio Count,Peer-to-peer Audio Minutes,Peer-to-peer Video Count,Peer-to-peer Video Minutes,Peer-to-peer App Sharing Count,Peer-to-peer File Transfer Count,Organized Conference IM Count,Organized Conference Audio/Video Count,Organized Conference Audio/Video Minutes,Organized Conference App Sharing Count,Organized Conference Web Count,Organized Conference Dial-in/out 3rd Party Count,Organized Conference Dial-in/out Microsoft Count,Organized Conference Dial-in Microsoft Minutes,Organized Conference Dial-out Microsoft Minutes,Participated Conference IM Count,Participated Conference Audio/Video Count,Participated Conference Audio/Video Minutes,Participated Conference App Sharing Count,Participated Conference Web Count,Participated Conference Dial-in/out 3rd Party Count,Assigned Products,Report Period
100
+ 2023-01-25,john.doe@contoso.com,False,,2021-03-22,0,0,0,2021-03-22,2021-02-15,2021-02-15,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN,7
101
+ ```
102
+
103
+ === "CSV"
104
+
105
+ ```csv
106
+ Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Total Peer-to-peer Session Count,Total Organized Conference Count,Total Participated Conference Count,Peer-to-peer Last Activity Date,Organized Conference Last Activity Date,Participated Conference Last Activity Date,Peer-to-peer IM Count,Peer-to-peer Audio Count,Peer-to-peer Audio Minutes,Peer-to-peer Video Count,Peer-to-peer Video Minutes,Peer-to-peer App Sharing Count,Peer-to-peer File Transfer Count,Organized Conference IM Count,Organized Conference Audio/Video Count,Organized Conference Audio/Video Minutes,Organized Conference App Sharing Count,Organized Conference Web Count,Organized Conference Dial-in/out 3rd Party Count,Organized Conference Dial-in/out Microsoft Count,Organized Conference Dial-in Microsoft Minutes,Organized Conference Dial-out Microsoft Minutes,Participated Conference IM Count,Participated Conference Audio/Video Count,Participated Conference Audio/Video Minutes,Participated Conference App Sharing Count,Participated Conference Web Count,Participated Conference Dial-in/out 3rd Party Count,Assigned Products,Report Period
107
+ 2023-01-25,john.doe@contoso.com,False,,2021-03-22,0,0,0,2021-03-22,2021-02-15,2021-02-15,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN,7
108
+ ```
109
+
110
+ === "Markdown"
111
+
112
+ ```md
113
+ Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Total Peer-to-peer Session Count,Total Organized Conference Count,Total Participated Conference Count,Peer-to-peer Last Activity Date,Organized Conference Last Activity Date,Participated Conference Last Activity Date,Peer-to-peer IM Count,Peer-to-peer Audio Count,Peer-to-peer Audio Minutes,Peer-to-peer Video Count,Peer-to-peer Video Minutes,Peer-to-peer App Sharing Count,Peer-to-peer File Transfer Count,Organized Conference IM Count,Organized Conference Audio/Video Count,Organized Conference Audio/Video Minutes,Organized Conference App Sharing Count,Organized Conference Web Count,Organized Conference Dial-in/out 3rd Party Count,Organized Conference Dial-in/out Microsoft Count,Organized Conference Dial-in Microsoft Minutes,Organized Conference Dial-out Microsoft Minutes,Participated Conference IM Count,Participated Conference Audio/Video Count,Participated Conference Audio/Video Minutes,Participated Conference App Sharing Count,Participated Conference Web Count,Participated Conference Dial-in/out 3rd Party Count,Assigned Products,Report Period
114
+ 2023-01-25,john.doe@contoso.com,False,,2021-03-22,0,0,0,2021-03-22,2021-02-15,2021-02-15,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN,7
115
+ ```
@@ -28,15 +28,15 @@ m365 spfx project doctor [options]
28
28
  `--debug`
29
29
  : Runs command with debug logging
30
30
 
31
- !!! important
32
- Run this command in the folder where the project that you want to validate is located. This command doesn't change your project files.
33
-
34
31
  ## Remarks
35
32
 
36
33
  The `spfx project doctor` command helps you validate that your SharePoint Framework project is set up correctly. The command automatically detects the version of your project using version information specified in the project's .yo-rc.json file or package.json (if no version information is included in .yo-rc.json). Based on the detected project version, the command executes several checks and reports any issues in the specified format.
37
34
 
38
35
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to validate your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
39
36
 
37
+ !!! important
38
+ Run this command in the folder where the project that you want to validate is located. This command doesn't change your project files.
39
+
40
40
  ## Examples
41
41
 
42
42
  Validate if your project is correctly set up and save the findings in a Markdown file
@@ -28,11 +28,11 @@ m365 spfx project externalize [options]
28
28
  `--debug`
29
29
  : Runs command with debug logging
30
30
 
31
- !!! important
32
- Run this command in the folder where the project for which you want to externalize dependencies is located. This command doesn't change your project files.
33
-
34
31
  ## Remarks
35
32
 
33
+ !!! important
34
+ Run this command in the folder where the project for which you want to externalize dependencies is located. This command doesn't change your project files.
35
+
36
36
  !!! attention
37
37
  This command is in preview and could change once it's officially released. If you see any room for improvement, we'd love to hear from you at [https://github.com/pnp/cli-microsoft365/issues](https://github.com/pnp/cli-microsoft365/issues).
38
38
 
@@ -63,3 +63,24 @@ m365 spfx project permissions grant
63
63
  ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
64
64
  6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
65
65
  ```
66
+
67
+ === "Markdown"
68
+
69
+ ```md
70
+ # spfx project permissions grant
71
+
72
+ Date: 2/17/2023
73
+
74
+ ## QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
75
+
76
+ Property | Value
77
+ ---------|-------
78
+ ClientId | 6004a642-185c-479a-992a-15d1c23e2229
79
+ ConsentType | AllPrincipals
80
+ IsDomainIsolated | false
81
+ ObjectId | QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
82
+ PackageName | null
83
+ Resource | Microsoft Graph
84
+ ResourceId | a46b0017-21e2-4db1-bc69-ca63576a38d6
85
+ Scope | Mail.Read
86
+ ```
@@ -27,15 +27,15 @@ m365 spfx project upgrade [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- Run this command in the folder where the project that you want to upgrade is located. This command doesn't change your project files.
32
-
33
30
  ## Remarks
34
31
 
35
32
  The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.1).
36
33
 
37
34
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
38
35
 
36
+ !!! important
37
+ Run this command in the folder where the project that you want to upgrade is located. This command doesn't change your project files.
38
+
39
39
  ## Examples
40
40
 
41
41
  Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and save the findings in a Markdown file
@@ -31,9 +31,6 @@ m365 spfx doctor [options]
31
31
  `--debug`
32
32
  : Runs command with debug logging
33
33
 
34
- !!! important
35
- Checks ran by this command are based on what is officially supported by Microsoft. It's possible that using different package managers or packages versions will work just fine.
36
-
37
34
  ## Remarks
38
35
 
39
36
  This commands helps you to verify if your environment meets all prerequisites for building solutions using a particular version of the SharePoint Framework.
@@ -46,6 +43,9 @@ If you miss any required tools or use a version that doesn't meet the SharePoint
46
43
 
47
44
  Next to verifying the readiness of your environment to use a particular version of the SharePoint Framework, you can also check if the version of the SharePoint Framework that you use is compatible with the specific version of SharePoint. Supported versions are `sp2016`, `sp2019` and `spo`.
48
45
 
46
+ !!! important
47
+ Checks ran by this command are based on what is officially supported by Microsoft. It's possible that using different package managers or packages versions will work just fine.
48
+
49
49
  !!! important
50
50
  This command supports only text output.
51
51
 
@@ -11,26 +11,26 @@ m365 spo cdn get [options]
11
11
  ## Options
12
12
 
13
13
  `-t, --type [type]`
14
- : Type of CDN to manage. `Public,Private`. Default `Public`
14
+ : Type of CDN to manage. Allowed values `Public`, `Private`. Default `Public`.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
- Show if the Public CDN is currently enabled or not
27
+ Show if the Public CDN is currently enabled or not.
28
28
 
29
29
  ```sh
30
30
  m365 spo cdn get
31
31
  ```
32
32
 
33
- Show if the Private CDN is currently enabled or not
33
+ Show if the Private CDN is currently enabled or not.
34
34
 
35
35
  ```sh
36
36
  m365 spo cdn get --type Private
@@ -18,13 +18,13 @@ m365 spo cdn origin add [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
- !!! important
22
- To use this command you have to have permissions to access the tenant admin site.
23
-
24
21
  ## Remarks
25
22
 
26
23
  Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
27
24
 
25
+ !!! important
26
+ To use this command you have to have permissions to access the tenant admin site.
27
+
28
28
  ## Examples
29
29
 
30
30
  Add _*/CDN_ to the list of origins of the Public CDN
@@ -15,13 +15,13 @@ m365 spo cdn origin list [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Show the list of origins configured for the Public CDN
@@ -21,13 +21,13 @@ m365 spo cdn origin remove [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
30
27
 
28
+ !!! important
29
+ To use this command you have to have permissions to access the tenant admin site.
30
+
31
31
  ## Examples
32
32
 
33
33
  Remove _*/CDN_ from the list of origins of the Public CDN
@@ -15,13 +15,13 @@ m365 spo cdn policy list [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  Using the `-t, --cdnType` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Show the list of policies configured for the Public CDN
@@ -21,13 +21,13 @@ m365 spo cdn policy set [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  Using the `-t, --cdnType` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
30
27
 
28
+ !!! important
29
+ To use this command you have to have permissions to access the tenant admin site.
30
+
31
31
  ## Examples
32
32
 
33
33
  Set the list of extensions supported by the Public CDN
@@ -21,9 +21,6 @@ m365 spo cdn set [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default), Private CDN or both. If you don't use the option, the command will use the Public CDN.
@@ -32,6 +29,9 @@ Using the `-e, --enabled` option you can specify whether the given CDN type shou
32
29
 
33
30
  Using the `--noDefaultOrigins` option you can specify to skip the creation of the default origins.
34
31
 
32
+ !!! important
33
+ To use this command you have to have permissions to access the tenant admin site.
34
+
35
35
  ## Examples
36
36
 
37
37
  Enable the Microsoft 365 Public CDN on the current tenant
@@ -0,0 +1,159 @@
1
+ # spo commandset add
2
+
3
+ Add a ListView Command Set to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo commandset add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : The title of the ListView Command Set
15
+
16
+ `-u, --webUrl <webUrl>`
17
+ : The site to add the ListView Command Set.
18
+
19
+ `-l, --listType <listType>`
20
+ : The list or library type to register the Command Set on. Allowed values `List`, `Library` or `SitePages`.
21
+
22
+ `-i, --clientSideComponentId <clientSideComponentId>`
23
+ : The Client Side Component Id (GUID) of the ListView Command Set.
24
+
25
+ `--clientSideComponentProperties [clientSideComponentProperties]`
26
+ : The Client Side Component properties of the ListView Command Set.
27
+
28
+ `-s, --scope [scope]`
29
+ : Scope of the ListView Command Set. Allowed values: `Site`, `Web`. Defaults to `Web`.
30
+
31
+ `--location [location]`
32
+ : The location of the ListView Command Set. Allowed values `ContextMenu`, `CommandBar` or `Both`. Defaults to `CommandBar`.
33
+
34
+ --8<-- "docs/cmd/_global.md"
35
+
36
+ ## Remarks
37
+
38
+ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML, or JavaScript values because the command shell treats quotes differently. For example, this is how a ListView Command Set can be created from the Windows cmd.exe:
39
+
40
+ ```sh
41
+ m365 spo commandset add --webUrl https://contoso.sharepoint.com/sites/test --title "CLI Commandset" --location "ContextMenu" --listType "List" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
42
+ ```
43
+
44
+ Note, how the clientSideComponentProperties option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
45
+
46
+ !!! warning "Escaping JSON in PowerShell"
47
+ When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
48
+
49
+ ## Examples
50
+
51
+ Adds a ListView Command Set to lists on the sales site.
52
+
53
+ ```sh
54
+ m365 spo commandset add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --listType List --webUrl https://contoso.sharepoint.com/sites/sales
55
+ ```
56
+
57
+ Adds a ListView Command Set to lists on the sales site with some properties.
58
+
59
+ ```sh
60
+ m365 spo commandset add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --listType List --webUrl https://contoso.sharepoint.com/sites/sales
61
+ ```
62
+
63
+ ## Response
64
+
65
+ === "JSON"
66
+
67
+ ```json
68
+ {
69
+ "ClientSideComponentId": "b206e130-1a5b-4ae7-86a7-4f91c9924d0a",
70
+ "ClientSideComponentProperties": "",
71
+ "CommandUIExtension": null,
72
+ "Description": null,
73
+ "Group": null,
74
+ "HostProperties": "",
75
+ "Id": "680ccc51-7ddf-4dda-8696-fc606480cc3f",
76
+ "ImageUrl": null,
77
+ "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
78
+ "Name": null,
79
+ "RegistrationId": "100",
80
+ "RegistrationType": 0,
81
+ "Rights": {
82
+ "High": "0",
83
+ "Low": "0"
84
+ },
85
+ "Scope": 2,
86
+ "ScriptBlock": null,
87
+ "ScriptSrc": null,
88
+ "Sequence": 0,
89
+ "Title": "CLI Commandset",
90
+ "Url": null,
91
+ "VersionOfUserCustomAction": "16.0.1.0"
92
+ }
93
+ ```
94
+
95
+ === "Text"
96
+
97
+ ```text
98
+ ClientSideComponentId : b206e130-1a5b-4ae7-86a7-4f91c9924d0a
99
+ ClientSideComponentProperties:
100
+ CommandUIExtension : null
101
+ Description : null
102
+ Group : null
103
+ HostProperties :
104
+ Id : 680ccc51-7ddf-4dda-8696-fc606480cc3f
105
+ ImageUrl : null
106
+ Location : ClientSideExtension.ListViewCommandSet.CommandBar
107
+ Name : null
108
+ RegistrationId : 100
109
+ RegistrationType : 0
110
+ Rights : {"High":"0","Low":"0"}
111
+ Scope : 2
112
+ ScriptBlock : null
113
+ ScriptSrc : null
114
+ Sequence : 0
115
+ Title : CLI Commandset
116
+ Url : null
117
+ VersionOfUserCustomAction : 16.0.1.0
118
+ ```
119
+
120
+ === "CSV"
121
+
122
+ ```csv
123
+ ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
124
+ b206e130-1a5b-4ae7-86a7-4f91c9924d0a,,,,,,680ccc51-7ddf-4dda-8696-fc606480cc3f,,ClientSideExtension.ListViewCommandSet.CommandBar,,100,0,"{""High"":""0"",""Low"":""0""}",2,,,0,CLI Commandset,,16.0.1.0
125
+ ```
126
+
127
+ === "Markdown"
128
+
129
+ ```md
130
+ # spo commandset add --title "CLI Commandset" --webUrl "https://contoso.sharepoint.com" --clientSideComponentId "b206e130-1a5b-4ae7-86a7-4f91c9924d0a" --listType "List" --scope "Site"
131
+
132
+ Date: 10/2/2023
133
+
134
+ ## CLI Commandset (680ccc51-7ddf-4dda-8696-fc606480cc3f)
135
+
136
+ Property | Value
137
+ ---------|-------
138
+ ClientSideComponentId | b206e130-1a5b-4ae7-86a7-4f91c9924d0a
139
+ ClientSideComponentProperties |
140
+ CommandUIExtension | null
141
+ Description | null
142
+ Group | null
143
+ HostProperties |
144
+ Id | 680ccc51-7ddf-4dda-8696-fc606480cc3f
145
+ ImageUrl | null
146
+ Location | ClientSideExtension.ListViewCommandSet.CommandBar
147
+ Name | null
148
+ RegistrationId | 100
149
+ RegistrationType | 0
150
+ Rights | {"High":"0","Low":"0"}
151
+ Scope | 2
152
+ ScriptBlock | null
153
+ ScriptSrc | null
154
+ Sequence | 0
155
+ Title | CLI Commandset
156
+ Url | null
157
+ VersionOfUserCustomAction | 16.0.1.0
158
+ ```
159
+