@pnp/cli-microsoft365 6.7.0-beta.f5f5666 → 6.8.0-beta.00c3a00

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 (285) hide show
  1. package/.eslintrc.js +2 -0
  2. package/.mocharc.json +1 -0
  3. package/README.md +15 -10
  4. package/dist/Command.js +62 -7
  5. package/dist/chili/chili.js +298 -0
  6. package/dist/chili/index.js +20 -0
  7. package/dist/cli/Cli.js +2 -2
  8. package/dist/m365/aad/commands/user/user-add.js +30 -21
  9. package/dist/m365/app/commands/permission/permission-add.js +279 -0
  10. package/dist/m365/app/commands.js +1 -0
  11. package/dist/m365/commands/commands.js +2 -0
  12. package/dist/m365/commands/docs.js +42 -0
  13. package/dist/m365/commands/login.js +1 -1
  14. package/dist/m365/commands/setup.js +180 -0
  15. package/dist/m365/commands/setupPresets.js +25 -0
  16. package/dist/m365/flow/commands/run/run-get.js +31 -1
  17. package/dist/m365/pa/commands/app/app-consent-set.js +101 -0
  18. package/dist/m365/pa/commands.js +1 -0
  19. package/dist/m365/planner/commands/roster/roster-plan-list.js +102 -0
  20. package/dist/m365/planner/commands.js +1 -0
  21. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-get.js +97 -0
  22. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-list.js +85 -0
  23. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-policysettings-list.js +89 -0
  24. package/dist/m365/purview/commands.js +3 -0
  25. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +2 -0
  26. package/dist/m365/spfx/commands/spfx-doctor.js +14 -30
  27. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-remove.js +146 -0
  28. package/dist/m365/spo/commands/file/file-checkin.js +8 -3
  29. package/dist/m365/spo/commands/file/file-checkout.js +8 -3
  30. package/dist/m365/spo/commands/file/file-copy.js +4 -4
  31. package/dist/m365/spo/commands/file/file-get.js +3 -1
  32. package/dist/m365/spo/commands/file/file-list.js +121 -34
  33. package/dist/m365/spo/commands/file/file-move.js +6 -7
  34. package/dist/m365/spo/commands/file/file-remove.js +6 -12
  35. package/dist/m365/spo/commands/file/file-rename.js +3 -3
  36. package/dist/m365/spo/commands/file/file-roleassignment-add.js +2 -1
  37. package/dist/m365/spo/commands/file/file-roleassignment-remove.js +3 -3
  38. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +2 -1
  39. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +2 -1
  40. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +4 -2
  41. package/dist/m365/spo/commands/file/file-version-clear.js +3 -1
  42. package/dist/m365/spo/commands/file/file-version-get.js +3 -1
  43. package/dist/m365/spo/commands/file/file-version-remove.js +3 -1
  44. package/dist/m365/spo/commands/file/file-version-restore.js +3 -1
  45. package/dist/m365/spo/commands/folder/folder-copy.js +4 -4
  46. package/dist/m365/spo/commands/folder/folder-get.js +5 -2
  47. package/dist/m365/spo/commands/folder/folder-list.js +73 -16
  48. package/dist/m365/spo/commands/folder/folder-move.js +3 -2
  49. package/dist/m365/spo/commands/folder/folder-rename.js +5 -2
  50. package/dist/m365/spo/commands/list/list-get.js +30 -3
  51. package/dist/m365/spo/commands/list/list-list.js +39 -2
  52. package/dist/m365/spo/commands/listitem/listitem-batch-set.js +308 -0
  53. package/dist/m365/spo/commands/page/page-section-add.js +2 -3
  54. package/dist/m365/spo/commands/serviceprincipal/serviceprincipal-permissionrequest-list.js +46 -1
  55. package/dist/m365/spo/commands/site/site-recyclebinitem-move.js +119 -0
  56. package/dist/m365/spo/commands/site/site-recyclebinitem-remove.js +106 -0
  57. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +30 -39
  58. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-list.js +47 -0
  59. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-remove.js +151 -0
  60. package/dist/m365/spo/commands/tenant/tenant-commandset-remove.js +152 -0
  61. package/dist/m365/spo/commands/tenant/tenant-commandset-set.js +203 -0
  62. package/dist/m365/spo/commands/tenant/tenant-settings-set.js +4 -0
  63. package/dist/m365/spo/commands/term/term-add.js +13 -4
  64. package/dist/m365/spo/commands/term/term-get.js +14 -5
  65. package/dist/m365/spo/commands/term/term-group-get.js +12 -3
  66. package/dist/m365/spo/commands/term/term-group-list.js +39 -4
  67. package/dist/m365/spo/commands/term/term-list.js +18 -9
  68. package/dist/m365/spo/commands/term/term-set-add.js +13 -4
  69. package/dist/m365/spo/commands/term/term-set-get.js +12 -3
  70. package/dist/m365/spo/commands/term/term-set-list.js +12 -3
  71. package/dist/m365/spo/commands.js +9 -0
  72. package/dist/m365/teams/commands/chat/chat-member-remove.js +137 -0
  73. package/dist/m365/teams/commands/meeting/meeting-transcript-list.js +124 -0
  74. package/dist/m365/teams/commands.js +2 -0
  75. package/dist/utils/formatting.js +35 -11
  76. package/dist/utils/pid.js +5 -0
  77. package/dist/utils/spo.js +1 -1
  78. package/docs/docs/cmd/aad/o365group/o365group-get.md +0 -12
  79. package/docs/docs/cmd/aad/user/user-add.md +4 -0
  80. package/docs/docs/cmd/aad/user/user-set.md +2 -2
  81. package/docs/docs/cmd/app/permission/permission-add.md +53 -0
  82. package/docs/docs/cmd/cli/cli-consent.md +6 -0
  83. package/docs/docs/cmd/cli/cli-doctor.md +17 -0
  84. package/docs/docs/cmd/cli/cli-issue.md +6 -0
  85. package/docs/docs/cmd/cli/cli-reconsent.md +6 -0
  86. package/docs/docs/cmd/cli/completion/completion-sh-setup.md +6 -0
  87. package/docs/docs/cmd/cli/config/config-get.md +6 -0
  88. package/docs/docs/cmd/docs.md +51 -0
  89. package/docs/docs/cmd/flow/environment/environment-list.md +18 -0
  90. package/docs/docs/cmd/flow/flow-get.md +20 -0
  91. package/docs/docs/cmd/flow/flow-list.md +17 -0
  92. package/docs/docs/cmd/flow/run/run-get.md +110 -9
  93. package/docs/docs/cmd/graph/changelog/changelog-list.md +52 -0
  94. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +61 -0
  95. package/docs/docs/cmd/graph/schemaextension/schemaextension-get.md +61 -0
  96. package/docs/docs/cmd/graph/schemaextension/schemaextension-list.md +61 -0
  97. package/docs/docs/cmd/graph/schemaextension/schemaextension-remove.md +4 -0
  98. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -0
  99. package/docs/docs/cmd/graph/subscription/subscription-add.md +73 -0
  100. package/docs/docs/cmd/login.md +1 -1
  101. package/docs/docs/cmd/onedrive/onedrive-list.md +225 -0
  102. package/docs/docs/cmd/onedrive/report/report-activityfilecounts.md +39 -0
  103. package/docs/docs/cmd/onedrive/report/report-activityusercounts.md +39 -0
  104. package/docs/docs/cmd/onedrive/report/report-activityuserdetail.md +43 -0
  105. package/docs/docs/cmd/onedrive/report/report-usageaccountcounts.md +38 -0
  106. package/docs/docs/cmd/onedrive/report/report-usageaccountdetail.md +43 -0
  107. package/docs/docs/cmd/onedrive/report/report-usagefilecounts.md +38 -0
  108. package/docs/docs/cmd/onedrive/report/report-usagestorage.md +37 -0
  109. package/docs/docs/cmd/onenote/notebook/notebook-list.md +79 -0
  110. package/docs/docs/cmd/pa/app/app-consent-set.md +47 -0
  111. package/docs/docs/cmd/planner/plan/plan-get.md +1 -1
  112. package/docs/docs/cmd/planner/plan/plan-list.md +1 -1
  113. package/docs/docs/cmd/planner/roster/roster-add.md +2 -1
  114. package/docs/docs/cmd/planner/roster/roster-get.md +1 -1
  115. package/docs/docs/cmd/planner/roster/roster-plan-list.md +109 -0
  116. package/docs/docs/cmd/planner/roster/roster-remove.md +2 -1
  117. package/docs/docs/cmd/planner/task/task-add.md +3 -1
  118. package/docs/docs/cmd/planner/task/task-get.md +0 -6
  119. package/docs/docs/cmd/planner/task/task-set.md +7 -5
  120. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +6 -7
  121. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +6 -7
  122. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +4 -4
  123. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +4 -4
  124. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +10 -10
  125. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +11 -11
  126. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +10 -10
  127. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +10 -10
  128. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +10 -10
  129. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -12
  130. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +8 -9
  131. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +8 -9
  132. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +8 -8
  133. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +8 -8
  134. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.md +118 -0
  135. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.md +111 -0
  136. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.md +97 -0
  137. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +17 -0
  138. package/docs/docs/cmd/search/externalconnection/externalconnection-list.md +17 -0
  139. package/docs/docs/cmd/setup.md +86 -0
  140. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +1 -1
  141. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.md +77 -0
  142. package/docs/docs/cmd/spo/commandset/commandset-set.md +1 -1
  143. package/docs/docs/cmd/spo/contenttype/contenttype-set.md +2 -2
  144. package/docs/docs/cmd/spo/customaction/customaction-add.md +1 -1
  145. package/docs/docs/cmd/spo/customaction/customaction-set.md +1 -1
  146. package/docs/docs/cmd/spo/feature/feature-enable.md +2 -2
  147. package/docs/docs/cmd/spo/file/file-add.md +1 -1
  148. package/docs/docs/cmd/spo/file/file-checkin.md +1 -1
  149. package/docs/docs/cmd/spo/file/file-checkout.md +1 -1
  150. package/docs/docs/cmd/spo/file/file-copy.md +1 -1
  151. package/docs/docs/cmd/spo/file/file-get.md +1 -1
  152. package/docs/docs/cmd/spo/file/file-list.md +93 -5
  153. package/docs/docs/cmd/spo/file/file-move.md +3 -3
  154. package/docs/docs/cmd/spo/file/file-remove.md +12 -0
  155. package/docs/docs/cmd/spo/file/file-rename.md +1 -1
  156. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +3 -3
  157. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.md +2 -2
  158. package/docs/docs/cmd/spo/file/file-roleassignment-add.md +1 -1
  159. package/docs/docs/cmd/spo/file/file-roleassignment-remove.md +1 -1
  160. package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +1 -1
  161. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.md +1 -1
  162. package/docs/docs/cmd/spo/file/file-sharinginfo-get.md +1 -1
  163. package/docs/docs/cmd/spo/file/file-sharinglink-add.md +1 -1
  164. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +1 -1
  165. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +1 -1
  166. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  167. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +1 -1
  168. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +1 -1
  169. package/docs/docs/cmd/spo/file/file-version-clear.md +2 -2
  170. package/docs/docs/cmd/spo/file/file-version-get.md +1 -1
  171. package/docs/docs/cmd/spo/file/file-version-list.md +1 -1
  172. package/docs/docs/cmd/spo/file/file-version-remove.md +1 -1
  173. package/docs/docs/cmd/spo/file/file-version-restore.md +1 -1
  174. package/docs/docs/cmd/spo/folder/folder-add.md +9 -3
  175. package/docs/docs/cmd/spo/folder/folder-copy.md +2 -2
  176. package/docs/docs/cmd/spo/folder/folder-get.md +7 -7
  177. package/docs/docs/cmd/spo/folder/folder-list.md +45 -10
  178. package/docs/docs/cmd/spo/folder/folder-move.md +1 -1
  179. package/docs/docs/cmd/spo/folder/folder-remove.md +7 -7
  180. package/docs/docs/cmd/spo/folder/folder-rename.md +11 -5
  181. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.md +3 -3
  182. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.md +1 -1
  183. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +1 -1
  184. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +4 -4
  185. package/docs/docs/cmd/spo/list/list-get.md +10 -0
  186. package/docs/docs/cmd/spo/list/list-list.md +28 -0
  187. package/docs/docs/cmd/spo/listitem/listitem-batch-set.md +67 -0
  188. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +19 -0
  189. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +12 -0
  190. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +6 -0
  191. package/docs/docs/cmd/spo/page/page-column-get.md +15 -0
  192. package/docs/docs/cmd/spo/page/page-column-list.md +16 -0
  193. package/docs/docs/cmd/spo/page/page-control-get.md +18 -0
  194. package/docs/docs/cmd/spo/page/page-control-list.md +18 -0
  195. package/docs/docs/cmd/spo/page/page-copy.md +35 -0
  196. package/docs/docs/cmd/spo/page/page-get.md +39 -0
  197. package/docs/docs/cmd/spo/page/page-list.md +53 -0
  198. package/docs/docs/cmd/spo/page/page-section-get.md +12 -0
  199. package/docs/docs/cmd/spo/page/page-section-list.md +13 -0
  200. package/docs/docs/cmd/spo/page/page-template-list.md +31 -0
  201. package/docs/docs/cmd/spo/propertybag/propertybag-get.md +6 -0
  202. package/docs/docs/cmd/spo/propertybag/propertybag-list.md +13 -0
  203. package/docs/docs/cmd/spo/report/report-activityfilecounts.md +7 -0
  204. package/docs/docs/cmd/spo/report/report-activitypages.md +7 -0
  205. package/docs/docs/cmd/spo/report/report-activityusercounts.md +7 -0
  206. package/docs/docs/cmd/spo/report/report-activityuserdetail.md +7 -0
  207. package/docs/docs/cmd/spo/report/report-siteusagedetail.md +7 -0
  208. package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +7 -0
  209. package/docs/docs/cmd/spo/report/report-siteusagepages.md +7 -0
  210. package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +7 -0
  211. package/docs/docs/cmd/spo/report/report-siteusagestorage.md +7 -0
  212. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +20 -0
  213. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +20 -0
  214. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +20 -0
  215. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +18 -0
  216. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +20 -0
  217. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +17 -0
  218. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +13 -0
  219. package/docs/docs/cmd/spo/site/site-recyclebinitem-move.md +43 -0
  220. package/docs/docs/cmd/spo/site/site-recyclebinitem-remove.md +45 -0
  221. package/docs/docs/cmd/spo/spo-get.md +12 -0
  222. package/docs/docs/cmd/spo/spo-search.md +16 -3
  223. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +1 -1
  224. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.md +103 -0
  225. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.md +49 -0
  226. package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.md +49 -0
  227. package/docs/docs/cmd/spo/tenant/tenant-commandset-set.md +57 -0
  228. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +57 -54
  229. package/docs/docs/cmd/spo/term/term-add.md +107 -6
  230. package/docs/docs/cmd/spo/term/term-get.md +111 -10
  231. package/docs/docs/cmd/spo/term/term-group-get.md +71 -5
  232. package/docs/docs/cmd/spo/term/term-group-list.md +70 -2
  233. package/docs/docs/cmd/spo/term/term-list.md +80 -8
  234. package/docs/docs/cmd/spo/term/term-set-add.md +95 -11
  235. package/docs/docs/cmd/spo/term/term-set-get.md +92 -8
  236. package/docs/docs/cmd/spo/term/term-set-list.md +85 -5
  237. package/docs/docs/cmd/spo/user/user-ensure.md +1 -2
  238. package/docs/docs/cmd/spo/user/user-get.md +24 -0
  239. package/docs/docs/cmd/spo/user/user-list.md +27 -3
  240. package/docs/docs/cmd/spo/userprofile/userprofile-get.md +21 -0
  241. package/docs/docs/cmd/spo/web/web-add.md +24 -0
  242. package/docs/docs/cmd/spo/web/web-clientsidewebpart-list.md +16 -0
  243. package/docs/docs/cmd/spo/web/web-get.md +124 -0
  244. package/docs/docs/cmd/spo/web/web-installedlanguage-list.md +16 -0
  245. package/docs/docs/cmd/spo/web/web-list.md +16 -0
  246. package/docs/docs/cmd/spo/web/web-retentionlabel-list.md +29 -2
  247. package/docs/docs/cmd/teams/app/app-list.md +17 -0
  248. package/docs/docs/cmd/teams/app/app-publish.md +18 -1
  249. package/docs/docs/cmd/teams/channel/channel-add.md +20 -0
  250. package/docs/docs/cmd/teams/channel/channel-get.md +21 -0
  251. package/docs/docs/cmd/teams/channel/channel-list.md +21 -0
  252. package/docs/docs/cmd/teams/channel/channel-member-list.md +20 -0
  253. package/docs/docs/cmd/teams/channel/channel-member-set.md +21 -0
  254. package/docs/docs/cmd/teams/chat/chat-get.md +22 -0
  255. package/docs/docs/cmd/teams/chat/chat-list.md +22 -0
  256. package/docs/docs/cmd/teams/chat/chat-member-list.md +20 -0
  257. package/docs/docs/cmd/teams/chat/chat-member-remove.md +52 -0
  258. package/docs/docs/cmd/teams/chat/chat-message-list.md +23 -0
  259. package/docs/docs/cmd/teams/funsettings/funsettings-list.md +15 -0
  260. package/docs/docs/cmd/teams/guestsettings/guestsettings-list.md +13 -0
  261. package/docs/docs/cmd/teams/meeting/meeting-transcript-list.md +96 -0
  262. package/docs/docs/cmd/teams/membersettings/membersettings-list.md +17 -0
  263. package/docs/docs/cmd/teams/tab/tab-remove.md +1 -1
  264. package/docs/docs/cmd/version.md +1 -1
  265. package/docs/docs/cmd/yammer/group/group-list.md +42 -0
  266. package/docs/docs/cmd/yammer/message/message-add.md +32 -0
  267. package/docs/docs/cmd/yammer/message/message-get.md +32 -0
  268. package/docs/docs/cmd/yammer/message/message-list.md +34 -0
  269. package/docs/docs/cmd/yammer/network/network-list.md +70 -0
  270. package/docs/docs/cmd/yammer/report/report-activitycounts.md +7 -0
  271. package/docs/docs/cmd/yammer/report/report-activityusercounts.md +7 -0
  272. package/docs/docs/cmd/yammer/report/report-activityuserdetail.md +7 -0
  273. package/docs/docs/cmd/yammer/report/report-deviceusagedistributionusercounts.md +7 -0
  274. package/docs/docs/cmd/yammer/report/report-deviceusageusercounts.md +7 -0
  275. package/docs/docs/cmd/yammer/report/report-deviceusageuserdetail.md +7 -0
  276. package/docs/docs/cmd/yammer/report/report-groupsactivitycounts.md +7 -0
  277. package/docs/docs/cmd/yammer/report/report-groupsactivitydetail.md +7 -0
  278. package/docs/docs/cmd/yammer/report/report-groupsactivitygroupcounts.md +7 -0
  279. package/docs/docs/cmd/yammer/user/user-get.md +55 -0
  280. package/docs/docs/cmd/yammer/user/user-list.md +55 -0
  281. package/docs/docs/cmd/yammer/yammer-search.md +15 -3
  282. package/npm-shrinkwrap.json +269 -336
  283. package/package.json +15 -12
  284. package/dist/m365/spo/commands/file/FilePropertiesCollection.js +0 -3
  285. package/dist/m365/spo/commands/folder/FileFolderCollection.js +0 -3
@@ -13,24 +13,112 @@ m365 spo file list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : The URL of the site where the folder from which to retrieve files is located
15
15
 
16
+ `-f, --folderUrl <folderUrl>`
17
+ : The server- or site-relative URL of the parent folder from which to retrieve files
18
+
16
19
  `-f, --folder <folder>`
17
- : The server- or site-relative URL of the folder from which to retrieve files
20
+ : (deprecated. Use `folderUrl` instead) The server- or site-relative URL of the folder from which to retrieve files
21
+
22
+ `--fields [fields]`
23
+ : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified.
24
+
25
+ `--filter [filter]`
26
+ : OData filter to use to query the list of items with
18
27
 
19
28
  `-r, --recursive`
20
29
  : Set to retrieve files from subfolders
21
30
 
22
31
  --8<-- "docs/cmd/_global.md"
23
32
 
33
+ ## Remarks
34
+
35
+ When the `fields` option includes values with a `/`, for example: `ListItemAllFields/Id`, an additional `$expand` query parameter will be included on `ListItemAllFields`.
36
+
24
37
  ## Examples
25
38
 
26
- Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
39
+ Return all files from a folder
40
+
41
+ ```sh
42
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents'
43
+ ```
44
+
45
+ Return all files from a folder and all the sub-folders
46
+
47
+ ```sh
48
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents' --recursive
49
+ ```
50
+
51
+ Return the files from a folder with specific fields which will be expanded
27
52
 
28
53
  ```sh
29
- m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
54
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents' --fields "Title,Length"
30
55
  ```
31
56
 
32
- Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
+ Return the files from a folder that meet the criteria of the filter with specific fields which will be expanded
33
58
 
34
59
  ```sh
35
- m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
60
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl 'Shared Documents' --fields ListItemAllFields/Id --filter "Name eq 'document.docx'"
36
61
  ```
62
+
63
+ ## Response
64
+
65
+ === "JSON"
66
+
67
+ ```json
68
+ [
69
+ {
70
+ "CheckInComment": "",
71
+ "CheckOutType": 2,
72
+ "ContentTag": "{F09C4EFE-B8C0-4E89-A166-03418661B89B},9,12",
73
+ "CustomizedPageStatus": 0,
74
+ "ETag": "\"{F09C4EFE-B8C0-4E89-A166-03418661B89B},9\"",
75
+ "Exists": true,
76
+ "IrmEnabled": false,
77
+ "Length": 331673,
78
+ "Level": 1,
79
+ "LinkingUri": "https://contoso.sharepoint.com/sites/project-x/Shared Documents/Document.docx?d=wf09c4efeb8c04e89a16603418661b89b",
80
+ "LinkingUrl": "https://contoso.sharepoint.com/sites/project-x/Shared Documents/Document.docx?d=wf09c4efeb8c04e89a16603418661b89b",
81
+ "MajorVersion": 3,
82
+ "MinorVersion": 0,
83
+ "Name": "Document.docx",
84
+ "ServerRelativeUrl": "/sites/project-x/Shared Documents/Document.docx",
85
+ "TimeCreated": "2018-02-05T08:42:36Z",
86
+ "TimeLastModified": "2018-02-05T08:44:03Z",
87
+ "Title": "",
88
+ "UIVersion": 1536,
89
+ "UIVersionLabel": "3.0",
90
+ "UniqueId": "f09c4efe-b8c0-4e89-a166-03418661b89b"
91
+ }
92
+ ]
93
+ ```
94
+
95
+ === "Text"
96
+
97
+ ```text
98
+ Name ServerRelativeUrl UniqueId
99
+ --------------------------------- ----------------------------------------------- ------------------------------------
100
+ Document.docx /sites/project-x/Shared Documents/Document.docx 5eb97525-2167-4d26-94b8-092a97d65716
101
+ ```
102
+
103
+ === "CSV"
104
+
105
+ ```csv
106
+ Name,ServerRelativeUrl,UniqueId
107
+ Document.docx,/sites/project-x/Shared Documents/Document.docx,5eb97525-2167-4d26-94b8-092a97d65716
108
+ ```
109
+
110
+ === "Markdown"
111
+
112
+ ```md
113
+ # spo file list --webUrl "https://contoso.sharepoint.com" --folderUrl "Shared Documents"
114
+
115
+ Date: 23/3/2023
116
+
117
+ ## Document.docx (5eb97525-2167-4d26-94b8-092a97d65716)
118
+
119
+ Property | Value
120
+ ---------|-------
121
+ Name | Document.docx
122
+ ServerRelativeUrl | /sites/project-x/Shared Documents/Document.docx
123
+ UniqueId | 5eb97525-2167-4d26-94b8-092a97d65716
124
+ ```
@@ -14,7 +14,7 @@ m365 spo file move [options]
14
14
  : The URL of the site where the file is located
15
15
 
16
16
  `-s, --sourceUrl <sourceUrl>`
17
- : Site-relative URL of the file to move
17
+ : The server- or site-relative URL of the file to move
18
18
 
19
19
  `-t, --targetUrl <targetUrl>`
20
20
  : Server-relative URL where to move the file
@@ -36,7 +36,7 @@ When you move a file using the `spo file move` command, all of the versions are
36
36
  Move file to a document library in another site collection
37
37
 
38
38
  ```sh
39
- m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/
39
+ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /sites/test1/Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/
40
40
  ```
41
41
 
42
42
  Move file to a document library in the same site collection
@@ -54,7 +54,7 @@ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceU
54
54
  Move file to a document library in another site collection. Allow for schema mismatch
55
55
 
56
56
  ```sh
57
- m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/ --allowSchemaMismatch
57
+ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /sites/test1/Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/ --allowSchemaMismatch
58
58
  ```
59
59
 
60
60
 
@@ -8,6 +8,12 @@ Removes the specified file
8
8
  m365 spo file remove [options]
9
9
  ```
10
10
 
11
+ ## Alias
12
+
13
+ ```sh
14
+ m365 spo page template remove
15
+ ```
16
+
11
17
  ## Options
12
18
 
13
19
  `-w, --webUrl <webUrl>`
@@ -46,3 +52,9 @@ Move the file with server-relative URL _/sites/project-x/SharedDocuments/Test.do
46
52
  ```sh
47
53
  m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --url /sites/project-x/SharedDocuments/Test.docx --recycle
48
54
  ```
55
+
56
+ Remove the page template with site-relative URL _SharedDocuments/Test.docx_ from located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo page template remove --webUrl https://contoso.sharepoint.com/sites/project-x --url SharedDocuments/Forms/Template.dotx
60
+ ```
@@ -14,7 +14,7 @@ m365 spo file rename [options]
14
14
  : The URL of the site where the file is located
15
15
 
16
16
  `-s, --sourceUrl <sourceUrl>`
17
- : Site-relative URL of the file to rename
17
+ : The server- or site-relative URL of the file to rename
18
18
 
19
19
  `-t, --targetFileName <targetFileName>`
20
20
  : New file name of the file
@@ -11,10 +11,10 @@ m365 spo file retentionlabel ensure [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the retentionlabel from a file to apply is located
14
+ : URL of the site where the retention label from a file to apply is located
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The site- or server relative URL of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
17
+ : The site- or server-relative URL of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
@@ -29,7 +29,7 @@ m365 spo file retentionlabel ensure [options]
29
29
 
30
30
  ## Remarks
31
31
 
32
- You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retentionlabel from a listitem.
32
+ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retention label from a listitem.
33
33
 
34
34
  The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
35
35
 
@@ -11,10 +11,10 @@ m365 spo file retentionlabel remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the retentionlabel from a file to remove is located
14
+ : URL of the site where the retention label from a file to remove is located
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The site- or server relative URL of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative URL of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `-i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file roleassignment add [options]
14
14
  : URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file roleassignment remove [options]
14
14
  : URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `-i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file roleinheritance break [options]
14
14
  : URL of the site where the file is located
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
17
+ : The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
18
18
 
19
19
  `i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
@@ -14,7 +14,7 @@ m365 spo file roleinheritance reset [options]
14
14
  : URL of the site where the file is located
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
17
+ : The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
18
18
 
19
19
  `i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
@@ -14,7 +14,7 @@ m365 spo file sharinginfo get [options]
14
14
  : The URL of the site where the file is located
15
15
 
16
16
  `-f, --fileUrl [fileUrl]`
17
- : The server-relative URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both
17
+ : The server- or site-relative URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both
18
18
 
19
19
  `-i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both
@@ -14,7 +14,7 @@ m365 spo file sharinglink add [options]
14
14
  : The URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file sharinglink clear [options]
14
14
  : The URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file sharinglink get [options]
14
14
  : The URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file sharinglink list [options]
14
14
  : The URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file sharinglink remove [options]
14
14
  : The URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
@@ -14,7 +14,7 @@ m365 spo file sharinglink set [options]
14
14
  : The URL of the site where the file is located.
15
15
 
16
16
  `--fileUrl [fileUrl]`
17
- : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
17
+ : The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
@@ -14,10 +14,10 @@ m365 spo file version clear [options]
14
14
  : The URL of the site where the file is located
15
15
 
16
16
  `-u, --fileUrl [fileUrl]`
17
- : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
17
+ : The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
18
18
 
19
19
  `-i, --fileId [fileId]`
20
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
21
21
 
22
22
  `--confirm [confirm]`
23
23
  : Don't prompt for confirmation.
@@ -17,7 +17,7 @@ m365 spo file version get [options]
17
17
  : Label of version which will be retrieved
18
18
 
19
19
  `-u, --fileUrl [fileUrl]`
20
- : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
20
+ : The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
21
21
 
22
22
  `-i, --fileId [fileId]`
23
23
  : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
@@ -14,7 +14,7 @@ m365 spo file version list [options]
14
14
  : The URL of the site where the file is located
15
15
 
16
16
  `-u, --fileUrl [fileUrl]`
17
- : The site-relative or server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
17
+ : The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
18
18
 
19
19
  `-i, --fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
@@ -17,7 +17,7 @@ m365 spo file version remove [options]
17
17
  : Label of version which will be removed
18
18
 
19
19
  `-u, --fileUrl [fileUrl]`
20
- : The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
20
+ : The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
21
21
 
22
22
  `-i, --fileId [fileId]`
23
23
  : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
@@ -17,7 +17,7 @@ m365 spo file version restore [options]
17
17
  : Label of version which will be restored
18
18
 
19
19
  `-u, --fileUrl [fileUrl]`
20
- : The server-relative URL of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both
20
+ : The server- or site-relative URL of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both
21
21
 
22
22
  `-i, --fileId [fileId]`
23
23
  : The UniqueId (GUID) of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both
@@ -11,10 +11,10 @@ m365 spo folder add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site where the folder will be created
14
+ : The URL of the site where the folder will be created.
15
15
 
16
16
  `-p, --parentFolderUrl <parentFolderUrl>`
17
- : Site-relative URL of the parent folder
17
+ : The server- or site-relative URL of the parent folder.
18
18
 
19
19
  `-n, --name <name>`
20
20
  : Name of the new folder to be created
@@ -23,8 +23,14 @@ m365 spo folder add [options]
23
23
 
24
24
  ## Examples
25
25
 
26
- Creates folder in a parent folder with site relative url _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
26
+ Creates folder in a specific library within the site
27
27
 
28
28
  ```sh
29
29
  m365 spo folder add --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --name 'My Folder Name'
30
30
  ```
31
+
32
+ Creates folder in a specific folder within the site
33
+
34
+ ```sh
35
+ m365 spo folder add --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents/Reports' --name 'Financial reports'
36
+ ```
@@ -14,7 +14,7 @@ m365 spo folder copy [options]
14
14
  : The URL of the site where the folder is located
15
15
 
16
16
  `-s, --sourceUrl <sourceUrl>`
17
- : Site-relative URL of the folder to copy
17
+ : The server- or site-relative URL of the folder to copy
18
18
 
19
19
  `-t, --targetUrl <targetUrl>`
20
20
  : Server-relative URL where to copy the folder
@@ -45,7 +45,7 @@ m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourc
45
45
  Copies folder to a document library in another site collection. Allow for schema mismatch
46
46
 
47
47
  ```sh
48
- m365 spo folder cope --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/MyFolder --targetUrl /sites/test2/Shared%20Documents/ --allowSchemaMismatch
48
+ m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/MyFolder --targetUrl /sites/test2/Shared%20Documents/ --allowSchemaMismatch
49
49
  ```
50
50
 
51
51
  ## More information
@@ -11,13 +11,13 @@ m365 spo folder get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site where the folder is located
14
+ : The URL of the site where the folder is located.
15
15
 
16
16
  `-f, --url [url]`
17
- : The server-relative URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both
17
+ : The server- or site-relative URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both.
18
18
 
19
19
  `-i, --id [id]`
20
- : The UniqueId (GUID) of the folder to retrieve. Specify either `url` or `id` but not both
20
+ : The UniqueId (GUID) of the folder to retrieve. Specify either `url` or `id` but not both.
21
21
 
22
22
  `--withPermissions`
23
23
  : Set if you want to return associated roles and permissions of the folder.
@@ -32,20 +32,20 @@ If root level folder is passed, you will get a `Please ensure the specified fold
32
32
 
33
33
  ## Examples
34
34
 
35
- Get folder properties for folder with server-relative url _'/Shared Documents'_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ Get folder properties for a folder with a specific site-relative URL
36
36
 
37
37
  ```sh
38
38
  m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --url "/Shared Documents"
39
39
  ```
40
40
 
41
- Get folder properties for folder with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
41
+ Get folder properties for a folder with a specific id (UniqueId)
42
42
 
43
43
  ```sh
44
44
  m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --id "b2307a39-e878-458b-bc90-03bc578531d6"
45
45
  ```
46
46
 
47
- Get folder properties for folder with server-relative url _'/Shared Documents/Test1'_ located in site _https://contoso.sharepoint.com/sites/test
47
+ Get folder properties with permissions for a folder with server-relative URL
48
48
 
49
49
  ```sh
50
- m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/test --url "Shared Documents/Test1" --withPermissions
50
+ m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/test --url "/sites/test/Shared Documents/Test1" --withPermissions
51
51
  ```
@@ -11,19 +11,25 @@ m365 spo folder list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site where the folders to list are located
14
+ : The URL of the site where the folders to list are located.
15
15
 
16
16
  `-p, --parentFolderUrl <parentFolderUrl>`
17
- : Site-relative URL of the parent folder
17
+ : The server- or site-relative URL of the parent folder.
18
+
19
+ `-f, --fields [fields]`
20
+ : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested.
21
+
22
+ `--filter [filter]`
23
+ : OData filter to use to query the list of folders with.
18
24
 
19
25
  `-r, --recursive`
20
- : Set to retrieve nested folders
26
+ : Set to retrieve nested folders.
21
27
 
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
24
30
  ## Examples
25
31
 
26
- Gets list of folders under a parent folder with site-relative url _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
32
+ Gets list of folders under a parent folder with site-relative URL
27
33
 
28
34
  ```sh
29
35
  m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
@@ -32,7 +38,13 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
32
38
  Gets recursive list of folders under a specific folder on a specific site
33
39
 
34
40
  ```sh
35
- m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --recursive
41
+ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents' --recursive
42
+ ```
43
+
44
+ Return a filtered list of folders and only return the list item ID
45
+
46
+ ```sh
47
+ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --fields ListItemAllFields/Id --filter "startswith(Name,'Folder')"
36
48
  ```
37
49
 
38
50
  ## Response
@@ -47,7 +59,7 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
47
59
  "ItemCount": 9,
48
60
  "Name": "Folder A",
49
61
  "ProgID": null,
50
- "ServerRelativeUrl": "/Shared Documents/Folder A",
62
+ "ServerRelativeUrl": "/sites/project-x/Shared Documents/Folder A",
51
63
  "TimeCreated": "2022-04-26T12:30:56Z",
52
64
  "TimeLastModified": "2022-04-26T12:50:14Z",
53
65
  "UniqueId": "20523746-971b-4488-aa6d-b45d645f61c5",
@@ -59,14 +71,37 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
59
71
  === "Text"
60
72
 
61
73
  ```text
62
- Name ServerRelativeUrl
63
- ------- -------------------------
64
- Folder A /Shared Documents/Folder A
74
+ Name ServerRelativeUrl
75
+ -------- ------------------------------------------
76
+ Folder A /sites/project-x/Shared Documents/Folder A
65
77
  ```
66
78
 
67
79
  === "CSV"
68
80
 
69
81
  ```csv
70
82
  Name,ServerRelativeUrl
71
- Folder A,/Shared Documents/Folder A
83
+ Folder A,/sites/project-x/Shared Documents/Folder A
84
+ ```
85
+
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo folder list --webUrl "https://contoso.sharepoint.com" --parentFolderUrl "/Shared Documents"
90
+
91
+ Date: 29/3/2023
92
+
93
+ ## Folder A (20523746-971b-4488-aa6d-b45d645f61c5)
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ Exists | true
98
+ IsWOPIEnabled | false
99
+ ItemCount | 9
100
+ Name | Folder A
101
+ ProgID | null
102
+ ServerRelativeUrl | /sites/project-x/Shared Documents/Folder A
103
+ TimeCreated | 2022-04-26T12:30:56Z
104
+ TimeLastModified | 2022-04-26T12:50:14Z
105
+ UniqueId | 20523746-971b-4488-aa6d-b45d645f61c5
106
+ WelcomePage |
72
107
  ```
@@ -14,7 +14,7 @@ m365 spo folder move [options]
14
14
  : The URL of the site where the folder is located
15
15
 
16
16
  `-s, --sourceUrl <sourceUrl>`
17
- : Site-relative URL of the folder to move
17
+ : The server- or site-relative URL of the folder to move
18
18
 
19
19
  `-t, --targetUrl <targetUrl>`
20
20
  : Server-relative URL where to move the folder
@@ -11,16 +11,16 @@ m365 spo folder remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site where the folder to be deleted is located
14
+ : The URL of the site where the folder to be deleted is located.
15
15
 
16
16
  `-f, --url <url>`
17
- : Site-relative URL of the folder to delete
17
+ : The server- or site-relative URL of the folder to delete.
18
18
 
19
19
  `--recycle`
20
- : Recycles the folder instead of actually deleting it
20
+ : Recycles the folder instead of actually deleting it.
21
21
 
22
22
  `--confirm`
23
- : Don't prompt for confirming deleting the folder
23
+ : Don't prompt for confirming deleting the folder.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -30,14 +30,14 @@ The `spo folder remove` command will remove folder only if it is empty. If the f
30
30
 
31
31
  ## Examples
32
32
 
33
- Removes a folder with site-relative URL _/Shared Documents/My Folder_ located in site _https://contoso.sharepoint.com/sites/project-x_
33
+ Remove a folder with a specific site-relative URL
34
34
 
35
35
  ```sh
36
36
  m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder'
37
37
  ```
38
38
 
39
- Moves a folder with site-relative URL _/Shared Documents/My Folder_ located in site _https://contoso.sharepoint.com/sites/project-x_ to the site recycle bin
39
+ Remove a folder with a specific server relative URL to the site recycle bin
40
40
 
41
41
  ```sh
42
- m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder' --recycle
42
+ m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/Shared Documents/My Folder' --recycle
43
43
  ```