@pnp/cli-microsoft365 6.0.0-beta.c5b75e1 → 6.0.0-beta.c63e3b2

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 (565) hide show
  1. package/.eslintrc.js +17 -2
  2. package/README.md +5 -0
  3. package/dist/Command.js +16 -2
  4. package/dist/appInsights.js +2 -0
  5. package/dist/cli/Cli.js +7 -10
  6. package/dist/m365/aad/commands/app/app-add.js +40 -17
  7. package/dist/m365/aad/commands/app/app-get.js +3 -2
  8. package/dist/m365/aad/commands/app/app-list.js +38 -0
  9. package/dist/m365/aad/commands/app/app-remove.js +3 -2
  10. package/dist/m365/aad/commands/app/app-role-add.js +3 -2
  11. package/dist/m365/aad/commands/app/app-role-list.js +3 -2
  12. package/dist/m365/aad/commands/app/app-role-remove.js +3 -2
  13. package/dist/m365/aad/commands/app/app-set.js +3 -2
  14. package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +5 -4
  15. package/dist/m365/aad/commands/approleassignment/approleassignment-list.js +3 -2
  16. package/dist/m365/aad/commands/approleassignment/approleassignment-remove.js +5 -4
  17. package/dist/m365/aad/commands/o365group/o365group-conversation-post-list.js +2 -1
  18. package/dist/m365/aad/commands/o365group/o365group-list.js +3 -2
  19. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-list.js +3 -2
  20. package/dist/m365/aad/commands/o365group/o365group-teamify.js +3 -2
  21. package/dist/m365/aad/commands/o365group/o365group-user-add.js +2 -1
  22. package/dist/m365/aad/commands/o365group/o365group-user-remove.js +2 -1
  23. package/dist/m365/aad/commands/oauth2grant/oauth2grant-list.js +2 -1
  24. package/dist/m365/aad/commands/oauth2grant/oauth2grant-remove.js +2 -1
  25. package/dist/m365/aad/commands/oauth2grant/oauth2grant-set.js +2 -1
  26. package/dist/m365/aad/commands/sp/sp-add.js +3 -2
  27. package/dist/m365/aad/commands/sp/sp-get.js +3 -2
  28. package/dist/m365/aad/commands/user/user-get.js +6 -4
  29. package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
  30. package/dist/m365/aad/commands/user/user-hibp.js +2 -1
  31. package/dist/m365/aad/commands/user/user-list.js +2 -1
  32. package/dist/m365/aad/commands/user/user-set.js +2 -1
  33. package/dist/m365/aad/commands/user/user-signin-list.js +5 -4
  34. package/dist/m365/aad/commands.js +2 -0
  35. package/dist/m365/adaptivecard/commands/adaptivecard-send.js +4 -4
  36. package/dist/m365/base/DateAndPeriodBasedReport.js +3 -2
  37. package/dist/m365/base/PeriodBasedReport.js +2 -1
  38. package/dist/m365/base/SpoCommand.js +12 -11
  39. package/dist/m365/booking/commands/business/business-get.js +2 -1
  40. package/dist/m365/cli/commands/config/config-set.js +1 -0
  41. package/dist/m365/commands/login.js +6 -1
  42. package/dist/m365/commands/status.js +6 -1
  43. package/dist/m365/file/commands/file-list.js +2 -1
  44. package/dist/m365/flow/commands/environment/environment-get.js +2 -1
  45. package/dist/m365/flow/commands/flow-disable.js +2 -1
  46. package/dist/m365/flow/commands/flow-enable.js +2 -1
  47. package/dist/m365/flow/commands/flow-export.js +5 -4
  48. package/dist/m365/flow/commands/flow-get.js +2 -1
  49. package/dist/m365/flow/commands/flow-list.js +2 -1
  50. package/dist/m365/flow/commands/flow-remove.js +2 -1
  51. package/dist/m365/flow/commands/run/run-cancel.js +2 -1
  52. package/dist/m365/flow/commands/run/run-get.js +2 -1
  53. package/dist/m365/flow/commands/run/run-list.js +2 -1
  54. package/dist/m365/flow/commands/run/run-resubmit.js +3 -2
  55. package/dist/m365/outlook/commands/mail/mail-send.js +57 -32
  56. package/dist/m365/outlook/commands/message/message-get.js +97 -0
  57. package/dist/m365/outlook/commands/message/message-list.js +2 -1
  58. package/dist/m365/outlook/commands/message/message-move.js +2 -1
  59. package/dist/m365/outlook/commands.js +1 -0
  60. package/dist/m365/pa/commands/app/app-get.js +2 -1
  61. package/dist/m365/pa/commands/app/app-list.js +2 -1
  62. package/dist/m365/pa/commands/app/app-remove.js +2 -1
  63. package/dist/m365/pa/commands/connector/connector-export.js +2 -1
  64. package/dist/m365/pa/commands/connector/connector-list.js +2 -1
  65. package/dist/m365/pa/commands/environment/environment-get.js +2 -1
  66. package/dist/m365/planner/commands/bucket/bucket-get.js +5 -8
  67. package/dist/m365/planner/commands/plan/plan-get.js +11 -31
  68. package/dist/m365/planner/commands/task/task-add.js +1 -1
  69. package/dist/m365/planner/commands/task/task-checklistitem-add.js +3 -2
  70. package/dist/m365/planner/commands/task/task-checklistitem-list.js +2 -1
  71. package/dist/m365/planner/commands/task/task-checklistitem-remove.js +2 -1
  72. package/dist/m365/planner/commands/task/task-get.js +2 -1
  73. package/dist/m365/planner/commands/task/task-list.js +4 -3
  74. package/dist/m365/planner/commands/task/task-reference-add.js +2 -2
  75. package/dist/m365/planner/commands/task/task-reference-list.js +2 -1
  76. package/dist/m365/planner/commands/task/task-reference-remove.js +1 -1
  77. package/dist/m365/planner/commands/task/task-set.js +2 -2
  78. package/dist/m365/pp/commands/Environment.js +3 -0
  79. package/dist/m365/pp/commands/card/card-clone.js +122 -0
  80. package/dist/m365/pp/commands/card/card-get.js +110 -0
  81. package/dist/m365/pp/commands/card/card-list.js +68 -0
  82. package/dist/m365/pp/commands/card/card-remove.js +130 -0
  83. package/dist/m365/pp/commands/dataverse/dataverse-table-get.js +77 -0
  84. package/dist/m365/pp/commands/dataverse/dataverse-table-list.js +69 -0
  85. package/dist/m365/pp/commands/dataverse/dataverse-table-remove.js +95 -0
  86. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  87. package/dist/m365/pp/commands/gateway/gateway-get.js +71 -0
  88. package/dist/m365/pp/commands/managementapp/managementapp-add.js +3 -2
  89. package/dist/m365/pp/commands/solution/Solution.js +3 -0
  90. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  91. package/dist/m365/pp/commands/solution/solution-list.js +81 -0
  92. package/dist/m365/pp/commands/solution/solution-publisher-get.js +107 -0
  93. package/dist/m365/pp/commands/solution/solution-publisher-list.js +78 -0
  94. package/dist/m365/pp/commands/solution/solution-publisher-remove.js +130 -0
  95. package/dist/m365/pp/commands/solution/solution-remove.js +130 -0
  96. package/dist/m365/pp/commands/tenant/tenant-settings-list.js +45 -0
  97. package/dist/m365/pp/commands.js +17 -1
  98. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +3 -2
  99. package/dist/m365/search/commands/externalconnection/externalconnection-remove.js +3 -2
  100. package/dist/m365/spfx/commands/project/project-doctor/{doctor-1.16.0-beta.1.js → doctor-1.16.0.js} +6 -6
  101. package/dist/m365/spfx/commands/project/project-doctor.js +5 -2
  102. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  103. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  104. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  105. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  106. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  107. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  108. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  109. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  110. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  111. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  112. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  113. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.14.0.js +0 -2
  114. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0.js} +44 -28
  115. package/dist/m365/spfx/commands/project/project-upgrade.js +17 -16
  116. package/dist/m365/spfx/commands/spfx-doctor.js +54 -9
  117. package/dist/m365/spo/commands/app/app-get.js +2 -1
  118. package/dist/m365/spo/commands/app/app-install.js +2 -1
  119. package/dist/m365/spo/commands/app/app-remove.js +2 -1
  120. package/dist/m365/spo/commands/app/app-retract.js +2 -1
  121. package/dist/m365/spo/commands/app/app-teamspackage-download.js +2 -1
  122. package/dist/m365/spo/commands/app/app-uninstall.js +2 -1
  123. package/dist/m365/spo/commands/app/app-upgrade.js +2 -1
  124. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  125. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  126. package/dist/m365/spo/commands/contenttype/contenttype-field-set.js +2 -2
  127. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  128. package/dist/m365/spo/commands/contenttype/contenttype-list.js +2 -1
  129. package/dist/m365/spo/commands/contenttype/contenttype-remove.js +3 -2
  130. package/dist/m365/spo/commands/customaction/customaction-get.js +3 -2
  131. package/dist/m365/spo/commands/customaction/customaction-remove.js +3 -2
  132. package/dist/m365/spo/commands/customaction/customaction-set.js +2 -1
  133. package/dist/m365/spo/commands/eventreceiver/EventReceiver.js +3 -0
  134. package/dist/m365/spo/commands/eventreceiver/eventreceiver-get.js +43 -27
  135. package/dist/m365/spo/commands/eventreceiver/eventreceiver-list.js +4 -3
  136. package/dist/m365/spo/commands/eventreceiver/eventreceiver-remove.js +167 -0
  137. package/dist/m365/spo/commands/field/field-add.js +26 -1
  138. package/dist/m365/spo/commands/field/field-set.js +23 -13
  139. package/dist/m365/spo/commands/file/file-add.js +14 -13
  140. package/dist/m365/spo/commands/file/file-checkin.js +4 -3
  141. package/dist/m365/spo/commands/file/file-checkout.js +3 -2
  142. package/dist/m365/spo/commands/file/file-copy.js +27 -40
  143. package/dist/m365/spo/commands/file/file-get.js +3 -2
  144. package/dist/m365/spo/commands/file/file-move.js +26 -38
  145. package/dist/m365/spo/commands/file/file-remove.js +3 -2
  146. package/dist/m365/spo/commands/file/file-rename.js +22 -18
  147. package/dist/m365/spo/commands/file/file-roleassignment-add.js +217 -0
  148. package/dist/m365/spo/commands/file/file-roleassignment-remove.js +180 -0
  149. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +129 -0
  150. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  151. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +1 -1
  152. package/dist/m365/spo/commands/file/file-version-clear.js +114 -0
  153. package/dist/m365/spo/commands/file/file-version-get.js +104 -0
  154. package/dist/m365/spo/commands/file/file-version-list.js +96 -0
  155. package/dist/m365/spo/commands/file/file-version-remove.js +119 -0
  156. package/dist/m365/spo/commands/file/file-version-restore.js +119 -0
  157. package/dist/m365/spo/commands/folder/folder-get.js +3 -2
  158. package/dist/m365/spo/commands/folder/folder-list.js +35 -12
  159. package/dist/m365/spo/commands/folder/folder-remove.js +2 -1
  160. package/dist/m365/spo/commands/folder/folder-roleassignment-add.js +215 -0
  161. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +169 -0
  162. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +104 -0
  163. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +100 -0
  164. package/dist/m365/spo/commands/group/AssociatedGroupPropertiesCollection.js +3 -0
  165. package/dist/m365/spo/commands/group/group-get.js +3 -2
  166. package/dist/m365/spo/commands/group/group-list.js +49 -10
  167. package/dist/m365/spo/commands/group/{group-user-add.js → group-member-add.js} +17 -16
  168. package/dist/m365/spo/commands/group/{group-user-list.js → group-member-list.js} +19 -18
  169. package/dist/m365/spo/commands/group/{group-user-remove.js → group-member-remove.js} +18 -17
  170. package/dist/m365/spo/commands/hubsite/hubsite-connect.js +93 -18
  171. package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +69 -13
  172. package/dist/m365/spo/commands/list/list-contenttype-add.js +21 -18
  173. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +59 -47
  174. package/dist/m365/spo/commands/list/list-contenttype-list.js +16 -8
  175. package/dist/m365/spo/commands/list/list-contenttype-remove.js +16 -8
  176. package/dist/m365/spo/commands/list/list-get.js +1 -1
  177. package/dist/m365/spo/commands/list/list-roleassignment-add.js +14 -32
  178. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +12 -23
  179. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  180. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +14 -6
  181. package/dist/m365/spo/commands/list/list-set.js +31 -8
  182. package/dist/m365/spo/commands/list/list-view-field-add.js +20 -6
  183. package/dist/m365/spo/commands/list/list-view-field-remove.js +19 -5
  184. package/dist/m365/spo/commands/list/list-view-field-set.js +19 -5
  185. package/dist/m365/spo/commands/list/list-view-list.js +14 -10
  186. package/dist/m365/spo/commands/list/list-view-remove.js +17 -8
  187. package/dist/m365/spo/commands/list/list-view-set.js +19 -7
  188. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  189. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -10
  190. package/dist/m365/spo/commands/list/list-webhook-list.js +17 -42
  191. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  192. package/dist/m365/spo/commands/list/list-webhook-set.js +27 -20
  193. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  194. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  195. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  196. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  197. package/dist/m365/spo/commands/listitem/listitem-list.js +24 -17
  198. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  199. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  200. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  201. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  202. package/dist/m365/spo/commands/listitem/listitem-roleassignment-remove.js +12 -23
  203. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  204. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +13 -5
  205. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  206. package/dist/m365/spo/commands/page/Page.js +3 -2
  207. package/dist/m365/spo/commands/page/page-add.js +2 -1
  208. package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +8 -10
  209. package/dist/m365/spo/commands/page/page-control-get.js +2 -1
  210. package/dist/m365/spo/commands/page/page-control-list.js +2 -1
  211. package/dist/m365/spo/commands/page/page-control-set.js +3 -2
  212. package/dist/m365/spo/commands/page/page-get.js +2 -1
  213. package/dist/m365/spo/commands/page/page-header-set.js +6 -5
  214. package/dist/m365/spo/commands/page/page-section-add.js +4 -3
  215. package/dist/m365/spo/commands/page/page-set.js +2 -1
  216. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
  217. package/dist/m365/spo/commands/site/site-add.js +4 -11
  218. package/dist/m365/spo/commands/site/site-apppermission-add.js +3 -2
  219. package/dist/m365/spo/commands/site/site-hubsite-connect.js +76 -0
  220. package/dist/m365/spo/commands/site/site-hubsite-disconnect.js +93 -0
  221. package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
  222. package/dist/m365/spo/commands/site/site-rename.js +2 -1
  223. package/dist/m365/spo/commands/site/site-set.js +1 -1
  224. package/dist/m365/spo/commands/sitedesign/sitedesign-get.js +4 -7
  225. package/dist/m365/spo/commands/sitescript/sitescript-add.js +2 -1
  226. package/dist/m365/spo/commands/spo-search.js +3 -2
  227. package/dist/m365/spo/commands/storageentity/storageentity-get.js +2 -1
  228. package/dist/m365/spo/commands/user/user-get.js +4 -3
  229. package/dist/m365/spo/commands/user/user-remove.js +2 -1
  230. package/dist/m365/spo/commands/userprofile/userprofile-get.js +2 -1
  231. package/dist/m365/spo/commands/web/web-add.js +2 -1
  232. package/dist/m365/spo/commands/web/web-roleassignment-add.js +14 -25
  233. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +12 -16
  234. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  235. package/dist/m365/spo/commands.js +21 -4
  236. package/dist/m365/teams/commands/Meeting.js +3 -0
  237. package/dist/m365/teams/commands/app/app-install.js +3 -2
  238. package/dist/m365/teams/commands/app/app-list.js +2 -1
  239. package/dist/m365/teams/commands/app/app-publish.js +14 -15
  240. package/dist/m365/teams/commands/app/app-update.js +2 -1
  241. package/dist/m365/teams/commands/cache/cache-remove.js +41 -10
  242. package/dist/m365/teams/commands/channel/channel-add.js +9 -9
  243. package/dist/m365/teams/commands/channel/channel-get.js +6 -5
  244. package/dist/m365/teams/commands/channel/channel-member-add.js +4 -3
  245. package/dist/m365/teams/commands/channel/channel-member-list.js +2 -1
  246. package/dist/m365/teams/commands/channel/channel-member-remove.js +2 -1
  247. package/dist/m365/teams/commands/channel/channel-member-set.js +2 -1
  248. package/dist/m365/teams/commands/channel/channel-remove.js +57 -39
  249. package/dist/m365/teams/commands/channel/channel-set.js +58 -19
  250. package/dist/m365/teams/commands/chat/chat-get.js +2 -1
  251. package/dist/m365/teams/commands/chat/chatUtil.js +2 -1
  252. package/dist/m365/teams/commands/funsettings/funsettings-list.js +2 -1
  253. package/dist/m365/teams/commands/funsettings/funsettings-set.js +2 -1
  254. package/dist/m365/teams/commands/guestsettings/guestsettings-list.js +2 -1
  255. package/dist/m365/teams/commands/guestsettings/guestsettings-set.js +2 -1
  256. package/dist/m365/teams/commands/meeting/meeting-list.js +153 -0
  257. package/dist/m365/teams/commands/membersettings/membersettings-list.js +2 -1
  258. package/dist/m365/teams/commands/membersettings/membersettings-set.js +2 -1
  259. package/dist/m365/teams/commands/messagingsettings/messagingsettings-list.js +2 -1
  260. package/dist/m365/teams/commands/messagingsettings/messagingsettings-set.js +2 -1
  261. package/dist/m365/teams/commands/report/report-directroutingcalls.js +3 -2
  262. package/dist/m365/teams/commands/report/report-pstncalls.js +3 -2
  263. package/dist/m365/teams/commands/tab/tab-add.js +2 -1
  264. package/dist/m365/teams/commands/tab/tab-get.js +4 -3
  265. package/dist/m365/teams/commands/tab/tab-list.js +2 -1
  266. package/dist/m365/teams/commands/tab/tab-remove.js +2 -1
  267. package/dist/m365/teams/commands/team/team-archive.js +6 -8
  268. package/dist/m365/teams/commands/team/team-clone.js +2 -1
  269. package/dist/m365/teams/commands/team/team-get.js +2 -1
  270. package/dist/m365/teams/commands/team/team-remove.js +5 -4
  271. package/dist/m365/teams/commands/team/team-set.js +2 -8
  272. package/dist/m365/teams/commands/team/team-unarchive.js +5 -4
  273. package/dist/m365/teams/commands/user/user-app-list.js +3 -2
  274. package/dist/m365/teams/commands.js +1 -0
  275. package/dist/m365/tenant/commands/security/security-alerts-list.js +2 -1
  276. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-get.js +2 -1
  277. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +2 -1
  278. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +2 -1
  279. package/dist/m365/todo/commands/list/list-get.js +89 -0
  280. package/dist/m365/todo/commands/task/task-add.js +55 -3
  281. package/dist/m365/todo/commands/task/task-get.js +108 -0
  282. package/dist/m365/todo/commands/task/task-set.js +55 -2
  283. package/dist/m365/todo/commands.js +2 -0
  284. package/dist/m365/yammer/commands/group/group-list.js +12 -27
  285. package/dist/m365/yammer/commands/user/user-get.js +3 -2
  286. package/dist/m365/yammer/commands/yammer-search.js +6 -2
  287. package/dist/utils/aadGroup.js +2 -1
  288. package/dist/utils/cache.js +81 -0
  289. package/dist/utils/md.js +8 -1
  290. package/dist/utils/pid.js +57 -0
  291. package/dist/utils/powerPlatform.js +43 -0
  292. package/dist/utils/spo.js +3 -2
  293. package/docs/docs/_clisettings.md +18 -0
  294. package/docs/docs/cmd/aad/app/app-add.md +19 -19
  295. package/docs/docs/cmd/aad/app/app-list.md +149 -0
  296. package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
  297. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +12 -5
  298. package/docs/docs/cmd/app/app-get.md +156 -0
  299. package/docs/docs/cmd/app/app-open.md +21 -1
  300. package/docs/docs/cmd/app/permission/permission-list.md +43 -0
  301. package/docs/docs/cmd/booking/business/business-get.md +107 -0
  302. package/docs/docs/cmd/booking/business/business-list.md +34 -0
  303. package/docs/docs/cmd/flow/flow-get.md +1 -1
  304. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
  305. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
  306. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  307. package/docs/docs/cmd/outlook/message/message-get.md +48 -0
  308. package/docs/docs/cmd/pa/app/app-get.md +184 -0
  309. package/docs/docs/cmd/pa/app/app-list.md +181 -0
  310. package/docs/docs/cmd/pa/app/app-remove.md +4 -0
  311. package/docs/docs/cmd/pa/connector/connector-export.md +4 -0
  312. package/docs/docs/cmd/pa/connector/connector-list.md +89 -0
  313. package/docs/docs/cmd/pa/environment/environment-get.md +113 -0
  314. package/docs/docs/cmd/pa/environment/environment-list.md +109 -0
  315. package/docs/docs/cmd/pa/pcf/pcf-init.md +4 -0
  316. package/docs/docs/cmd/pa/solution/solution-init.md +5 -0
  317. package/docs/docs/cmd/pa/solution/solution-reference-add.md +4 -0
  318. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  319. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  320. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  321. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  322. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  323. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  324. package/docs/docs/cmd/planner/plan/plan-get.md +77 -8
  325. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  326. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  327. package/docs/docs/cmd/planner/task/task-get.md +0 -3
  328. package/docs/docs/cmd/pp/card/card-clone.md +77 -0
  329. package/docs/docs/cmd/pp/card/card-get.md +122 -0
  330. package/docs/docs/cmd/pp/card/card-list.md +104 -0
  331. package/docs/docs/cmd/pp/card/card-remove.md +82 -0
  332. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +120 -0
  333. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +118 -0
  334. package/docs/docs/cmd/pp/dataverse/dataverse-table-remove.md +49 -0
  335. package/docs/docs/cmd/pp/environment/environment-get.md +346 -0
  336. package/docs/docs/cmd/pp/environment/environment-list.md +313 -1
  337. package/docs/docs/cmd/pp/gateway/gateway-get.md +56 -0
  338. package/docs/docs/cmd/pp/gateway/gateway-list.md +35 -0
  339. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +23 -0
  340. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +27 -0
  341. package/docs/docs/cmd/pp/solution/solution-get.md +86 -0
  342. package/docs/docs/cmd/pp/solution/solution-list.md +70 -0
  343. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +83 -0
  344. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +71 -0
  345. package/docs/docs/cmd/pp/solution/solution-publisher-remove.md +58 -0
  346. package/docs/docs/cmd/pp/solution/solution-remove.md +82 -0
  347. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +88 -0
  348. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  349. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  350. package/docs/docs/cmd/spfx/spfx-doctor.md +10 -1
  351. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  352. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  353. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  354. package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
  355. package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
  356. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +44 -4
  357. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +74 -0
  358. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  359. package/docs/docs/cmd/spo/field/field-set.md +15 -3
  360. package/docs/docs/cmd/spo/file/file-roleassignment-add.md +57 -0
  361. package/docs/docs/cmd/spo/file/file-roleassignment-remove.md +54 -0
  362. package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +54 -0
  363. package/docs/docs/cmd/spo/file/file-version-clear.md +55 -0
  364. package/docs/docs/cmd/spo/file/file-version-get.md +76 -0
  365. package/docs/docs/cmd/spo/file/file-version-list.md +76 -0
  366. package/docs/docs/cmd/spo/file/file-version-remove.md +58 -0
  367. package/docs/docs/cmd/spo/file/file-version-restore.md +58 -0
  368. package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
  369. package/docs/docs/cmd/spo/folder/folder-roleassignment-add.md +59 -0
  370. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.md +57 -0
  371. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +45 -0
  372. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +42 -0
  373. package/docs/docs/cmd/spo/group/group-list.md +10 -1
  374. package/docs/docs/cmd/spo/group/{group-user-add.md → group-member-add.md} +11 -11
  375. package/docs/docs/cmd/spo/group/{group-user-list.md → group-member-list.md} +5 -5
  376. package/docs/docs/cmd/spo/group/group-member-remove.md +39 -0
  377. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +36 -14
  378. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md +0 -3
  379. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +28 -12
  380. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +3 -3
  381. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
  382. package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md +2 -5
  383. package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md +2 -5
  384. package/docs/docs/cmd/spo/hubsite/hubsite-set.md +2 -5
  385. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
  386. package/docs/docs/cmd/spo/list/list-contenttype-add.md +15 -6
  387. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +16 -7
  388. package/docs/docs/cmd/spo/list/list-contenttype-list.md +15 -6
  389. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +16 -7
  390. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +9 -9
  391. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +8 -8
  392. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  393. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +16 -7
  394. package/docs/docs/cmd/spo/list/list-set.md +18 -6
  395. package/docs/docs/cmd/spo/list/list-view-field-add.md +14 -4
  396. package/docs/docs/cmd/spo/list/list-view-field-remove.md +11 -2
  397. package/docs/docs/cmd/spo/list/list-view-field-set.md +18 -2
  398. package/docs/docs/cmd/spo/list/list-view-list.md +16 -7
  399. package/docs/docs/cmd/spo/list/list-view-remove.md +12 -3
  400. package/docs/docs/cmd/spo/list/list-view-set.md +20 -6
  401. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  402. package/docs/docs/cmd/spo/list/list-webhook-get.md +16 -7
  403. package/docs/docs/cmd/spo/list/list-webhook-list.md +13 -10
  404. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  405. package/docs/docs/cmd/spo/list/list-webhook-set.md +21 -12
  406. package/docs/docs/cmd/spo/listitem/listitem-add.md +17 -2
  407. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  408. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  409. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  410. package/docs/docs/cmd/spo/listitem/listitem-list.md +17 -8
  411. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  412. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  413. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  414. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  415. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.md +8 -8
  416. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  417. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +8 -5
  418. package/docs/docs/cmd/spo/listitem/listitem-set.md +13 -4
  419. package/docs/docs/cmd/spo/page/page-add.md +2 -2
  420. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +14 -19
  421. package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
  422. package/docs/docs/cmd/spo/page/page-set.md +2 -2
  423. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +3 -1
  424. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +3 -1
  425. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-revoke.md +3 -3
  426. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +3 -3
  427. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-deny.md +3 -3
  428. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +3 -1
  429. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +3 -3
  430. package/docs/docs/cmd/spo/site/site-add.md +0 -3
  431. package/docs/docs/cmd/spo/site/site-hubsite-connect.md +37 -0
  432. package/docs/docs/cmd/spo/site/site-hubsite-disconnect.md +37 -0
  433. package/docs/docs/cmd/spo/site/site-hubsite-theme-sync.md +28 -0
  434. package/docs/docs/cmd/spo/sitedesign/sitedesign-get.md +2 -2
  435. package/docs/docs/cmd/spo/spo-get.md +23 -0
  436. package/docs/docs/cmd/spo/spo-search.md +29 -0
  437. package/docs/docs/cmd/spo/spo-set.md +4 -0
  438. package/docs/docs/cmd/spo/term/term-add.md +5 -0
  439. package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
  440. package/docs/docs/cmd/spo/user/user-get.md +49 -2
  441. package/docs/docs/cmd/spo/user/user-list.md +41 -0
  442. package/docs/docs/cmd/spo/user/user-remove.md +4 -0
  443. package/docs/docs/cmd/spo/userprofile/userprofile-get.md +586 -0
  444. package/docs/docs/cmd/spo/userprofile/userprofile-set.md +4 -0
  445. package/docs/docs/cmd/spo/web/web-add.md +43 -0
  446. package/docs/docs/cmd/spo/web/web-clientsidewebpart-list.md +29 -0
  447. package/docs/docs/cmd/spo/web/web-get.md +127 -0
  448. package/docs/docs/cmd/spo/web/web-installedlanguage-list.md +29 -0
  449. package/docs/docs/cmd/spo/web/web-list.md +81 -0
  450. package/docs/docs/cmd/spo/web/web-reindex.md +4 -0
  451. package/docs/docs/cmd/spo/web/web-remove.md +4 -0
  452. package/docs/docs/cmd/spo/web/web-roleassignment-add.md +10 -6
  453. package/docs/docs/cmd/spo/web/web-roleassignment-remove.md +8 -4
  454. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  455. package/docs/docs/cmd/spo/web/web-roleinheritance-reset.md +4 -0
  456. package/docs/docs/cmd/spo/web/web-set.md +4 -0
  457. package/docs/docs/cmd/teams/app/app-install.md +4 -0
  458. package/docs/docs/cmd/teams/app/app-list.md +30 -0
  459. package/docs/docs/cmd/teams/app/app-publish.md +31 -1
  460. package/docs/docs/cmd/teams/app/app-remove.md +4 -0
  461. package/docs/docs/cmd/teams/app/app-uninstall.md +4 -0
  462. package/docs/docs/cmd/teams/app/app-update.md +4 -0
  463. package/docs/docs/cmd/teams/cache/cache-remove.md +4 -0
  464. package/docs/docs/cmd/teams/channel/channel-add.md +41 -4
  465. package/docs/docs/cmd/teams/channel/channel-get.md +46 -7
  466. package/docs/docs/cmd/teams/channel/channel-list.md +35 -0
  467. package/docs/docs/cmd/teams/channel/channel-member-add.md +4 -0
  468. package/docs/docs/cmd/teams/channel/channel-member-list.md +37 -0
  469. package/docs/docs/cmd/teams/channel/channel-member-remove.md +4 -0
  470. package/docs/docs/cmd/teams/channel/channel-member-set.md +35 -0
  471. package/docs/docs/cmd/teams/channel/channel-remove.md +16 -9
  472. package/docs/docs/cmd/teams/channel/channel-set.md +16 -6
  473. package/docs/docs/cmd/teams/chat/chat-get.md +42 -0
  474. package/docs/docs/cmd/teams/chat/chat-list.md +38 -0
  475. package/docs/docs/cmd/teams/chat/chat-member-list.md +35 -0
  476. package/docs/docs/cmd/teams/chat/chat-message-list.md +60 -0
  477. package/docs/docs/cmd/teams/chat/chat-message-send.md +4 -0
  478. package/docs/docs/cmd/teams/funsettings/funsettings-list.md +29 -0
  479. package/docs/docs/cmd/teams/funsettings/funsettings-set.md +4 -0
  480. package/docs/docs/cmd/teams/guestsettings/guestsettings-list.md +25 -0
  481. package/docs/docs/cmd/teams/guestsettings/guestsettings-set.md +4 -0
  482. package/docs/docs/cmd/teams/meeting/meeting-list.md +149 -0
  483. package/docs/docs/cmd/teams/membersettings/membersettings-list.md +33 -0
  484. package/docs/docs/cmd/teams/membersettings/membersettings-set.md +4 -0
  485. package/docs/docs/cmd/teams/message/message-get.md +80 -0
  486. package/docs/docs/cmd/teams/message/message-list.md +63 -0
  487. package/docs/docs/cmd/teams/message/message-reply-list.md +63 -0
  488. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +31 -0
  489. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +4 -0
  490. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +35 -0
  491. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +36 -0
  492. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +41 -0
  493. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +49 -0
  494. package/docs/docs/cmd/teams/report/report-pstncalls.md +49 -0
  495. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +39 -0
  496. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +33 -0
  497. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +58 -0
  498. package/docs/docs/cmd/teams/tab/tab-add.md +35 -0
  499. package/docs/docs/cmd/teams/tab/tab-get.md +35 -0
  500. package/docs/docs/cmd/teams/tab/tab-list.md +43 -0
  501. package/docs/docs/cmd/teams/tab/tab-remove.md +4 -0
  502. package/docs/docs/cmd/teams/team/team-add.md +145 -0
  503. package/docs/docs/cmd/teams/team/team-archive.md +7 -3
  504. package/docs/docs/cmd/teams/team/team-clone.md +4 -3
  505. package/docs/docs/cmd/teams/team/team-get.md +78 -0
  506. package/docs/docs/cmd/teams/team/team-list.md +30 -0
  507. package/docs/docs/cmd/teams/team/team-remove.md +7 -3
  508. package/docs/docs/cmd/teams/team/team-set.md +4 -3
  509. package/docs/docs/cmd/teams/team/team-unarchive.md +5 -2
  510. package/docs/docs/cmd/teams/user/user-app-add.md +4 -0
  511. package/docs/docs/cmd/teams/user/user-app-list.md +40 -0
  512. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -0
  513. package/docs/docs/cmd/teams/user/user-list.md +31 -0
  514. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  515. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  516. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  517. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  518. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  519. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  520. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  521. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  522. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  523. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  524. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  525. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  526. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  527. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  528. package/docs/docs/cmd/todo/list/list-add.md +32 -1
  529. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  530. package/docs/docs/cmd/todo/list/list-list.md +31 -0
  531. package/docs/docs/cmd/todo/list/list-remove.md +10 -6
  532. package/docs/docs/cmd/todo/list/list-set.md +9 -5
  533. package/docs/docs/cmd/todo/task/task-add.md +88 -5
  534. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  535. package/docs/docs/cmd/todo/task/task-list.md +47 -0
  536. package/docs/docs/cmd/todo/task/task-remove.md +9 -4
  537. package/docs/docs/cmd/todo/task/task-set.md +88 -7
  538. package/docs/docs/cmd/util/accesstoken/accesstoken-get.md +20 -0
  539. package/docs/docs/cmd/viva/connections/connections-app-create.md +4 -0
  540. package/docs/docs/cmd/yammer/group/group-list.md +65 -0
  541. package/docs/docs/cmd/yammer/group/group-user-add.md +4 -0
  542. package/docs/docs/cmd/yammer/group/group-user-remove.md +4 -0
  543. package/docs/docs/cmd/yammer/message/message-add.md +55 -0
  544. package/docs/docs/cmd/yammer/message/message-get.md +64 -0
  545. package/docs/docs/cmd/yammer/message/message-like-set.md +4 -0
  546. package/docs/docs/cmd/yammer/message/message-list.md +60 -0
  547. package/docs/docs/cmd/yammer/message/message-remove.md +4 -0
  548. package/docs/docs/cmd/yammer/network/network-list.md +96 -0
  549. package/docs/docs/cmd/yammer/report/report-activitycounts.md +31 -0
  550. package/docs/docs/cmd/yammer/report/report-activityusercounts.md +31 -0
  551. package/docs/docs/cmd/yammer/report/report-activityuserdetail.md +36 -0
  552. package/docs/docs/cmd/yammer/report/report-deviceusagedistributionusercounts.md +33 -0
  553. package/docs/docs/cmd/yammer/report/report-deviceusageusercounts.md +34 -0
  554. package/docs/docs/cmd/yammer/report/report-deviceusageuserdetail.md +38 -0
  555. package/docs/docs/cmd/yammer/report/report-groupsactivitycounts.md +31 -0
  556. package/docs/docs/cmd/yammer/report/report-groupsactivitydetail.md +37 -0
  557. package/docs/docs/cmd/yammer/report/report-groupsactivitygroupcounts.md +30 -0
  558. package/docs/docs/cmd/yammer/user/user-get.md +99 -0
  559. package/docs/docs/cmd/yammer/user/user-list.md +97 -0
  560. package/docs/docs/cmd/yammer/yammer-search.md +77 -0
  561. package/npm-shrinkwrap.json +405 -442
  562. package/package.json +39 -25
  563. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006006_CFG_PS_features.js +0 -60
  564. package/docs/docs/cmd/spo/group/group-user-remove.md +0 -39
  565. package/docs/docs/cmd/spo/hubsite/hubsite-theme-sync.md +0 -33
@@ -16,20 +16,7 @@ m365 spfx project rename [options]
16
16
  `--generateNewId`
17
17
  : Generate a new solution ID for the project
18
18
 
19
- `-h, --help`
20
- : output usage information
21
-
22
- `--query [query]`
23
- : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
24
-
25
- `-o, --output [output]`
26
- : Output type. `json,text,csv,md`. Default `json`
27
-
28
- `--verbose`
29
- : Runs command with verbose logging
30
-
31
- `--debug`
32
- : Runs command with debug logging
19
+ --8<-- "docs/cmd/_global.md"
33
20
 
34
21
  !!! important
35
22
  Run this command in the folder where the project that you want to rename is located.
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- 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.0-beta.1).
35
+ 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.0).
36
36
 
37
37
  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
38
 
@@ -13,6 +13,9 @@ m365 spfx doctor [options]
13
13
  `-e, --env [env]`
14
14
  : Version of SharePoint for which to check compatibility: `sp2016|sp2019|spo`
15
15
 
16
+ `-v, --spfxVersion [spfxVersion]`
17
+ : Version of the SharePoint Framework Yeoman generator to check compatibility for without `v`, eg. `1.11.0`
18
+
16
19
  `-h, --help`
17
20
  : output usage information
18
21
 
@@ -48,7 +51,7 @@ Next to verifying the readiness of your environment to use a particular version
48
51
 
49
52
  ## Examples
50
53
 
51
- Verify if your environment meets the requirements to work with the SharePoint Framework
54
+ Verify if your environment meets the requirements to work with SharePoint Framework based on the globally installed version of the SharePoint Framework Yeoman generator or the current project
52
55
 
53
56
  ```sh
54
57
  m365 spfx doctor --output text
@@ -59,3 +62,9 @@ Verify if your environment meets the requirements to work with the SharePoint Fr
59
62
  ```sh
60
63
  m365 spfx doctor --env sp2019 --output text
61
64
  ```
65
+
66
+ Verify if your environment meets the requirements to work with SharePoint Framework v1.11.0
67
+
68
+ ```sh
69
+ m365 spfx doctor --spfxVersion 1.11.0 --output text
70
+ ```
@@ -14,7 +14,13 @@ m365 spo contenttype add [options]
14
14
  : Absolute URL of the site where the content type should be created
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type should be created (if it should be created as a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id <id>`
20
26
  : The ID of the content type. Determines the parent content type
@@ -44,12 +50,24 @@ Create a site content type that inherits from the List item content type
44
50
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D --group 'PnP Content Types'
45
51
  ```
46
52
 
47
- Create a list content type that inherits from the List item content type
53
+ Create a list (retrieved by Title) content type that inherits from the List item content type
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Alerts --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
51
57
  ```
52
58
 
59
+ Create a list (retrieved by ID) content type that inherits from the List item content type
60
+
61
+ ```sh
62
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
63
+ ```
64
+
65
+ Create a list (retrieved by URL) content type that inherits from the List item content type
66
+
67
+ ```sh
68
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
69
+ ```
70
+
53
71
  ## More information
54
72
 
55
73
  - Content Type IDs: [https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14))
@@ -14,7 +14,13 @@ m365 spo contenttype field remove [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --contentTypeId <contentTypeId>`
20
26
  : The ID of the content type to remove the column from
@@ -32,20 +38,32 @@ m365 spo contenttype field remove [options]
32
38
 
33
39
  ## Examples
34
40
 
35
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
41
+ Remove column with a specific ID from a content type with a specific ID from a specific site.
36
42
 
37
43
  ```sh
38
44
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --confirm
39
45
  ```
40
46
 
41
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_ updating child content types
47
+ Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types
42
48
 
43
49
  ```sh
44
50
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes
45
51
  ```
46
52
 
47
- Remove fieldLink with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from list content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
53
+ Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a spefici site.
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents"
51
57
  ```
58
+
59
+ Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a spefici site.
60
+
61
+ ```sh
62
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c"
63
+ ```
64
+
65
+ Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a spefici site.
66
+
67
+ ```sh
68
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents"
69
+ ```
@@ -14,7 +14,13 @@ m365 spo contenttype get [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id [id]`
20
26
  : The ID of the content type to retrieve. Specify either id or name but not both
@@ -39,11 +45,23 @@ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-s
39
45
  Retrieve site content type by name
40
46
 
41
47
  ```sh
42
- m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name "Document"
48
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'Document'
43
49
  ```
44
50
 
45
- Retrieve list content type
51
+ Retrieve list (retrieved by Title) content type
46
52
 
47
53
  ```sh
48
54
  m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 0x0100558D85B7216F6A489A499DB361E1AE2F
49
55
  ```
56
+
57
+ Retrieve list (retrieved by ID) content type
58
+
59
+ ```sh
60
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
61
+ ```
62
+
63
+ Retrieve list (retrieved by URL) content type
64
+
65
+ ```sh
66
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
67
+ ```
@@ -78,6 +78,9 @@ Note, how the clientSideComponentProperties option (-p) has escaped double quote
78
78
 
79
79
  The `--rights` option accepts **case sensitive** values.
80
80
 
81
+ !!! warning "Escaping JSON in PowerShell"
82
+ 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.
83
+
81
84
  ## Examples
82
85
 
83
86
  Adds tenant-wide SharePoint Framework Application Customizer extension in site _https://contoso.sharepoint.com/sites/test_
@@ -77,12 +77,13 @@ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for
77
77
  m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
78
78
  ```
79
79
 
80
- Note, how the `clientSideComponentProperties` option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
81
-
82
80
  The `--rights` option accepts **case-sensitive** values.
83
81
 
84
82
  Note, specifying the scope option might speed up the execution of the command, but would not update the scope. If the scope has to be changed, then the existing custom action should be removed and new should be added with different scope.
85
83
 
84
+ !!! warning "Escaping JSON in PowerShell"
85
+ 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.
86
+
86
87
  ## Examples
87
88
 
88
89
  Updates tenant-wide SharePoint Framework Application Customizer extension properties in site _https://contoso.sharepoint.com/sites/test_
@@ -26,14 +26,13 @@ Specify either `listTitle`, `listId` or `listUrl`.
26
26
  Specify either `listTitle`, `listId` or `listUrl`.
27
27
 
28
28
  `-n, --name [name]`
29
- The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
29
+ : The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-i, --id [id]`
32
- The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
32
+ : The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
33
33
 
34
34
  `-s, --scope [scope]`
35
- : The scope of which to retrieve the Event Receivers.
36
- Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
35
+ : The scope of which to retrieve the event receivers. Can be either `site` or `web`. Defaults to `web`. Only applicable when not specifying any of the list properties.
37
36
 
38
37
  --8<-- "docs/cmd/_global.md"
39
38
 
@@ -68,3 +67,44 @@ Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ i
68
67
  ```sh
69
68
  m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
70
69
  ```
70
+
71
+ ## Response
72
+
73
+ === "JSON"
74
+
75
+ ```json
76
+ {
77
+ "ReceiverAssembly": "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",
78
+ "ReceiverClass": "Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver",
79
+ "ReceiverId": "c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec",
80
+ "ReceiverName": "PnP Test Receiver",
81
+ "SequenceNumber": 10000,
82
+ "Synchronization": 2,
83
+ "EventType": 10204,
84
+ "ReceiverUrl": "https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b"
85
+ }
86
+ ```
87
+
88
+ === "Text"
89
+
90
+ ```text
91
+ EventType : 10204
92
+ ReceiverAssembly: Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c
93
+ ReceiverClass : Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver
94
+ ReceiverId : c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
95
+ ReceiverName : PnP Test Receiver
96
+ ReceiverUrl : https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b
97
+ SequenceNumber : 10000
98
+ Synchronization : 2
99
+ ```
100
+
101
+ === "CSV"
102
+
103
+ ```csv
104
+ ReceiverAssembly,ReceiverClass,ReceiverId,ReceiverName,SequenceNumber,Synchronization,EventType,ReceiverUrl
105
+ "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver,c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec,PnP Test Receiver,10000,2,10204,https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b
106
+ ```
107
+
108
+
109
+
110
+
@@ -0,0 +1,74 @@
1
+ # spo eventreceiver remove
2
+
3
+ Removes event receivers for the specified web, site, or list.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo eventreceiver remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the web.
15
+
16
+ `--listTitle [listTitle]`
17
+ : The title of the list, _if the event receiver should be removed from a list_. Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : The id of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
24
+
25
+ `-n, --name [name]`
26
+ : The name. Specify either `name` or `id` but not both.
27
+
28
+ `-i, --id [id]`
29
+ : The id. Specify either `name` or `id` but not both.
30
+
31
+ `-s, --scope [scope]`
32
+ : The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
33
+
34
+ `--confirm`
35
+ : Don't prompt for confirmation.
36
+
37
+ --8<-- "docs/cmd/_global.md"
38
+
39
+ ## Remarks
40
+
41
+ !!! attention
42
+ You can only remove an event receiver if it has been registered by an app with the same ID.
43
+
44
+ ## Examples
45
+
46
+ Remove event receiver in a specific web by name.
47
+
48
+ ```sh
49
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
50
+ ```
51
+
52
+ Remove event receiver in a specific site by id.
53
+
54
+ ```sh
55
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
56
+ ```
57
+
58
+ Remove event receiver in a specific list retrieved by title by name.
59
+
60
+ ```sh
61
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
62
+ ```
63
+
64
+ Remove event receiver in a specific list retrieved by list id by id.
65
+
66
+ ```sh
67
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
68
+ ```
69
+
70
+ Remove event receiver in a specific list retrieved by list url by name.
71
+
72
+ ```sh
73
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
74
+ ```
@@ -14,7 +14,13 @@ m365 spo field add [options]
14
14
  : Absolute URL of the site where the field should be created
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the field should be created (if it should be created as a list column)
17
+ : Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
18
+
19
+ `--listId [listId]`
20
+ : ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
18
24
 
19
25
  `-x, --xml <xml>`
20
26
  : CAML field definition
@@ -36,7 +42,7 @@ Create a date time site column
36
42
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
37
43
  ```
38
44
 
39
- Create a URL list column
45
+ Create a URL list column to a list retrieved by Title
40
46
 
41
47
  ```sh
42
48
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
@@ -48,6 +54,18 @@ Create a URL list column and add it to all content types
48
54
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`' --options AddToAllContentTypes
49
55
  ```
50
56
 
57
+ Create a URL list column to a list retrieved by ID
58
+
59
+ ```sh
60
+ m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId e785fe80-2ca1-409e-b9d1-19055a85cd38 --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
61
+ ```
62
+
63
+ Create a date time list column to a list retrieved by URL
64
+
65
+ ```sh
66
+ m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl /sites/contoso-sales/lists/Events --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
67
+ ```
68
+
51
69
  ## More information
52
70
 
53
71
  - AddFieldOptions enumeration: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx)
@@ -14,10 +14,13 @@ m365 spo field set [options]
14
14
  : Absolute URL of the site where the field is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `-i, --id [id]`
23
26
  : ID of the field to update. Specify `id` or `title` but not both
@@ -34,6 +37,9 @@ m365 spo field set [options]
34
37
 
35
38
  Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
36
39
 
40
+ !!! warning "Escaping JSON in PowerShell"
41
+ When updating column formatting for a field with the `--CustomFormatter` 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.
42
+
37
43
  ## Examples
38
44
 
39
45
  Update the title of the site column specified by its internal name and push changes to existing lists
@@ -48,8 +54,14 @@ Update the title of the list column specified by its ID
48
54
  m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
49
55
  ```
50
56
 
57
+ Update the description of a column specified by the ID on a list retrieved by the URL
58
+
59
+ ```sh
60
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
61
+ ```
62
+
51
63
  Update column formatting of the specified list column
52
64
 
53
65
  ```sh
54
- m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
66
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
55
67
  ```
@@ -0,0 +1,57 @@
1
+ # spo file roleassignment add
2
+
3
+ Adds a role assignment to the specified file.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file roleassignment add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `--principalId [principalId]`
23
+ : The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either `upn`, `groupName`, or `principalId` but not multiple.
24
+
25
+ `--upn [upn]`
26
+ : upn/email of user to assign role to. Specify either `upn`, `groupName`, or `principalId` but not multiple.
27
+
28
+ `--groupName [groupName]`
29
+ : The group name of Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
30
+
31
+ `--roleDefinitionId [roleDefinitionId]`
32
+ : ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
33
+
34
+ `--roleDefinitionName [roleDefinitionName]`
35
+ : Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
36
+
37
+ --8<-- "docs/cmd/_global.md"
38
+
39
+ ## Examples
40
+
41
+ Adds a role assignment to a file with a specified id. It will use a principal id and a specific role definition id.
42
+
43
+ ```sh
44
+ m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 11 --roleDefinitionId 1073741829
45
+ ```
46
+
47
+ Adds a role assignment to a file with a specified site-relative URL for a specific upn and a role definition name.
48
+
49
+ ```sh
50
+ m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "Shared Documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Full Control"
51
+ ```
52
+
53
+ Adds a role assignment to a file with a specified server-relative URL the for a specific group and a role definition name.
54
+
55
+ ```sh
56
+ m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Read"
57
+ ```
@@ -0,0 +1,54 @@
1
+ # spo file roleassignment remove
2
+
3
+ Removes a role assignment from a file.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file roleassignment remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `-i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `--principalId [principalId]`
23
+ : The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId` but not multiple.
24
+
25
+ `--upn [upn]`
26
+ : Upn/email of the user. Specify either `upn`, `groupName`, or `principalId` but not multiple.
27
+
28
+ `--groupName [groupName]`
29
+ : The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
30
+
31
+ `--confirm [confirm]`
32
+ : Don't prompt for confirmation.
33
+
34
+ --8<-- "docs/cmd/_global.md"
35
+
36
+ ## Examples
37
+
38
+ Remove a role assignment by principal id from a file by id
39
+
40
+ ```sh
41
+ m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 2
42
+ ```
43
+
44
+ Remove a role assignment by upn from a file by url
45
+
46
+ ```sh
47
+ m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileUrl "/sites/contoso-sales/documents/Test1.docx" --upn "user1@contoso.onmicrosoft.com"
48
+ ```
49
+
50
+ Remove a role assignment by group name from a file by id
51
+
52
+ ```sh
53
+ m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --groupName "saleGroup"
54
+ ```
@@ -0,0 +1,54 @@
1
+ # spo file roleinheritance break
2
+
3
+ Breaks inheritance of a file. Keeping existing permissions is the default behavior.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file roleinheritance break [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the file is located
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
18
+
19
+ `i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
21
+
22
+ `-c, --clearExistingPermissions`
23
+ : Clear all existing permissions from the file
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Break the inheritance of a file with a specific id (UniqueId).
33
+
34
+ ```sh
35
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
36
+ ```
37
+
38
+ Break the inheritance of a file with a specific id (UniqueId) and clear all existing permissions.
39
+
40
+ ```sh
41
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
42
+ ```
43
+
44
+ Break the inheritance of a file with a specific server-relative URL.
45
+
46
+ ```sh
47
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx"
48
+ ```
49
+
50
+ Break the inheritance of a file with a specific server-relative URL and clear all existing permissions.
51
+
52
+ ```sh
53
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --clearExistingPermissions
54
+ ```