@pnp/cli-microsoft365 7.1.0-beta.8536cf7 → 7.1.0-beta.99de250

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 (214) hide show
  1. package/dist/appInsights.js +5 -9
  2. package/dist/telemetry.js +30 -14
  3. package/dist/telemetryRunner.js +26 -0
  4. package/docs/docs/cmd/aad/license/license-list.mdx +21 -16
  5. package/docs/docs/cmd/aad/m365group/m365group-add.mdx +1 -1
  6. package/docs/docs/cmd/aad/user/user-add.mdx +2 -4
  7. package/docs/docs/cmd/aad/user/user-license-add.mdx +2 -4
  8. package/docs/docs/cmd/aad/user/user-license-list.mdx +3 -5
  9. package/docs/docs/cmd/aad/user/user-recyclebinitem-list.mdx +1 -3
  10. package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.mdx +1 -3
  11. package/docs/docs/cmd/flow/environment/environment-get.mdx +3 -4
  12. package/docs/docs/cmd/flow/environment/environment-list.mdx +3 -4
  13. package/docs/docs/cmd/flow/owner/owner-list.mdx +2 -3
  14. package/docs/docs/cmd/flow/run/run-list.mdx +6 -8
  15. package/docs/docs/cmd/graph/schemaextension/schemaextension-list.mdx +2 -3
  16. package/docs/docs/cmd/onenote/page/page-list.mdx +6 -9
  17. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -15
  18. package/docs/docs/cmd/outlook/message/message-list.mdx +5 -14
  19. package/docs/docs/cmd/outlook/room/room-list.mdx +3 -6
  20. package/docs/docs/cmd/outlook/roomlist/roomlist-list.mdx +1 -3
  21. package/docs/docs/cmd/pa/app/app-get.mdx +4 -7
  22. package/docs/docs/cmd/pa/app/app-list.mdx +4 -7
  23. package/docs/docs/cmd/pa/connector/connector-list.mdx +2 -4
  24. package/docs/docs/cmd/pa/environment/environment-get.mdx +2 -4
  25. package/docs/docs/cmd/pa/environment/environment-list.mdx +1 -3
  26. package/docs/docs/cmd/planner/plan/plan-add.mdx +4 -11
  27. package/docs/docs/cmd/planner/plan/plan-get.mdx +4 -9
  28. package/docs/docs/cmd/planner/plan/plan-list.mdx +3 -6
  29. package/docs/docs/cmd/planner/plan/plan-set.mdx +3 -9
  30. package/docs/docs/cmd/planner/roster/roster-member-add.mdx +2 -4
  31. package/docs/docs/cmd/planner/roster/roster-member-get.mdx +2 -4
  32. package/docs/docs/cmd/planner/roster/roster-member-list.mdx +1 -3
  33. package/docs/docs/cmd/planner/task/task-add.mdx +4 -14
  34. package/docs/docs/cmd/planner/task/task-checklistitem-add.mdx +2 -4
  35. package/docs/docs/cmd/planner/task/task-checklistitem-list.mdx +1 -3
  36. package/docs/docs/cmd/planner/task/task-get.mdx +0 -7
  37. package/docs/docs/cmd/planner/task/task-list.mdx +1 -5
  38. package/docs/docs/cmd/planner/task/task-reference-add.mdx +0 -2
  39. package/docs/docs/cmd/planner/task/task-reference-list.mdx +0 -2
  40. package/docs/docs/cmd/planner/task/task-set.mdx +4 -13
  41. package/docs/docs/cmd/planner/tenant/tenant-settings-list.mdx +1 -3
  42. package/docs/docs/cmd/planner/tenant/tenant-settings-set.mdx +3 -5
  43. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.mdx +6 -8
  44. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.mdx +4 -7
  45. package/docs/docs/cmd/pp/card/card-get.mdx +4 -8
  46. package/docs/docs/cmd/pp/card/card-list.mdx +0 -4
  47. package/docs/docs/cmd/pp/chatbot/chatbot-get.mdx +4 -6
  48. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.mdx +3 -14
  49. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.mdx +3 -14
  50. package/docs/docs/cmd/pp/environment/environment-get.mdx +3 -5
  51. package/docs/docs/cmd/pp/environment/environment-list.mdx +2 -4
  52. package/docs/docs/cmd/pp/gateway/gateway-get.mdx +0 -3
  53. package/docs/docs/cmd/pp/gateway/gateway-list.mdx +1 -4
  54. package/docs/docs/cmd/purview/auditlog/auditlog-list.mdx +4 -0
  55. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx +3 -8
  56. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx +1 -3
  57. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx +1 -5
  58. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx +0 -2
  59. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.mdx +1 -3
  60. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.mdx +1 -3
  61. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.mdx +3 -6
  62. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.mdx +3 -5
  63. package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +4 -8
  64. package/docs/docs/cmd/spo/app/app-add.mdx +94 -7
  65. package/docs/docs/cmd/spo/app/app-deploy.mdx +11 -7
  66. package/docs/docs/cmd/spo/app/app-get.mdx +117 -8
  67. package/docs/docs/cmd/spo/app/app-install.mdx +9 -5
  68. package/docs/docs/cmd/spo/app/app-instance-list.mdx +85 -2
  69. package/docs/docs/cmd/spo/app/app-list.mdx +95 -3
  70. package/docs/docs/cmd/spo/app/app-remove.mdx +11 -7
  71. package/docs/docs/cmd/spo/app/app-retract.mdx +9 -5
  72. package/docs/docs/cmd/spo/app/app-teamspackage-download.mdx +12 -8
  73. package/docs/docs/cmd/spo/app/app-uninstall.mdx +11 -7
  74. package/docs/docs/cmd/spo/app/app-upgrade.mdx +9 -5
  75. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx +4 -2
  76. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +9 -7
  77. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +6 -6
  78. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx +12 -6
  79. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +4 -2
  80. package/docs/docs/cmd/spo/apppage/apppage-add.mdx +54 -5
  81. package/docs/docs/cmd/spo/apppage/apppage-set.mdx +8 -4
  82. package/docs/docs/cmd/spo/cdn/cdn-get.mdx +36 -1
  83. package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +7 -3
  84. package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +48 -3
  85. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +8 -4
  86. package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +53 -3
  87. package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +7 -3
  88. package/docs/docs/cmd/spo/cdn/cdn-set.mdx +7 -3
  89. package/docs/docs/cmd/spo/commandset/commandset-add.mdx +6 -6
  90. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +3 -5
  91. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +6 -5
  92. package/docs/docs/cmd/spo/commandset/commandset-remove.mdx +7 -3
  93. package/docs/docs/cmd/spo/commandset/commandset-set.mdx +6 -4
  94. package/docs/docs/cmd/spo/contenttype/contenttype-add.mdx +148 -9
  95. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +19 -15
  96. package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +12 -8
  97. package/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +147 -8
  98. package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +115 -4
  99. package/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx +8 -4
  100. package/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +8 -4
  101. package/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx +44 -0
  102. package/docs/docs/cmd/spo/customaction/customaction-add.mdx +12 -8
  103. package/docs/docs/cmd/spo/customaction/customaction-clear.mdx +10 -7
  104. package/docs/docs/cmd/spo/customaction/customaction-get.mdx +11 -15
  105. package/docs/docs/cmd/spo/customaction/customaction-list.mdx +87 -5
  106. package/docs/docs/cmd/spo/customaction/customaction-remove.mdx +17 -13
  107. package/docs/docs/cmd/spo/customaction/customaction-set.mdx +27 -23
  108. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +29 -14
  109. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx +66 -5
  110. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx +4 -0
  111. package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +78 -7
  112. package/docs/docs/cmd/spo/feature/feature-disable.mdx +10 -6
  113. package/docs/docs/cmd/spo/feature/feature-enable.mdx +9 -5
  114. package/docs/docs/cmd/spo/feature/feature-list.mdx +52 -0
  115. package/docs/docs/cmd/spo/field/field-add.mdx +177 -11
  116. package/docs/docs/cmd/spo/field/field-get.mdx +175 -9
  117. package/docs/docs/cmd/spo/field/field-list.mdx +135 -8
  118. package/docs/docs/cmd/spo/field/field-remove.mdx +16 -12
  119. package/docs/docs/cmd/spo/field/field-set.mdx +15 -11
  120. package/docs/docs/cmd/spo/file/file-add.mdx +31 -27
  121. package/docs/docs/cmd/spo/file/file-checkin.mdx +13 -9
  122. package/docs/docs/cmd/spo/file/file-checkout.mdx +9 -5
  123. package/docs/docs/cmd/spo/file/file-copy.mdx +5 -5
  124. package/docs/docs/cmd/spo/file/file-get.mdx +89 -18
  125. package/docs/docs/cmd/spo/file/file-list.mdx +5 -5
  126. package/docs/docs/cmd/spo/file/file-move.mdx +5 -5
  127. package/docs/docs/cmd/spo/file/file-remove.mdx +13 -9
  128. package/docs/docs/cmd/spo/file/file-rename.mdx +63 -5
  129. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +3 -3
  130. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +2 -2
  131. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +4 -0
  132. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +7 -3
  133. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +9 -5
  134. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +10 -6
  135. package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +133 -5
  136. package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +21 -3
  137. package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +2 -2
  138. package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +18 -0
  139. package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +20 -3
  140. package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +2 -7
  141. package/docs/docs/cmd/spo/file/file-version-clear.mdx +7 -7
  142. package/docs/docs/cmd/spo/file/file-version-get.mdx +28 -6
  143. package/docs/docs/cmd/spo/file/file-version-list.mdx +28 -6
  144. package/docs/docs/cmd/spo/file/file-version-remove.mdx +8 -8
  145. package/docs/docs/cmd/spo/file/file-version-restore.mdx +8 -8
  146. package/docs/docs/cmd/spo/folder/folder-add.mdx +3 -3
  147. package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
  148. package/docs/docs/cmd/spo/folder/folder-get.mdx +257 -3
  149. package/docs/docs/cmd/spo/folder/folder-list.mdx +3 -4
  150. package/docs/docs/cmd/spo/folder/folder-move.mdx +5 -5
  151. package/docs/docs/cmd/spo/folder/folder-remove.mdx +6 -2
  152. package/docs/docs/cmd/spo/folder/folder-rename.mdx +2 -2
  153. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +3 -3
  154. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +2 -2
  155. package/docs/docs/cmd/spo/folder/folder-roleassignment-add.mdx +13 -8
  156. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.mdx +8 -4
  157. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.mdx +4 -0
  158. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.mdx +5 -1
  159. package/docs/docs/cmd/spo/group/group-add.mdx +78 -0
  160. package/docs/docs/cmd/spo/group/group-get.mdx +81 -3
  161. package/docs/docs/cmd/spo/group/group-list.mdx +74 -3
  162. package/docs/docs/cmd/spo/group/group-member-add.mdx +13 -21
  163. package/docs/docs/cmd/spo/group/group-member-list.mdx +80 -5
  164. package/docs/docs/cmd/spo/group/group-member-remove.mdx +4 -4
  165. package/docs/docs/cmd/spo/group/group-remove.mdx +10 -6
  166. package/docs/docs/cmd/spo/group/group-set.mdx +9 -5
  167. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +36 -1
  168. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +6 -2
  169. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.mdx +0 -2
  170. package/docs/docs/cmd/spo/list/list-add.mdx +0 -3
  171. package/docs/docs/cmd/spo/list/list-contenttype-add.mdx +0 -2
  172. package/docs/docs/cmd/spo/list/list-contenttype-list.mdx +0 -2
  173. package/docs/docs/cmd/spo/list/list-get.mdx +1 -4
  174. package/docs/docs/cmd/spo/list/list-list.mdx +0 -4
  175. package/docs/docs/cmd/spo/list/list-view-add.mdx +0 -3
  176. package/docs/docs/cmd/spo/list/list-view-get.mdx +9 -12
  177. package/docs/docs/cmd/spo/list/list-view-list.mdx +4 -7
  178. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx +8 -11
  179. package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -2
  180. package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +4 -6
  181. package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +0 -2
  182. package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +4 -6
  183. package/docs/docs/cmd/spo/page/page-copy.mdx +4 -8
  184. package/docs/docs/cmd/spo/page/page-get.mdx +2 -5
  185. package/docs/docs/cmd/spo/page/page-list.mdx +1 -5
  186. package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +4 -4
  187. package/docs/docs/cmd/spo/sitescript/sitescript-set.mdx +6 -7
  188. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx +3 -1
  189. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +5 -3
  190. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +4 -2
  191. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.mdx +5 -1
  192. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +2 -0
  193. package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +2 -1
  194. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +5 -2
  195. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +4 -1
  196. package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.mdx +5 -1
  197. package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +3 -1
  198. package/docs/docs/cmd/teams/channel/channel-member-list.mdx +3 -5
  199. package/docs/docs/cmd/teams/channel/channel-member-set.mdx +0 -2
  200. package/docs/docs/cmd/teams/chat/chat-get.mdx +2 -4
  201. package/docs/docs/cmd/teams/chat/chat-list.mdx +1 -3
  202. package/docs/docs/cmd/teams/chat/chat-member-list.mdx +2 -4
  203. package/docs/docs/cmd/teams/message/message-get.mdx +0 -7
  204. package/docs/docs/cmd/teams/message/message-list.mdx +0 -6
  205. package/docs/docs/cmd/teams/message/message-reply-list.mdx +0 -6
  206. package/docs/docs/cmd/teams/tab/tab-add.mdx +10 -12
  207. package/docs/docs/cmd/teams/tab/tab-get.mdx +8 -10
  208. package/docs/docs/cmd/teams/tab/tab-list.mdx +4 -7
  209. package/docs/docs/cmd/teams/team/team-add.mdx +0 -7
  210. package/docs/docs/cmd/teams/team/team-get.mdx +0 -6
  211. package/docs/docs/cmd/tenant/security/security-alerts-list.mdx +1 -1
  212. package/docs/docs/cmd/todo/task/task-add.mdx +9 -13
  213. package/docs/docs/cmd/todo/task/task-set.mdx +10 -14
  214. package/package.json +1 -1
@@ -14,54 +14,58 @@ m365 spo field remove [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : Absolute URL of the site where the field to remove is located
17
+ : Absolute URL of the site where the field to remove is located.
18
18
 
19
19
  `-l, --listTitle [listTitle]`
20
- : Title of the list where the field is located. Specify only one of `listTitle`, `listId` or `listUrl`
20
+ : Title of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
21
21
 
22
22
  `--listId [listId]`
23
- : ID of the list where the field is located. Specify only one of `listTitle`, `listId` or `listUrl`
23
+ : ID of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
25
  `--listUrl [listUrl]`
26
- : Server- or web-relative URL of the list where the field is located. Specify only one of `listTitle`, `listId` or `listUrl`
26
+ : Server- or web-relative URL of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
27
27
 
28
28
  `-i, --id [id]`
29
- : The ID of the field to remove. Specify id, title, or group
29
+ : The ID of the field to remove. Specify either `id`, `title`, or `group`.
30
30
 
31
31
  `-t, --title [title]`
32
- : The display name (case-sensitive) of the field to remove. Specify id, title, or group
32
+ : The display name (case-sensitive) of the field to remove. Specify either `id`, `title`, or `group`.
33
33
 
34
34
  `-g, --group [group]`
35
- : Delete all fields from this group (case-sensitive). Specify id, title, or group
35
+ : Delete all fields from this group (case-sensitive). Specify either `id`, `title`, or `group`.
36
36
 
37
37
  `-f, --force`
38
- : Don't prompt for confirming removing the field
38
+ : Don't prompt for confirming removing the field.
39
39
  ```
40
40
 
41
41
  <Global />
42
42
 
43
43
  ## Examples
44
44
 
45
- Remove the site column with the specified ID, located in site _https://contoso.sharepoint.com/sites/contoso-sales_
45
+ Remove the site column with the specified ID, located in the specified site.
46
46
 
47
47
  ```sh
48
48
  m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
49
49
  ```
50
50
 
51
- Remove the list column with the specified ID, located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its title
51
+ Remove the list column with the specified ID, located in the specified site. Retrieves the list by its title.
52
52
 
53
53
  ```sh
54
54
  m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
55
55
  ```
56
56
 
57
- Remove the list column with the specified display name, located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its url
57
+ Remove the list column with the specified display name, located in the specified site. Retrieves the list by its url.
58
58
 
59
59
  ```sh
60
60
  m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
61
61
  ```
62
62
 
63
- Remove all site columns from group _MyGroup_
63
+ Remove all site columns from the specified group.
64
64
 
65
65
  ```sh
66
66
  m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --group "MyGroup"
67
67
  ```
68
+
69
+ ## Response
70
+
71
+ The command won't return a response on success.
@@ -14,25 +14,25 @@ m365 spo field set [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : Absolute URL of the site where the field is located
17
+ : Absolute URL of the site where the field is located.
18
18
 
19
19
  `--listId [listId]`
20
- : ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
20
+ : ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`.
21
21
 
22
22
  `--listTitle [listTitle]`
23
- : Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
23
+ : Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
25
  `--listUrl [listUrl]`
26
- : Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
26
+ : Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`.
27
27
 
28
28
  `-i, --id [id]`
29
- : ID of the field to update. Specify `id` or `title` but not both
29
+ : ID of the field to update. Specify either `id` or `title` but not both.
30
30
 
31
31
  `-t, --title [title]`
32
- : Title or internal name of the field to update. Specify `id` or `title` but not both
32
+ : Title or internal name of the field to update. Specify either `id` or `title` but not both.
33
33
 
34
34
  `--updateExistingLists`
35
- : Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only
35
+ : Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only.
36
36
  ```
37
37
 
38
38
  <Global />
@@ -49,26 +49,30 @@ When updating column formatting for a field with the `--CustomFormatter` option,
49
49
 
50
50
  ## Examples
51
51
 
52
- Update the title of the site column specified by its internal name and push changes to existing lists
52
+ Update the title of the site column specified by its internal name and push changes to existing lists.
53
53
 
54
54
  ```sh
55
55
  m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --title 'MyColumn' --updateExistingLists --Title 'My column'
56
56
  ```
57
57
 
58
- Update the title of the list column specified by its ID
58
+ Update the title of the list column specified by its ID.
59
59
 
60
60
  ```sh
61
61
  m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
62
62
  ```
63
63
 
64
- Update the description of a column specified by the ID on a list retrieved by the URL
64
+ Update the description of a column specified by the ID on a list retrieved by the URL.
65
65
 
66
66
  ```sh
67
67
  m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
68
68
  ```
69
69
 
70
- Update column formatting of the specified list column
70
+ Update column formatting of the specified list column.
71
71
 
72
72
  ```sh
73
73
  m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
74
74
  ```
75
+
76
+ ## Response
77
+
78
+ The command won't return a response on success.
@@ -14,34 +14,34 @@ m365 spo file add [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : The URL of the site where the file should be uploaded to
17
+ : The URL of the site where the file should be uploaded to.
18
18
 
19
19
  `--folder <folder>`
20
- : The server- or site-relative decoded URL to the folder where the file should be uploaded
20
+ : The server- or site-relative decoded URL to the folder where the file should be uploaded.
21
21
 
22
22
  `-p, --path <path>`
23
- : Local path to the file to upload
23
+ : Local path to the file to upload.
24
24
 
25
25
  `-c, --contentType [contentType]`
26
- : Content type name or ID to assign to the file
26
+ : Content type name or ID to assign to the file.
27
27
 
28
28
  `--checkOut [checkOut]`
29
- : If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again
29
+ : If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again.
30
30
 
31
31
  `--checkInComment [checkInComment]`
32
- : Comment to set when checking the file in
32
+ : Comment to set when checking the file in.
33
33
 
34
34
  `--approve [approve]`
35
- : Will automatically approve the uploaded file
35
+ : Will automatically approve the uploaded file.
36
36
 
37
37
  `--approveComment [approveComment]`
38
- : Comment to set when approving the file
38
+ : Comment to set when approving the file.
39
39
 
40
40
  `--publish [publish]`
41
- : Will automatically publish the uploaded file
41
+ : Will automatically publish the uploaded file.
42
42
 
43
43
  `--publishComment [publishComment]`
44
- : Comment to set when publishing the file
44
+ : Comment to set when publishing the file.
45
45
  ```
46
46
 
47
47
  <Global />
@@ -52,108 +52,112 @@ This command allows using unknown properties. Each property corresponds to the l
52
52
 
53
53
  ## Examples
54
54
 
55
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_
55
+ Adds the specified file to the specified site in the specified folder.
56
56
 
57
57
  ```sh
58
58
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg'
59
59
  ```
60
60
 
61
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in sub folder _Shared Documents/Sub Folder 1_
61
+ Adds the specified file to the specified site in the specified sub folder.
62
62
 
63
63
  ```sh
64
64
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Sub Folder 1' --path 'C:\MS365.jpg'
65
65
  ```
66
66
 
67
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ specifying server-relative folder url
67
+ Adds the specified file to the specified site in the specified folder specifying server-relative folder url.
68
68
 
69
69
  ```sh
70
70
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder '/sites/project-x/Shared Documents' --path 'C:\MS365.jpg'
71
71
  ```
72
72
 
73
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ with specified content type
73
+ Adds the specified file to the specified site in the specified folder with specified content type.
74
74
 
75
75
  ```sh
76
76
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --contentType 'Picture'
77
77
  ```
78
78
 
79
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_, but checks out existing file before the upload
79
+ Adds the specified file to the specified site in the specified folder, but checks out existing file before the upload.
80
80
 
81
81
  ```sh
82
82
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --checkOut --checkInComment 'check in comment x'
83
83
  ```
84
84
 
85
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and approves it (when list moderation is enabled)
85
+ Adds the specified file to the specified site in the specified folder and approves it (when list moderation is enabled).
86
86
 
87
87
  ```sh
88
88
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --approve --approveComment 'approve comment x'
89
89
  ```
90
90
 
91
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and publishes it
91
+ Adds the specified file to the specified site in the specified folder and publishes it.
92
92
 
93
93
  ```sh
94
94
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --publish --publishComment 'publish comment x'
95
95
  ```
96
96
 
97
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes single text field value of the list item
97
+ Adds the specified file to the specified site in the specified folder and changes single text field value of the list item.
98
98
 
99
99
  ```sh
100
100
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Title "New Title"
101
101
  ```
102
102
 
103
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes person/group field and DateTime field values
103
+ Adds the specified file to the specified site in the specified folder and changes person/group field and DateTime field values.
104
104
 
105
105
  ```sh
106
106
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Editor "[{'Key':'i:0#.f|membership|john.smith@contoso.com'}]" --Modified '6/23/2018 10:15 PM'
107
107
  ```
108
108
 
109
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes hyperlink or picture field
109
+ Adds the specified file to the specified site in the specified folder and changes hyperlink or picture field.
110
110
 
111
111
  ```sh
112
112
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --URL 'https://contoso.com, Contoso'
113
113
  ```
114
114
 
115
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes taxonomy field
115
+ Adds the specified file to the specified site in the specified folder and changes taxonomy field.
116
116
 
117
117
  ```sh
118
118
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Topic "HR services|c17baaeb-67cd-4378-9389-9d97a945c701"
119
119
  ```
120
120
 
121
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes taxonomy multi-value field
121
+ Adds the specified file to the specified site in the specified folder and changes taxonomy multi-value field.
122
122
 
123
123
  ```sh
124
124
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Topic "HR services|c17baaeb-67cd-4378-9389-9d97a945c701;Inclusion & Diversity|66a67671-ed89-44a7-9be4-e80c06b41f35"
125
125
  ```
126
126
 
127
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes choice field and multi-choice field
127
+ Adds the specified file to the specified site in the specified folder and changes choice field and multi-choice field.
128
128
 
129
129
  ```sh
130
130
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --ChoiceField1 'Option3' --MultiChoiceField1 'Option2;#Option3'
131
131
  ```
132
132
 
133
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes person/group field that allows multi-user selection
133
+ Adds the specified file to the specified site in the specified folder and changes person/group field that allows multi-user selection.
134
134
 
135
135
  ```sh
136
136
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --AllowedUsers "[{'Key':'i:0#.f|membership|john.smith@contoso.com'},{'Key':'i:0#.f|membership|velin.georgiev@contoso.com'}]"
137
137
  ```
138
138
 
139
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes yes/no field
139
+ Adds the specified file to the specified site in the specified folder and changes yes/no field.
140
140
 
141
141
  ```sh
142
142
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --HasCar true
143
143
  ```
144
144
 
145
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes number field and currency field
145
+ Adds the specified file to the specified site in the specified folder and changes number field and currency field.
146
146
 
147
147
  ```sh
148
148
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --NumberField 100 --CurrencyField 20
149
149
  ```
150
150
 
151
- Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes lookup field and multi-lookup field
151
+ Adds the specified file to the specified site in the specified folder and changes lookup field and multi-lookup field.
152
152
 
153
153
  ```sh
154
154
  m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --LookupField 1 --MultiLookupField "2;#;#3;#;#4;#"
155
155
  ```
156
156
 
157
+ ## Response
158
+
159
+ The command won't return a response on success.
160
+
157
161
  ## More information
158
162
 
159
163
  - Update file metadata with REST API using ValidateUpdateListItem method: [https://robertschouten.com/2018/04/30/update-file-metadata-with-rest-api-using-validateupdatelistitem-method/](https://robertschouten.com/2018/04/30/update-file-metadata-with-rest-api-using-validateupdatelistitem-method/)
@@ -14,45 +14,49 @@ m365 spo file checkin [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : The URL of the site where the file is located
17
+ : The URL of the site where the file is located.
18
18
 
19
19
  `--url [url]`
20
- : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both
20
+ : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
21
21
 
22
22
  `-i, --id [id]`
23
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both
23
+ : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
24
24
 
25
25
  `-t, --type [type]`
26
- : Type of the check in. Available values `Minor`, `Major`, `Overwrite`. Default is Major
26
+ : Type of the check in. Allowed values: `Minor`, `Major`, `Overwrite`. Defaults to `Major`.
27
27
 
28
28
  `--comment [comment]`
29
- : Comment to set when checking the file in. It\'s length must be less than 1024 letters. Default is empty string
29
+ : Comment to set when checking the file in. It\'s length must be less than 1024 letters. Default is empty string.
30
30
  ```
31
31
 
32
32
  <Global />
33
33
 
34
34
  ## Examples
35
35
 
36
- Checks in file with UniqueId _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
+ Checks in file with the specified UniqueId located in the specified site.
37
37
 
38
38
  ```sh
39
39
  m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
40
40
  ```
41
41
 
42
- Checks in file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Checks in file with the specified server-relative url located in the specified site.
43
43
 
44
44
  ```sh
45
45
  m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
46
46
  ```
47
47
 
48
- Checks in minor version of file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
48
+ Checks in minor version of file with the specified server-relative url located in the specified site.
49
49
 
50
50
  ```sh
51
51
  m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --type Minor
52
52
  ```
53
53
 
54
- Checks in file _/sites/project-x/documents/Test1.docx_ with comment located in site _https://contoso.sharepoint.com/sites/project-x_
54
+ Checks in the specified file with comment located in the specified site.
55
55
 
56
56
  ```sh
57
57
  m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --comment 'approved'
58
58
  ```
59
+
60
+ ## Response
61
+
62
+ The command won't return a response on success.
@@ -14,27 +14,31 @@ m365 spo file checkout [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : The URL of the site where the file is located
17
+ : The URL of the site where the file is located.
18
18
 
19
19
  `--url [url]`
20
- : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both
20
+ : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
21
21
 
22
22
  `-i, --id [id]`
23
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both
23
+ : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
24
24
  ```
25
25
 
26
26
  <Global />
27
27
 
28
28
  ## Examples
29
29
 
30
- Checks out file with UniqueId _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
30
+ Checks out file with the specified UniqueId located in the specified site.
31
31
 
32
32
  ```sh
33
33
  m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
34
34
  ```
35
35
 
36
- Checks out file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
+ Checks out file with the specified server-relative url located in the specified site.
37
37
 
38
38
  ```sh
39
39
  m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
40
40
  ```
41
+
42
+ ## Response
43
+
44
+ The command won't return a response on success.
@@ -29,7 +29,7 @@ m365 spo file copy [options]
29
29
  : New name of the destination file.
30
30
 
31
31
  `--nameConflictBehavior [nameConflictBehavior]`
32
- : Behavior when a document with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. Default is `fail`.
32
+ : Behavior when a document with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`.
33
33
 
34
34
  `--resetAuthorAndCreated`
35
35
  : Use this option to clear the author and created date. When not specified, the values from the source file are used.
@@ -50,25 +50,25 @@ When you specify a value for `nameConflictBehavior`, consider the following:
50
50
 
51
51
  ## Examples
52
52
 
53
- Copy a file by server-relative URL to a document library in another site collection with server relative URL
53
+ Copy a file by server-relative URL to a document library in another site collection with server relative URL.
54
54
 
55
55
  ```sh
56
56
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
57
57
  ```
58
58
 
59
- Copy a file by site-relative URL to a document library in another site collection and clear the author and created date
59
+ Copy a file by site-relative URL to a document library in another site collection and clear the author and created date.
60
60
 
61
61
  ```sh
62
62
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --resetAuthorAndCreated
63
63
  ```
64
64
 
65
- Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file
65
+ Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file.
66
66
 
67
67
  ```sh
68
68
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf"
69
69
  ```
70
70
 
71
- Copy file by sourceId (UniqueId) to a document library in another site collection with a new name, rename the file if it already exists
71
+ Copy file by sourceId (UniqueId) to a document library in another site collection with a new name, rename the file if it already exists.
72
72
 
73
73
  ```sh
74
74
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf" --nameConflictBehavior rename
@@ -16,83 +16,83 @@ m365 spo file get [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-u, --webUrl <webUrl>`
19
- : The URL of the site where the file is located
19
+ : The URL of the site where the file is located.
20
20
 
21
21
  `--url [url]`
22
- : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both
22
+ : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both
25
+ : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
26
26
 
27
27
  `--asString`
28
- : Set to retrieve the contents of the specified file as string
28
+ : Set to retrieve the contents of the specified file as string.
29
29
 
30
30
  `--asListItem`
31
- : Set to retrieve the underlying list item
31
+ : Set to retrieve the underlying list item.
32
32
 
33
33
  `--asFile`
34
- : Set to save the file to the path specified in the path option
34
+ : Set to save the file to the path specified in the path option.
35
35
 
36
36
  `-p, --path [path]`
37
- : The local path where to save the retrieved file. Must be specified when the `--asFile` option is used
37
+ : The local path where to save the retrieved file. Must be specified when the `--asFile` option is used.
38
38
 
39
39
  `--withPermissions`
40
- : Set if you want to return associated roles and permissions
40
+ : Set if you want to return associated roles and permissions.
41
41
  ```
42
42
 
43
43
  <Global />
44
44
 
45
45
  ## Examples
46
46
 
47
- Get file properties for a file with id (UniqueId) parameter located in a site
47
+ Get file properties for a file with id (UniqueId) parameter located in a site.
48
48
 
49
49
  ```sh
50
50
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
51
51
  ```
52
52
 
53
- Get contents of the file with id (UniqueId) parameter located in a site
53
+ Get contents of the file with id (UniqueId) parameter located in a site.
54
54
 
55
55
  ```sh
56
56
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asString
57
57
  ```
58
58
 
59
- Get list item properties for a file with id (UniqueId) parameter located in a site
59
+ Get list item properties for a file with id (UniqueId) parameter located in a site.
60
60
 
61
61
  ```sh
62
62
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asListItem
63
63
  ```
64
64
 
65
- Saves the file with id (UniqueId) parameter located in a site to a local file
65
+ Saves the file with id (UniqueId) parameter located in a site to a local file.
66
66
 
67
67
  ```sh
68
68
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asFile --path /Users/user/documents/SavedAsTest1.docx
69
69
  ```
70
70
 
71
- Return file properties for a file with server-relative url located in a site
71
+ Return file properties for a file with server-relative url located in a site.
72
72
 
73
73
  ```sh
74
74
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
75
75
  ```
76
76
 
77
- Returns a file as string for a file with server-relative url located in a site
77
+ Returns a file as string for a file with server-relative url located in a site.
78
78
 
79
79
  ```sh
80
80
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asString
81
81
  ```
82
82
 
83
- Returna the list item properties for a file with the server-relative url located in a site
83
+ Returns the list item properties for a file with the server-relative url located in a site.
84
84
 
85
85
  ```sh
86
86
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asListItem
87
87
  ```
88
88
 
89
- Saves a file with the server-relative url located in a site to a local file
89
+ Saves a file with the server-relative url located in a site to a local file.
90
90
 
91
91
  ```sh
92
92
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asFile --path /Users/user/documents/SavedAsTest1.docx
93
93
  ```
94
94
 
95
- Gets the file properties for a file with id (UniqueId) parameter located in a site with permissions
95
+ Gets the file properties for a file with id (UniqueId) parameter located in a site with permissions.
96
96
 
97
97
  ```sh
98
98
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --withPermissions
@@ -166,6 +166,42 @@ m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id '
166
166
  ,2,"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",0,"""{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1""",1,,5987,1,,,1,0,Test1.docx,/sites/project-x/documents/Test1.docx,2022-10-30T10:16:18Z,2022-10-30T10:16:18Z,,512,1.0,b2307a39-e878-458b-bc90-03bc578531d6
167
167
  ```
168
168
 
169
+ </TabItem>
170
+ <TabItem value="Markdown">
171
+
172
+ ```md
173
+ # spo file get --webUrl "https://contoso.sharepoint.com/sites/project-x" --url "/sites/project-x/shared documents/Document.docx"
174
+
175
+ Date: 10/3/2023
176
+
177
+ ## b2307a39-e878-458b-bc90-03bc578531d6
178
+
179
+ Property | Value
180
+ ---------|-------
181
+ CheckInComment |
182
+ CheckOutType | 2
183
+ ContentTag | {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
184
+ CustomizedPageStatus | 0
185
+ ETag | "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
186
+ Exists | true
187
+ ExistsAllowThrowForPolicyFailures | true
188
+ IrmEnabled | false
189
+ Length | 5987
190
+ Level | 1
191
+ LinkingUri | https://contoso.sharepoint.com/sites/project-x/shared%20documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
192
+ LinkingUrl | https://contoso.sharepoint.com/sites/project-x/shared documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
193
+ MajorVersion | 1
194
+ MinorVersion | 0
195
+ Name | Document.docx
196
+ ServerRelativeUrl | /sites/project-x/shared documents/Document.docx
197
+ TimeCreated | 2023-05-23T09:51:34Z
198
+ TimeLastModified | 2023-05-23T10:13:01Z
199
+ Title |
200
+ UIVersion | 1536
201
+ UIVersionLabel | 1.0
202
+ UniqueId | b2307a39-e878-458b-bc90-03bc578531d6
203
+ ```
204
+
169
205
  </TabItem>
170
206
  </Tabs>
171
207
 
@@ -310,5 +346,40 @@ When we make use of the option `withPermissions` the response will differ.
310
346
  ```
311
347
 
312
348
  </TabItem>
313
- </Tabs>
349
+ <TabItem value="Markdown">
350
+
351
+ ```md
352
+ # spo file get --webUrl "https://contoso.sharepoint.com/sites/project-x" --url "/sites/project-x/shared documents/Document.docx" --withPermissions "true"
353
+
354
+ Date: 10/3/2023
355
+
356
+ ## b2307a39-e878-458b-bc90-03bc578531d6
357
+
358
+ Property | Value
359
+ ---------|-------
360
+ CheckInComment |
361
+ CheckOutType | 2
362
+ ContentTag | {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
363
+ CustomizedPageStatus | 0
364
+ ETag | "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
365
+ Exists | true
366
+ ExistsAllowThrowForPolicyFailures | true
367
+ IrmEnabled | false
368
+ Length | 33454
369
+ Level | 1
370
+ LinkingUri | https://contoso.sharepoint.com/sites/project-x/shared%20documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
371
+ LinkingUrl | https://contoso.sharepoint.com/sites/project-x/shared documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
372
+ MajorVersion | 1
373
+ MinorVersion | 0
374
+ Name | Document3.docx
375
+ ServerRelativeUrl | /sites/project-x/shared documents/Document3.docx
376
+ TimeCreated | 2023-05-23T09:51:34Z
377
+ TimeLastModified | 2023-05-23T10:13:01Z
378
+ Title |
379
+ UIVersion | 1536
380
+ UIVersionLabel | 1.0
381
+ UniqueId | b2307a39-e878-458b-bc90-03bc578531d6
382
+ ```
314
383
 
384
+ </TabItem>
385
+ </Tabs>