@pnp/cli-microsoft365 6.0.0-beta.cd80a69 → 6.0.0-beta.d557a48

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 (261) hide show
  1. package/.eslintrc.js +4 -2
  2. package/dist/Command.js +16 -2
  3. package/dist/m365/aad/commands/app/app-add.js +40 -17
  4. package/dist/m365/aad/commands/app/app-list.js +38 -0
  5. package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
  6. package/dist/m365/aad/commands.js +2 -0
  7. package/dist/m365/adaptivecard/commands/adaptivecard-send.js +4 -4
  8. package/dist/m365/base/SpoCommand.js +12 -11
  9. package/dist/m365/commands/status.js +6 -1
  10. package/dist/m365/outlook/commands/mail/mail-send.js +54 -30
  11. package/dist/m365/outlook/commands/message/message-get.js +97 -0
  12. package/dist/m365/outlook/commands.js +1 -0
  13. package/dist/m365/planner/commands/bucket/bucket-get.js +5 -8
  14. package/dist/m365/planner/commands/plan/plan-get.js +11 -31
  15. package/dist/m365/pp/commands/card/card-clone.js +122 -0
  16. package/dist/m365/pp/commands/card/card-get.js +110 -0
  17. package/dist/m365/pp/commands/card/card-remove.js +130 -0
  18. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  19. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  20. package/dist/m365/pp/commands.js +5 -0
  21. package/dist/m365/spfx/commands/project/project-doctor/{doctor-1.16.0-beta.1.js → doctor-1.16.0-rc.0.js} +6 -6
  22. package/dist/m365/spfx/commands/project/project-doctor.js +5 -2
  23. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  25. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  26. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  27. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  28. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  29. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  30. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  31. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  32. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  33. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  34. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-rc.0.js} +44 -28
  35. package/dist/m365/spfx/commands/project/project-upgrade.js +5 -2
  36. package/dist/m365/spfx/commands/spfx-doctor.js +6 -6
  37. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  38. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  39. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  40. package/dist/m365/spo/commands/field/field-add.js +26 -1
  41. package/dist/m365/spo/commands/field/field-set.js +23 -13
  42. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -15
  43. package/dist/m365/spo/commands/folder/folder-list.js +35 -12
  44. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +11 -1
  45. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +12 -1
  46. package/dist/m365/spo/commands/hubsite/hubsite-connect.js +93 -18
  47. package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +69 -13
  48. package/dist/m365/spo/commands/list/list-roleassignment-add.js +5 -23
  49. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +4 -15
  50. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  51. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +14 -6
  52. package/dist/m365/spo/commands/list/list-set.js +31 -8
  53. package/dist/m365/spo/commands/list/list-view-field-add.js +19 -5
  54. package/dist/m365/spo/commands/list/list-view-field-remove.js +18 -4
  55. package/dist/m365/spo/commands/list/list-view-field-set.js +18 -4
  56. package/dist/m365/spo/commands/list/list-view-list.js +14 -10
  57. package/dist/m365/spo/commands/list/list-view-remove.js +17 -8
  58. package/dist/m365/spo/commands/list/list-view-set.js +19 -7
  59. package/dist/m365/spo/commands/list/list-webhook-get.js +2 -3
  60. package/dist/m365/spo/commands/list/list-webhook-list.js +4 -28
  61. package/dist/m365/spo/commands/list/list-webhook-set.js +11 -12
  62. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  63. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  64. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  65. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  66. package/dist/m365/spo/commands/listitem/listitem-list.js +21 -14
  67. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  68. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  69. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  70. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  71. package/dist/m365/spo/commands/listitem/listitem-roleassignment-remove.js +4 -15
  72. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  73. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +13 -5
  74. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  75. package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +4 -7
  76. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
  77. package/dist/m365/spo/commands/site/site-add.js +4 -11
  78. package/dist/m365/spo/commands/site/site-hubsite-connect.js +75 -0
  79. package/dist/m365/spo/commands/site/site-hubsite-disconnect.js +93 -0
  80. package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
  81. package/dist/m365/spo/commands/sitedesign/sitedesign-get.js +4 -7
  82. package/dist/m365/spo/commands/web/web-roleassignment-add.js +4 -15
  83. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +4 -8
  84. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  85. package/dist/m365/spo/commands.js +5 -1
  86. package/dist/m365/teams/commands/channel/channel-get.js +2 -2
  87. package/dist/m365/teams/commands/channel/channel-remove.js +56 -39
  88. package/dist/m365/teams/commands/channel/channel-set.js +57 -19
  89. package/dist/m365/teams/commands/team/team-archive.js +4 -7
  90. package/dist/m365/teams/commands/team/team-remove.js +3 -3
  91. package/dist/m365/teams/commands/team/team-set.js +0 -7
  92. package/dist/m365/teams/commands/team/team-unarchive.js +3 -3
  93. package/dist/m365/todo/commands/list/list-get.js +89 -0
  94. package/dist/m365/todo/commands/task/task-add.js +55 -3
  95. package/dist/m365/todo/commands/task/task-get.js +108 -0
  96. package/dist/m365/todo/commands.js +2 -0
  97. package/dist/utils/md.js +8 -1
  98. package/docs/docs/_clisettings.md +18 -0
  99. package/docs/docs/cmd/aad/app/app-add.md +19 -19
  100. package/docs/docs/cmd/aad/app/app-list.md +149 -0
  101. package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
  102. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +12 -5
  103. package/docs/docs/cmd/app/app-get.md +156 -0
  104. package/docs/docs/cmd/app/app-open.md +20 -0
  105. package/docs/docs/cmd/app/permission/permission-list.md +43 -0
  106. package/docs/docs/cmd/booking/business/business-get.md +107 -0
  107. package/docs/docs/cmd/booking/business/business-list.md +34 -0
  108. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
  109. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
  110. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  111. package/docs/docs/cmd/outlook/message/message-get.md +48 -0
  112. package/docs/docs/cmd/pa/app/app-get.md +184 -0
  113. package/docs/docs/cmd/pa/app/app-list.md +181 -0
  114. package/docs/docs/cmd/pa/app/app-remove.md +4 -0
  115. package/docs/docs/cmd/pa/connector/connector-export.md +4 -0
  116. package/docs/docs/cmd/pa/connector/connector-list.md +89 -0
  117. package/docs/docs/cmd/pa/environment/environment-get.md +113 -0
  118. package/docs/docs/cmd/pa/environment/environment-list.md +109 -0
  119. package/docs/docs/cmd/pa/pcf/pcf-init.md +4 -0
  120. package/docs/docs/cmd/pa/solution/solution-init.md +5 -0
  121. package/docs/docs/cmd/pa/solution/solution-reference-add.md +4 -0
  122. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  123. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  124. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  125. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  126. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  127. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  128. package/docs/docs/cmd/planner/plan/plan-get.md +77 -8
  129. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  130. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  131. package/docs/docs/cmd/planner/task/task-get.md +0 -3
  132. package/docs/docs/cmd/pp/card/card-clone.md +77 -0
  133. package/docs/docs/cmd/pp/card/card-get.md +122 -0
  134. package/docs/docs/cmd/pp/card/card-list.md +71 -0
  135. package/docs/docs/cmd/pp/card/card-remove.md +82 -0
  136. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +85 -0
  137. package/docs/docs/cmd/pp/environment/environment-get.md +308 -0
  138. package/docs/docs/cmd/pp/environment/environment-list.md +312 -0
  139. package/docs/docs/cmd/pp/gateway/gateway-get.md +56 -0
  140. package/docs/docs/cmd/pp/gateway/gateway-list.md +35 -0
  141. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +23 -0
  142. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +27 -0
  143. package/docs/docs/cmd/pp/solution/solution-get.md +86 -0
  144. package/docs/docs/cmd/pp/solution/solution-list.md +37 -0
  145. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +62 -0
  146. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  147. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  148. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  149. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  150. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  151. package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
  152. package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
  153. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  154. package/docs/docs/cmd/spo/field/field-set.md +15 -3
  155. package/docs/docs/cmd/spo/file/file-roleassignment-add.md +9 -9
  156. package/docs/docs/cmd/spo/file/file-roleassignment-remove.md +3 -3
  157. package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
  158. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +6 -0
  159. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +6 -0
  160. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +36 -14
  161. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +28 -12
  162. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
  163. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
  164. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +9 -9
  165. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +8 -8
  166. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  167. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +16 -7
  168. package/docs/docs/cmd/spo/list/list-set.md +18 -6
  169. package/docs/docs/cmd/spo/list/list-view-field-add.md +14 -4
  170. package/docs/docs/cmd/spo/list/list-view-field-remove.md +11 -2
  171. package/docs/docs/cmd/spo/list/list-view-field-set.md +18 -2
  172. package/docs/docs/cmd/spo/list/list-view-list.md +16 -7
  173. package/docs/docs/cmd/spo/list/list-view-remove.md +12 -3
  174. package/docs/docs/cmd/spo/list/list-view-set.md +20 -6
  175. package/docs/docs/cmd/spo/list/list-webhook-get.md +1 -1
  176. package/docs/docs/cmd/spo/list/list-webhook-list.md +3 -9
  177. package/docs/docs/cmd/spo/list/list-webhook-set.md +11 -4
  178. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  179. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  180. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  181. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  182. package/docs/docs/cmd/spo/listitem/listitem-list.md +17 -8
  183. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  184. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  185. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  186. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  187. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.md +8 -8
  188. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  189. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +8 -5
  190. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  191. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +14 -19
  192. package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
  193. package/docs/docs/cmd/spo/site/site-add.md +0 -3
  194. package/docs/docs/cmd/spo/site/site-hubsite-connect.md +40 -0
  195. package/docs/docs/cmd/spo/site/site-hubsite-disconnect.md +42 -0
  196. package/docs/docs/cmd/spo/{hubsite/hubsite-theme-sync.md → site/site-hubsite-theme-sync.md} +5 -5
  197. package/docs/docs/cmd/spo/sitedesign/sitedesign-get.md +2 -2
  198. package/docs/docs/cmd/spo/term/term-add.md +5 -0
  199. package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
  200. package/docs/docs/cmd/spo/web/web-roleassignment-add.md +6 -6
  201. package/docs/docs/cmd/spo/web/web-roleassignment-remove.md +4 -4
  202. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  203. package/docs/docs/cmd/teams/channel/channel-get.md +7 -7
  204. package/docs/docs/cmd/teams/channel/channel-remove.md +12 -9
  205. package/docs/docs/cmd/teams/channel/channel-set.md +13 -6
  206. package/docs/docs/cmd/teams/message/message-get.md +80 -0
  207. package/docs/docs/cmd/teams/message/message-list.md +63 -0
  208. package/docs/docs/cmd/teams/message/message-reply-list.md +63 -0
  209. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +31 -0
  210. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +4 -0
  211. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +35 -0
  212. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +36 -0
  213. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +41 -0
  214. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +49 -0
  215. package/docs/docs/cmd/teams/report/report-pstncalls.md +49 -0
  216. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +39 -0
  217. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +33 -0
  218. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +58 -0
  219. package/docs/docs/cmd/teams/tab/tab-add.md +35 -0
  220. package/docs/docs/cmd/teams/tab/tab-get.md +35 -0
  221. package/docs/docs/cmd/teams/tab/tab-list.md +43 -0
  222. package/docs/docs/cmd/teams/tab/tab-remove.md +4 -0
  223. package/docs/docs/cmd/teams/team/team-add.md +145 -0
  224. package/docs/docs/cmd/teams/team/team-archive.md +7 -3
  225. package/docs/docs/cmd/teams/team/team-clone.md +4 -3
  226. package/docs/docs/cmd/teams/team/team-get.md +78 -0
  227. package/docs/docs/cmd/teams/team/team-list.md +30 -0
  228. package/docs/docs/cmd/teams/team/team-remove.md +7 -3
  229. package/docs/docs/cmd/teams/team/team-set.md +4 -3
  230. package/docs/docs/cmd/teams/team/team-unarchive.md +5 -2
  231. package/docs/docs/cmd/teams/user/user-app-add.md +4 -0
  232. package/docs/docs/cmd/teams/user/user-app-list.md +40 -0
  233. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -0
  234. package/docs/docs/cmd/teams/user/user-list.md +31 -0
  235. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  236. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  237. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  238. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  239. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  240. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  241. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  242. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  243. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  244. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  245. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  246. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  247. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  248. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  249. package/docs/docs/cmd/todo/list/list-add.md +32 -1
  250. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  251. package/docs/docs/cmd/todo/list/list-list.md +31 -0
  252. package/docs/docs/cmd/todo/list/list-remove.md +10 -6
  253. package/docs/docs/cmd/todo/list/list-set.md +9 -5
  254. package/docs/docs/cmd/todo/task/task-add.md +88 -5
  255. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  256. package/docs/docs/cmd/todo/task/task-list.md +47 -0
  257. package/docs/docs/cmd/todo/task/task-remove.md +9 -4
  258. package/docs/docs/cmd/todo/task/task-set.md +59 -5
  259. package/docs/docs/cmd/util/accesstoken/accesstoken-get.md +20 -0
  260. package/docs/docs/cmd/viva/connections/connections-app-create.md +4 -0
  261. package/package.json +13 -4
@@ -11,28 +11,28 @@ m365 spo list roleassignment remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list. Specify either listId, listTitle or listUrl but not multiple.
17
+ : ID of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list. Specify either listId, listTitle or listUrl but not multiple.
20
+ : Title of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
21
21
 
22
22
  `--listUrl [listUrl]`
23
- : Relative URL of the list. Specify either listId, listTitle or listUrl but not multiple.
23
+ : Relative URL of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
24
24
 
25
25
  `--principalId [principalId]`
26
- : SharePoint ID of principal it may be either user id or group id we want to remove permissions Specify principalId only when upn or groupName are not used.
26
+ : SharePoint ID of principal it may be either user id or group id you want to remove permissions. Specify either `principalId`, `upn`, or `groupName` but not multiple.
27
27
 
28
28
  `--upn [upn]`
29
- : upn/email of user. Specify either upn or principalId.
29
+ : upn/email of user. Specify either `principalId`, `upn`, or `groupName` but not multiple.
30
30
 
31
31
  `--groupName [groupName]`
32
- : enter group name of Azure AD or SharePoint group. Specify either groupName or principalId.
32
+ : enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
33
33
 
34
34
  `--confirm`
35
- : Don't prompt for confirming removing the role assignment
35
+ : Don't prompt for confirming removing the role assignment.
36
36
 
37
37
  --8<-- "docs/cmd/_global.md"
38
38
 
@@ -11,13 +11,16 @@ m365 spo list roleinheritance break [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to retrieve is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list to retrieve information for. Specify either id or title but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to retrieve information for. Specify either id or title but not both
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  `-c, --clearExistingPermissions`
23
26
  : Flag if used clears all roles from the list
@@ -33,28 +36,28 @@ By default, when breaking permissions inheritance, the list will retain existing
33
36
 
34
37
  ## Examples
35
38
 
36
- Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
39
+ Break inheritance of list by title in a specific site
37
40
 
38
41
  ```sh
39
42
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList"
40
43
  ```
41
44
 
42
- Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
45
+ Break inheritance of list by id in a specific site
43
46
 
44
47
  ```sh
45
48
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991"
46
49
  ```
47
50
 
48
- Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
51
+ Break inheritance of list by title located in a specific site and clearing the existing permissions
49
52
 
50
53
  ```sh
51
54
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --clearExistingPermissions
52
55
  ```
53
56
 
54
- Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
57
+ Break inheritance of list by url in a specific site and clearing the existing permissions
55
58
 
56
59
  ```sh
57
- m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions
60
+ m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl '/sites/project-x/lists/events' --clearExistingPermissions
58
61
  ```
59
62
 
60
63
  Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions without prompting for confirmation
@@ -11,13 +11,16 @@ m365 spo list roleinheritance reset [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list. Specify either id or title but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list. Specify either id or title but not both
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  `--confirm`
23
26
  : Do not prompt for confirmation before resetting role inheritance.
@@ -26,20 +29,26 @@ m365 spo list roleinheritance reset [options]
26
29
 
27
30
  ## Examples
28
31
 
29
- Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
32
+ Restores role inheritance of a specific list by id in a specific site
30
33
 
31
34
  ```sh
32
35
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
33
36
  ```
34
37
 
35
- Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
38
+ Restores role inheritance of a specific list by title in a specific site
36
39
 
37
40
  ```sh
38
41
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
39
42
  ```
40
43
 
41
- Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_ without prompting for confirmation
44
+ Restores role inheritance of a specific list by url in a specific site
45
+
46
+ ```sh
47
+ m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/events'
48
+ ```
49
+
50
+ Restores role inheritance of list a specific list by title without prompting for confirmation
42
51
 
43
52
  ```sh
44
53
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test --confirm
45
- ```
54
+ ```
@@ -10,14 +10,20 @@ m365 spo list set [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --id <id>`
14
- : Id of the list to update
15
-
16
13
  `-u, --webUrl <webUrl>`
17
- : URL of the site where the list to update is located
14
+ : URL of the site
15
+
16
+ `--id [id]`
17
+ : ID of the list. Specify either id, title or url but not multiple.
18
+
19
+ `--title [title]`
20
+ : Title of the list. Specify either id, title or url but not multiple.
21
+
22
+ `--url [url]`
23
+ : Relative URL of the list. Specify either id, title or url but not multiple.
18
24
 
19
- `-t, --title [title]`
20
- : The displayed title for the list
25
+ `--newTitle [newTitle]`
26
+ : New title for the list
21
27
 
22
28
  `--allowDeletion [allowDeletion]`
23
29
  : Boolean value specifying whether the list can be deleted. Valid values are `true,false`
@@ -221,6 +227,12 @@ Enable content types and versioning in the list with id _3EA5A977-315E-4E25-8B0F
221
227
  m365 spo list set --webUrl https://contoso.sharepoint.com/sites/project-x --id 3EA5A977-315E-4E25-8B0F-E4F949BF6B8F --contentTypesEnabled true --enableVersioning true --majorVersionLimit 50 --majorWithMinorVersionsLimit 100
222
228
  ```
223
229
 
230
+ Update the Title of a list retrieved by it's original Title
231
+
232
+ ```sh
233
+ m365 spo list set --webUrl https://contoso.sharepoint.com/sites/project-x --title Documents --newTitle 'Different Title'
234
+ ```
235
+
224
236
  ## More information
225
237
 
226
238
  - SPList Class Members information: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx)
@@ -14,10 +14,13 @@ m365 spo list view field add [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -50,8 +53,15 @@ Add field with title _Custom field_ to view with title _All Documents_ of the li
50
53
  m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field'
51
54
  ```
52
55
 
53
- Add field with title _Custom field_ at the position _0_ to view with title _All Documents_ of the list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
56
+ Add field with title _Custom field_ at the position _0_ to view with title _My Events_ of the list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle 'My Events' --title 'Custom field' --fieldPosition 0
60
+ ```
61
+
62
+ Add field with title _Custom field_ to view with title _All Documents_ of the list with site-relative URL _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
54
63
 
55
64
  ```sh
56
- m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field' --position 0
65
+ m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --viewTitle 'All Documents' --fieldTitle 'Custom field'
57
66
  ```
67
+
@@ -14,10 +14,13 @@ m365 spo list view field remove [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -46,3 +49,9 @@ Remove field with title _Custom field_ from view with title _Custom view_ from t
46
49
  ```sh
47
50
  m365 spo list view field remove --webUrl https://contoso.sharepoint.com/sites/project-x --title 'Custom field' --listTitle Documents --viewTitle 'Custom view'
48
51
  ```
52
+
53
+ Remove field with title _Custom field_ from view with title _Custom view_ from the list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
54
+
55
+ ```sh
56
+ m365 spo list view field remove --webUrl https://contoso.sharepoint.com/sites/project-x --fieldTitle 'Custom field' --listUrl '/sites/project-x/lists/Events' --viewTitle 'Custom view'
57
+ ```
@@ -14,10 +14,13 @@ m365 spo list view field set [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -49,3 +52,16 @@ Move field with title _Custom field_ to position _1_ in view with title _All Doc
49
52
  ```sh
50
53
  m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field' --position 1
51
54
  ```
55
+
56
+ Move field with title _Custom field_ to position _1_ in view with title _All Documents_ of the list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle 'All Documents' --fieldTitle 'Custom field' --fieldPosition 1
60
+ ```
61
+
62
+ Move field with title _Custom field_ to position _1_ in view with title _All Documents_ of the list with site-relative URL _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
63
+
64
+ ```sh
65
+ m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/Shared Documents' --viewTitle 'All Documents' --fieldTitle 'Custom field' --fieldPosition 1
66
+ ```
67
+
@@ -10,27 +10,36 @@ m365 spo list view list [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-u, --webUrl <webUrl>`
13
+ `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the list is located
15
15
 
16
- `-i, --listId [listId]`
17
- : ID of the list for which to list configured views. Specify `listId` or `listTitle` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
- `-t, --listTitle [listTitle]`
20
- : Title of the list for which to list configured views. Specify `listId` or `listTitle` but not both
19
+ `-t, --listTitle [listTitle]`
20
+ : Title of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
25
28
 
26
- List all views for a list with title *Documents* located in site *https://contoso.sharepoint.com/sites/project-x*
29
+ List all views for a list by title
27
30
 
28
31
  ```sh
29
32
  m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents
30
33
  ```
31
34
 
32
- List all views for a list with ID *0cd891ef-afce-4e55-b836-fce03286cccf* located in site *https://contoso.sharepoint.com/sites/project-x*
35
+ List all views for a list by ID
33
36
 
34
37
  ```sh
35
38
  m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
36
39
  ```
40
+
41
+ List all views for a list by URL
42
+
43
+ ```sh
44
+ m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events'
45
+ ```
@@ -14,10 +14,13 @@ m365 spo list view remove [options]
14
14
  : URL of the site where the list to remove the view from is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list from which the view should be removed. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list from which the view should be removed. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list from which the view should be removed. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list from which the view should be removed. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
26
  : ID of the view to remove. Specify either `id` or `title` but not both
@@ -32,7 +35,7 @@ m365 spo list view remove [options]
32
35
 
33
36
  ## Examples
34
37
 
35
- Remove view with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from the list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
38
+ Remove view from the list by ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
39
 
37
40
  ```sh
38
41
  m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e81
@@ -50,6 +53,12 @@ Remove view with title _MyView_ from a list with title _Documents_ located in si
50
53
  m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --title MyView
51
54
  ```
52
55
 
56
+ Remove view with title _MyView_ from a list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle MyView
60
+ ```
61
+
53
62
  Remove view with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_ without being asked for confirmation
54
63
 
55
64
  ```sh
@@ -14,10 +14,13 @@ m365 spo list view set [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
26
  : ID of the view to update. Specify `title` or `id` but not both
@@ -33,6 +36,9 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin
33
36
 
34
37
  When updating list formatting, the value of the CustomFormatter property must be XML-escaped, eg. `&lt;` instead of `<`.
35
38
 
39
+ !!! warning "Escaping JSON in PowerShell"
40
+ When updating list view formatting for a view 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.
41
+
36
42
  ## Examples
37
43
 
38
44
  Update the title of the list view specified by its name
@@ -44,11 +50,19 @@ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x -
44
50
  Update the title of the list view specified by its ID
45
51
 
46
52
  ```sh
47
- m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'All events'
53
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'All events'
48
54
  ```
49
55
 
50
56
  Update view formatting of the specified list view
51
57
 
52
- ```sh
53
- m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'All items' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json","additionalRowClass": "=if([$DueDate] &lt;= @now, 'sp-field-severity--severeWarning', '')"}`'
54
- ```
58
+ === "PowerShell"
59
+
60
+ ```sh
61
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter '{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, ''sp-field-severity--severeWarning'', '''')\"}'
62
+ ```
63
+
64
+ === "Bash"
65
+
66
+ ```sh
67
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter "{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, 'sp-field-severity--severeWarning', '')\"}"
68
+ ```
@@ -22,7 +22,7 @@ m365 spo list webhook get [options]
22
22
  `--listUrl [listUrl]`
23
23
  : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
- `-i, --id [id]`
25
+ `-i, --id <id>`
26
26
  : ID of the webhook.
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
@@ -14,19 +14,13 @@ m365 spo list webhook list [options]
14
14
  : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
21
 
22
22
  `--listUrl [listUrl]`
23
- : Server- or site-relative URL of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
24
-
25
- `--id [id]`
26
- : (deprecated. Use `listId` instead) ID of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
27
-
28
- `--title [title]`
29
- : (deprecated. Use `listTitle` instead) Title of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
30
24
 
31
25
  --8<-- "docs/cmd/_global.md"
32
26
 
@@ -22,14 +22,17 @@ m365 spo list webhook set [options]
22
22
  `--listUrl [listUrl]`
23
23
  : Server- or site-relative URL of the list. Specify either `listId`, `listTitle` or `listUrl`.
24
24
 
25
- `-i, --id [id]`
25
+ `-i, --id <id>`
26
26
  : ID of the webhook to update.
27
27
 
28
28
  `-n, --notificationUrl [notificationUrl]`
29
29
  : The new notification url.
30
30
 
31
31
  `-e, --expirationDateTime [expirationDateTime]`
32
- : The new expiration date.
32
+ : The new expiration date. _Note: Expiration Time cannot be more than 6 months in future_
33
+
34
+ `-c, --clientState [clientState]`
35
+ : A client state information that will be passed through notifications.
33
36
 
34
37
  --8<-- "docs/cmd/_global.md"
35
38
 
@@ -51,8 +54,12 @@ Update the expiration date of a webhook with a specific ID attached to a list wi
51
54
  m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81 --expirationDateTime 2018-10-09T18:15
52
55
  ```
53
56
 
54
- Update the notification url of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
57
+ Update the notification url and clientState of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
55
58
 
56
59
  ```sh
57
- m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02
60
+ m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02 --clientState 'My client state'
58
61
  ```
62
+
63
+ ## Respone
64
+
65
+ The command won't return a response on success.
@@ -14,10 +14,13 @@ m365 spo listitem add [options]
14
14
  : URL of the site where the item should be added
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list where the item should be added. Specify `listId` or `listTitle` but not both
17
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list where the item should be added. Specify `listId` or `listTitle` but not both
20
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `-c, --contentType [contentType]`
23
26
  : The name or the ID of the content type to associate with the new item
@@ -64,3 +67,9 @@ Add an item with Title _Demo Hyperlink Field_ and a hyperlink field named _Custo
64
67
  ```sh
65
68
  m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --CustomHyperlink "https://www.bing.com, Bing"
66
69
  ```
70
+
71
+ Add an item with a specific title to a list retrieved by server-relative URL in a specific site
72
+
73
+ ```sh
74
+ m365 spo listitem add --contentType Item --listUrl /sites/project-x/Documents --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Item"
75
+ ```
@@ -14,10 +14,13 @@ m365 spo listitem attachment list [options]
14
14
  URL of the site from which the item should be retrieved
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list from which to retrieve the item. Specify listId or listTitle but not both
17
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list from which to retrieve the item. Specify listId or listTitle but not both
20
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `--itemId <itemId>`
23
26
  ID of the list item to in question
@@ -37,3 +40,9 @@ Gets the attachments from list item with itemId _147_ in list with id _0cd891ef-
37
40
  ```sh
38
41
  m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --itemId 147
39
42
  ```
43
+
44
+ Gets the attachments from a specific list item in a specific list obtained by server-relative URL in a specific site
45
+
46
+ ```sh
47
+ m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --itemId 147
48
+ ```
@@ -17,10 +17,13 @@ m365 spo listitem get [options]
17
17
  : ID of the item to retrieve.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list from which to retrieve the item. Specify `listId` or `listTitle` but not both
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list from which to retrieve the item. Specify `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  `-p, --properties [properties]`
26
29
  : Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested
@@ -50,3 +53,9 @@ Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_
50
53
  ```sh
51
54
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
52
55
  ```
56
+
57
+ Get an item with specific properties from a list retrieved by server-relative URL in a specific site
58
+
59
+ ```sh
60
+ m365 spo listitem get --listUrl /sites/project-x/documents --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
61
+ ```
@@ -17,10 +17,13 @@ m365 spo listitem isrecord [options]
17
17
  : The ID of the list item to check if it is a record
18
18
 
19
19
  `-l, --listId [listId]`
20
- : The ID of the list where the item is located. Specify `listId` or `listTitle` but not both
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : The title of the list where the item is located. Specify `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -37,3 +40,10 @@ Check whether the document with id _1_ in list with id _0cd891ef-afce-4e55-b836-
37
40
  ```sh
38
41
  m365 spo listitem isrecord --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id 1
39
42
  ```
43
+
44
+ Check whether a document with a specific id in a list retrieved by server-relative URL in a specific site is a record
45
+
46
+ ```sh
47
+ m365 spo listitem isrecord --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/documents --id 1
48
+ ```
49
+
@@ -11,28 +11,31 @@ m365 spo listitem list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site from which the item should be retrieved
14
+ : URL of the site from which the item should be retrieved.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
17
+ : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both.
18
+
19
+ `-l, --listId [listId]`
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
18
21
 
19
22
  `-t, --listTitle [listTitle]`
20
- : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
21
24
 
22
25
  `-q, --camlQuery [camlQuery]`
23
- : CAML query to use to query the list of items with
26
+ : CAML query to use to query the list of items with.
24
27
 
25
28
  `-f, --fields [fields]`
26
- : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested. Specify `camlQuery` or `fields` but not both
29
+ : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested. Specify `camlQuery` or `fields` but not both.
27
30
 
28
31
  `-l, --filter [filter]`
29
- : OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both
32
+ : OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both.
30
33
 
31
34
  `-p, --pageSize [pageSize]`
32
- : Number of list items to return. Specify `camlQuery` or `pageSize` but not both
35
+ : Number of list items to return. Specify `camlQuery` or `pageSize` but not both.
33
36
 
34
37
  `-n, --pageNumber [pageNumber]`
35
- : Page number to return if `pageSize` is specified (first page is indexed as value of 0)
38
+ : Page number to return if `pageSize` is specified (first page is indexed as value of 0).
36
39
 
37
40
  --8<-- "docs/cmd/_global.md"
38
41
 
@@ -85,3 +88,9 @@ From a list named _Demo List_ get the second batch of 10 items
85
88
  ```sh
86
89
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
87
90
  ```
91
+
92
+ Get all items from a list by server-relative URL
93
+
94
+ ```sh
95
+ m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x
96
+ ```