@pnp/cli-microsoft365 7.1.0-beta.aca68bd → 7.1.0-beta.ba486fa

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 (253) hide show
  1. package/.devcontainer/Dockerfile +0 -1
  2. package/.eslintrc.cjs +1 -0
  3. package/Dockerfile +0 -1
  4. package/dist/Auth.js +2 -2
  5. package/dist/Command.js +18 -28
  6. package/dist/appInsights.js +5 -9
  7. package/dist/cli/Cli.js +9 -4
  8. package/dist/m365/aad/commands/group/group-user-list.js +146 -0
  9. package/dist/m365/aad/commands/m365group/m365group-remove.js +109 -15
  10. package/dist/m365/aad/commands.js +1 -0
  11. package/dist/m365/cli/commands/cli-doctor.js +11 -6
  12. package/dist/m365/commands/setup.js +6 -1
  13. package/dist/m365/spo/commands/app/app-deploy.js +1 -1
  14. package/dist/m365/spo/commands/app/app-get.js +1 -1
  15. package/dist/m365/spo/commands/app/app-teamspackage-download.js +1 -1
  16. package/dist/m365/spo/commands/apppage/apppage-add.js +1 -1
  17. package/dist/m365/spo/commands/feature/feature-disable.js +8 -6
  18. package/dist/m365/spo/commands/feature/feature-enable.js +6 -5
  19. package/dist/m365/spo/commands/page/Page.js +1 -1
  20. package/dist/m365/spo/commands/page/page-add.js +1 -1
  21. package/dist/m365/spo/commands/page/page-get.js +1 -1
  22. package/dist/m365/spo/commands/page/page-header-set.js +1 -1
  23. package/dist/m365/spo/commands/page/page-remove.js +1 -1
  24. package/dist/m365/spo/commands/page/page-set.js +2 -2
  25. package/dist/m365/spo/commands/page/page-text-add.js +1 -1
  26. package/dist/m365/spo/commands/sitedesign/sitedesign-get.js +15 -14
  27. package/dist/m365/spo/commands/sitedesign/sitedesign-remove.js +22 -22
  28. package/dist/m365/spo/commands/user/user-get.js +7 -1
  29. package/dist/m365/todo/commands/task/task-list.js +8 -10
  30. package/dist/m365/todo/commands/task/task-remove.js +36 -36
  31. package/dist/m365/todo/commands/task/task-set.js +11 -13
  32. package/dist/m365/yammer/commands/group/group-user-remove.js +22 -23
  33. package/dist/telemetry.js +30 -14
  34. package/dist/telemetryRunner.js +26 -0
  35. package/dist/utils/odata.js +20 -19
  36. package/dist/utils/prompt.js +16 -0
  37. package/docs/docs/cmd/aad/group/group-user-list.mdx +135 -0
  38. package/docs/docs/cmd/aad/license/license-list.mdx +21 -16
  39. package/docs/docs/cmd/aad/m365group/m365group-add.mdx +1 -1
  40. package/docs/docs/cmd/aad/m365group/m365group-remove.mdx +11 -1
  41. package/docs/docs/cmd/aad/user/user-add.mdx +2 -4
  42. package/docs/docs/cmd/aad/user/user-license-add.mdx +2 -4
  43. package/docs/docs/cmd/aad/user/user-license-list.mdx +3 -5
  44. package/docs/docs/cmd/aad/user/user-recyclebinitem-list.mdx +1 -3
  45. package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.mdx +1 -3
  46. package/docs/docs/cmd/flow/environment/environment-get.mdx +3 -4
  47. package/docs/docs/cmd/flow/environment/environment-list.mdx +3 -4
  48. package/docs/docs/cmd/flow/owner/owner-list.mdx +2 -3
  49. package/docs/docs/cmd/flow/run/run-list.mdx +6 -8
  50. package/docs/docs/cmd/graph/schemaextension/schemaextension-list.mdx +2 -3
  51. package/docs/docs/cmd/onenote/page/page-list.mdx +6 -9
  52. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -15
  53. package/docs/docs/cmd/outlook/message/message-list.mdx +5 -14
  54. package/docs/docs/cmd/outlook/room/room-list.mdx +3 -6
  55. package/docs/docs/cmd/outlook/roomlist/roomlist-list.mdx +1 -3
  56. package/docs/docs/cmd/pa/app/app-get.mdx +4 -7
  57. package/docs/docs/cmd/pa/app/app-list.mdx +4 -7
  58. package/docs/docs/cmd/pa/connector/connector-list.mdx +2 -4
  59. package/docs/docs/cmd/pa/environment/environment-get.mdx +2 -4
  60. package/docs/docs/cmd/pa/environment/environment-list.mdx +1 -3
  61. package/docs/docs/cmd/planner/plan/plan-add.mdx +4 -11
  62. package/docs/docs/cmd/planner/plan/plan-get.mdx +4 -9
  63. package/docs/docs/cmd/planner/plan/plan-list.mdx +3 -6
  64. package/docs/docs/cmd/planner/plan/plan-set.mdx +3 -9
  65. package/docs/docs/cmd/planner/roster/roster-member-add.mdx +2 -4
  66. package/docs/docs/cmd/planner/roster/roster-member-get.mdx +2 -4
  67. package/docs/docs/cmd/planner/roster/roster-member-list.mdx +1 -3
  68. package/docs/docs/cmd/planner/task/task-add.mdx +4 -14
  69. package/docs/docs/cmd/planner/task/task-checklistitem-add.mdx +2 -4
  70. package/docs/docs/cmd/planner/task/task-checklistitem-list.mdx +1 -3
  71. package/docs/docs/cmd/planner/task/task-get.mdx +0 -7
  72. package/docs/docs/cmd/planner/task/task-list.mdx +1 -5
  73. package/docs/docs/cmd/planner/task/task-reference-add.mdx +0 -2
  74. package/docs/docs/cmd/planner/task/task-reference-list.mdx +0 -2
  75. package/docs/docs/cmd/planner/task/task-set.mdx +4 -13
  76. package/docs/docs/cmd/planner/tenant/tenant-settings-list.mdx +1 -3
  77. package/docs/docs/cmd/planner/tenant/tenant-settings-set.mdx +3 -5
  78. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.mdx +6 -8
  79. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.mdx +4 -7
  80. package/docs/docs/cmd/pp/card/card-get.mdx +4 -8
  81. package/docs/docs/cmd/pp/card/card-list.mdx +0 -4
  82. package/docs/docs/cmd/pp/chatbot/chatbot-get.mdx +4 -6
  83. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.mdx +3 -14
  84. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.mdx +3 -14
  85. package/docs/docs/cmd/pp/environment/environment-get.mdx +3 -5
  86. package/docs/docs/cmd/pp/environment/environment-list.mdx +2 -4
  87. package/docs/docs/cmd/pp/gateway/gateway-get.mdx +0 -3
  88. package/docs/docs/cmd/pp/gateway/gateway-list.mdx +1 -4
  89. package/docs/docs/cmd/purview/auditlog/auditlog-list.mdx +4 -0
  90. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx +3 -8
  91. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx +1 -3
  92. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx +1 -5
  93. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx +0 -2
  94. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.mdx +1 -3
  95. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.mdx +1 -3
  96. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.mdx +3 -6
  97. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.mdx +3 -5
  98. package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +4 -8
  99. package/docs/docs/cmd/spo/app/app-add.mdx +94 -7
  100. package/docs/docs/cmd/spo/app/app-deploy.mdx +11 -7
  101. package/docs/docs/cmd/spo/app/app-get.mdx +117 -8
  102. package/docs/docs/cmd/spo/app/app-install.mdx +9 -5
  103. package/docs/docs/cmd/spo/app/app-instance-list.mdx +85 -2
  104. package/docs/docs/cmd/spo/app/app-list.mdx +95 -3
  105. package/docs/docs/cmd/spo/app/app-remove.mdx +11 -7
  106. package/docs/docs/cmd/spo/app/app-retract.mdx +9 -5
  107. package/docs/docs/cmd/spo/app/app-teamspackage-download.mdx +12 -8
  108. package/docs/docs/cmd/spo/app/app-uninstall.mdx +11 -7
  109. package/docs/docs/cmd/spo/app/app-upgrade.mdx +9 -5
  110. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx +4 -2
  111. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +9 -7
  112. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +6 -6
  113. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx +12 -6
  114. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +4 -2
  115. package/docs/docs/cmd/spo/apppage/apppage-add.mdx +54 -5
  116. package/docs/docs/cmd/spo/apppage/apppage-set.mdx +8 -4
  117. package/docs/docs/cmd/spo/cdn/cdn-get.mdx +36 -1
  118. package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +7 -3
  119. package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +48 -3
  120. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +8 -4
  121. package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +53 -3
  122. package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +7 -3
  123. package/docs/docs/cmd/spo/cdn/cdn-set.mdx +7 -3
  124. package/docs/docs/cmd/spo/commandset/commandset-add.mdx +6 -6
  125. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +3 -5
  126. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +6 -5
  127. package/docs/docs/cmd/spo/commandset/commandset-remove.mdx +7 -3
  128. package/docs/docs/cmd/spo/commandset/commandset-set.mdx +6 -4
  129. package/docs/docs/cmd/spo/contenttype/contenttype-add.mdx +148 -9
  130. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +19 -15
  131. package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +12 -8
  132. package/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +147 -8
  133. package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +115 -4
  134. package/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx +8 -4
  135. package/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +8 -4
  136. package/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx +44 -0
  137. package/docs/docs/cmd/spo/customaction/customaction-add.mdx +12 -8
  138. package/docs/docs/cmd/spo/customaction/customaction-clear.mdx +10 -7
  139. package/docs/docs/cmd/spo/customaction/customaction-get.mdx +11 -15
  140. package/docs/docs/cmd/spo/customaction/customaction-list.mdx +87 -5
  141. package/docs/docs/cmd/spo/customaction/customaction-remove.mdx +17 -13
  142. package/docs/docs/cmd/spo/customaction/customaction-set.mdx +27 -23
  143. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +29 -14
  144. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx +66 -5
  145. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx +4 -0
  146. package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +78 -7
  147. package/docs/docs/cmd/spo/feature/feature-disable.mdx +10 -6
  148. package/docs/docs/cmd/spo/feature/feature-enable.mdx +9 -5
  149. package/docs/docs/cmd/spo/feature/feature-list.mdx +52 -0
  150. package/docs/docs/cmd/spo/field/field-add.mdx +177 -11
  151. package/docs/docs/cmd/spo/field/field-get.mdx +175 -9
  152. package/docs/docs/cmd/spo/field/field-list.mdx +135 -8
  153. package/docs/docs/cmd/spo/field/field-remove.mdx +16 -12
  154. package/docs/docs/cmd/spo/field/field-set.mdx +15 -11
  155. package/docs/docs/cmd/spo/file/file-add.mdx +31 -27
  156. package/docs/docs/cmd/spo/file/file-checkin.mdx +13 -9
  157. package/docs/docs/cmd/spo/file/file-checkout.mdx +9 -5
  158. package/docs/docs/cmd/spo/file/file-copy.mdx +5 -5
  159. package/docs/docs/cmd/spo/file/file-get.mdx +89 -18
  160. package/docs/docs/cmd/spo/file/file-list.mdx +5 -5
  161. package/docs/docs/cmd/spo/file/file-move.mdx +5 -5
  162. package/docs/docs/cmd/spo/file/file-remove.mdx +13 -9
  163. package/docs/docs/cmd/spo/file/file-rename.mdx +63 -5
  164. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +3 -3
  165. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +2 -2
  166. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +4 -0
  167. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +7 -3
  168. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +9 -5
  169. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +10 -6
  170. package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +133 -5
  171. package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +21 -3
  172. package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +2 -2
  173. package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +18 -0
  174. package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +20 -3
  175. package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +2 -7
  176. package/docs/docs/cmd/spo/file/file-version-clear.mdx +7 -7
  177. package/docs/docs/cmd/spo/file/file-version-get.mdx +28 -6
  178. package/docs/docs/cmd/spo/file/file-version-list.mdx +28 -6
  179. package/docs/docs/cmd/spo/file/file-version-remove.mdx +8 -8
  180. package/docs/docs/cmd/spo/file/file-version-restore.mdx +8 -8
  181. package/docs/docs/cmd/spo/folder/folder-add.mdx +3 -3
  182. package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
  183. package/docs/docs/cmd/spo/folder/folder-get.mdx +257 -3
  184. package/docs/docs/cmd/spo/folder/folder-list.mdx +3 -4
  185. package/docs/docs/cmd/spo/folder/folder-move.mdx +5 -5
  186. package/docs/docs/cmd/spo/folder/folder-remove.mdx +6 -2
  187. package/docs/docs/cmd/spo/folder/folder-rename.mdx +2 -2
  188. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +3 -3
  189. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +2 -2
  190. package/docs/docs/cmd/spo/folder/folder-roleassignment-add.mdx +13 -8
  191. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.mdx +8 -4
  192. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.mdx +4 -0
  193. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.mdx +5 -1
  194. package/docs/docs/cmd/spo/group/group-add.mdx +78 -0
  195. package/docs/docs/cmd/spo/group/group-get.mdx +81 -3
  196. package/docs/docs/cmd/spo/group/group-list.mdx +74 -3
  197. package/docs/docs/cmd/spo/group/group-member-add.mdx +13 -21
  198. package/docs/docs/cmd/spo/group/group-member-list.mdx +80 -5
  199. package/docs/docs/cmd/spo/group/group-member-remove.mdx +4 -4
  200. package/docs/docs/cmd/spo/group/group-remove.mdx +10 -6
  201. package/docs/docs/cmd/spo/group/group-set.mdx +9 -5
  202. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +36 -1
  203. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +6 -2
  204. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.mdx +0 -2
  205. package/docs/docs/cmd/spo/list/list-add.mdx +0 -3
  206. package/docs/docs/cmd/spo/list/list-contenttype-add.mdx +0 -2
  207. package/docs/docs/cmd/spo/list/list-contenttype-list.mdx +0 -2
  208. package/docs/docs/cmd/spo/list/list-get.mdx +1 -4
  209. package/docs/docs/cmd/spo/list/list-list.mdx +0 -4
  210. package/docs/docs/cmd/spo/list/list-view-add.mdx +0 -3
  211. package/docs/docs/cmd/spo/list/list-view-get.mdx +9 -12
  212. package/docs/docs/cmd/spo/list/list-view-list.mdx +4 -7
  213. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx +8 -11
  214. package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -2
  215. package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +4 -6
  216. package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +0 -2
  217. package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +4 -6
  218. package/docs/docs/cmd/spo/page/page-copy.mdx +4 -8
  219. package/docs/docs/cmd/spo/page/page-get.mdx +2 -5
  220. package/docs/docs/cmd/spo/page/page-list.mdx +1 -5
  221. package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +4 -4
  222. package/docs/docs/cmd/spo/sitescript/sitescript-set.mdx +6 -7
  223. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx +3 -1
  224. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +5 -3
  225. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +4 -2
  226. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.mdx +5 -1
  227. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +2 -0
  228. package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +2 -1
  229. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +5 -2
  230. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +4 -1
  231. package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.mdx +5 -1
  232. package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +3 -1
  233. package/docs/docs/cmd/spo/user/user-get.mdx +6 -0
  234. package/docs/docs/cmd/teams/channel/channel-member-list.mdx +3 -5
  235. package/docs/docs/cmd/teams/channel/channel-member-set.mdx +0 -2
  236. package/docs/docs/cmd/teams/chat/chat-get.mdx +2 -4
  237. package/docs/docs/cmd/teams/chat/chat-list.mdx +1 -3
  238. package/docs/docs/cmd/teams/chat/chat-member-list.mdx +2 -4
  239. package/docs/docs/cmd/teams/message/message-get.mdx +0 -7
  240. package/docs/docs/cmd/teams/message/message-list.mdx +0 -6
  241. package/docs/docs/cmd/teams/message/message-reply-list.mdx +0 -6
  242. package/docs/docs/cmd/teams/tab/tab-add.mdx +10 -12
  243. package/docs/docs/cmd/teams/tab/tab-get.mdx +8 -10
  244. package/docs/docs/cmd/teams/tab/tab-list.mdx +4 -7
  245. package/docs/docs/cmd/teams/team/team-add.mdx +0 -7
  246. package/docs/docs/cmd/teams/team/team-get.mdx +0 -6
  247. package/docs/docs/cmd/tenant/security/security-alerts-list.mdx +1 -1
  248. package/docs/docs/cmd/todo/task/task-add.mdx +9 -13
  249. package/docs/docs/cmd/todo/task/task-set.mdx +10 -14
  250. package/eslint-rules/lib/index.js +2 -1
  251. package/eslint-rules/lib/rules/no-by-server-relative-url-usage.js +55 -0
  252. package/npm-shrinkwrap.json +86 -82
  253. package/package.json +52 -31
@@ -14,7 +14,7 @@ m365 spo folder retentionlabel ensure [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : URL of the site where the retention label from a file to apply is located
17
+ : URL of the site where the retention label from a file to apply is located.
18
18
 
19
19
  `--folderUrl [folderUrl]`
20
20
  : The server- or site-relative decoded URL of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
@@ -34,13 +34,13 @@ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listite
34
34
 
35
35
  ## Examples
36
36
 
37
- Applies a retention label to a folder based on the label name and the folderUrl
37
+ Applies a retention label to a folder based on the label name and the folderUrl.
38
38
 
39
39
  ```sh
40
40
  m365 spo folder retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl '/Shared Documents' --name 'Some label'
41
41
  ```
42
42
 
43
- Applies a retention label to a folder based on the label name and the folderId
43
+ Applies a retention label to a folder based on the label name and the folderId.
44
44
 
45
45
  ```sh
46
46
  m365 spo folder retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --folderId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
@@ -30,13 +30,13 @@ m365 spo folder retentionlabel remove [options]
30
30
 
31
31
  ## Examples
32
32
 
33
- Removes the retention label from a folder in a given site based on the folder id
33
+ Removes the retention label from a folder in a given site based on the folder id.
34
34
 
35
35
  ```sh
36
36
  m365 spo folder retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderId 0cd891ef-afce-4e55-b836-fce03286cccf
37
37
  ```
38
38
 
39
- Removes the retention label from a folder in a given site based on the folder url
39
+ Removes the retention label from a folder in a given site based on the folder url.
40
40
 
41
41
  ```sh
42
42
  m365 spo folder retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl /sites/project-x/Shared Documents/Folder --id 1
@@ -20,19 +20,19 @@ m365 spo folder roleassignment add [options]
20
20
  : The server- or site-relative decoded URL of the folder.
21
21
 
22
22
  `--principalId [principalId]`
23
- : The SharePoint principal id. It may be either an user id or group id for which the role assignment will be addd. Specify either upn, groupName or principalId but not multiple.
23
+ : The SharePoint principal id. It may be either an user id or group id for which the role assignment will be addd. Specify either `upn`, `groupName` or `principalId` but not multiple.
24
24
 
25
25
  `--upn [upn]`
26
- : The upn/email of the user. Specify either upn, groupName or principalId but not multiple.
26
+ : The upn/email of the user. Specify either `upn`, `groupName` or `principalId` but not multiple.
27
27
 
28
28
  `--groupName [groupName]`
29
- : The Azure AD or SharePoint group name. Specify either upn, groupName or principalId but not multiple.
29
+ : The Azure AD or SharePoint group name. Specify either `upn`, `groupName` or `principalId` but not multiple.
30
30
 
31
31
  `--roleDefinitionId [roleDefinitionId]`
32
- : ID of the role definition. Specify either roleDefinitionId or roleDefinitionName but not both.
32
+ : ID of the role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
33
33
 
34
34
  `--roleDefinitionName [roleDefinitionName]`
35
- : The name of the role definition. E.g. 'Contribute', 'Read'. Specify either roleDefinitionId or roleDefinitionName but not both.
35
+ : The name of the role definition. E.g. 'Contribute', 'Read'. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
36
36
  ```
37
37
 
38
38
  <Global />
@@ -45,19 +45,24 @@ Add the role assignment to the specified folder based on the group name and role
45
45
  m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --groupName "saleGroup" --roleDefinitionName "Edit"
46
46
  ```
47
47
 
48
- Add the role assignment to the specified folder based on the principal Id and role definition id
48
+ Add the role assignment to the specified folder based on the principal Id and role definition id.
49
49
 
50
50
  ```sh
51
51
  m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --principalId 2 --roleDefinitionId 1073741827
52
52
  ```
53
53
 
54
- Add the role assignment to the specified folder based on the upn and role definition name
54
+ Add the role assignment to the specified folder based on the upn and role definition name.
55
55
 
56
56
  ```sh
57
57
  m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --upn "test@contoso.onmicrosoft.com" --roleDefinitionName "Edit"
58
58
  ```
59
- Add the role assignment to the root folder based on the upn and role definition name
59
+
60
+ Add the role assignment to the root folder based on the upn and role definition name.
60
61
 
61
62
  ```sh
62
63
  m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents" --upn "test@contoso.onmicrosoft.com" --roleDefinitionName "Edit"
63
64
  ```
65
+
66
+ ## Response
67
+
68
+ The command won't return a response on success.
@@ -20,13 +20,13 @@ m365 spo folder roleassignment remove [options]
20
20
  : The server- or site-relative decoded URL of the folder.
21
21
 
22
22
  `--principalId [principalId]`
23
- : The SharePoint principal id. It may be either an user id or group id for which the role assignment will be removed. Specify either upn, groupName or principalId but not multiple.
23
+ : The SharePoint principal id. It may be either an user id or group id for which the role assignment will be removed. Specify either `upn`, `groupName` or `principalId` but not multiple.
24
24
 
25
25
  `--upn [upn]`
26
- : The upn/email of the user. Specify either upn, groupName or principalId but not multiple.
26
+ : The upn/email of the user. Specify either `upn`, `groupName` or `principalId` but not multiple.
27
27
 
28
28
  `--groupName [groupName]`
29
- : The Azure AD or SharePoint group name. Specify either upn, groupName or principalId but not multiple.
29
+ : The Azure AD or SharePoint group name. Specify either `upn`, `groupName` or `principalId` but not multiple.
30
30
 
31
31
  `-f, --force`
32
32
  : Don't prompt for confirmation when removing the role assignment.
@@ -36,7 +36,7 @@ m365 spo folder roleassignment remove [options]
36
36
 
37
37
  ## Examples
38
38
 
39
- Remove roleassignment from folder based on group name
39
+ Remove roleassignment from folder based on group name.
40
40
 
41
41
  ```sh
42
42
  m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --groupName "saleGroup"
@@ -59,3 +59,7 @@ Remove the role assignment from the specified folder based on the upn.
59
59
  ```sh
60
60
  m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --upn "test@contoso.onmicrosoft.com"
61
61
  ```
62
+
63
+ ## Response
64
+
65
+ The command won't return a response on success.
@@ -47,3 +47,7 @@ Break the inheritance of the specified root folder for the library with a specif
47
47
  ```sh
48
48
  m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --clearExistingPermissions --force
49
49
  ```
50
+
51
+ ## Response
52
+
53
+ The command won't return a response on success.
@@ -27,7 +27,7 @@ m365 spo folder roleinheritance reset [options]
27
27
 
28
28
  ## Examples
29
29
 
30
- Reset inheritance of folder with a specific site-relative URL
30
+ Reset inheritance of folder with a specific site-relative URL.
31
31
 
32
32
  ```sh
33
33
  m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
@@ -44,3 +44,7 @@ Reset inheritance of the specified root folder for the library with a specific s
44
44
  ```sh
45
45
  m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --force
46
46
  ```
47
+
48
+ ## Response
49
+
50
+ The command won't return a response on success.
@@ -1,4 +1,6 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo group add
4
6
 
@@ -53,3 +55,79 @@ Create group with membership requests
53
55
  ```sh
54
56
  m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
55
57
  ```
58
+
59
+ ## Response
60
+
61
+ <Tabs>
62
+ <TabItem value="JSON">
63
+
64
+ ```json
65
+ {
66
+ "Id": 37,
67
+ "IsHiddenInUI": false,
68
+ "LoginName": "Project leaders",
69
+ "Title": "Project leaders",
70
+ "PrincipalType": 8,
71
+ "AllowMembersEditMembership": false,
72
+ "AllowRequestToJoinLeave": false,
73
+ "AutoAcceptRequestToJoinLeave": false,
74
+ "Description": "This group contains all project leaders",
75
+ "OnlyAllowMembersViewMembership": true,
76
+ "OwnerTitle": "Jon Doe",
77
+ "RequestToJoinLeaveEmailSetting": null
78
+ }
79
+ ```
80
+
81
+ </TabItem>
82
+ <TabItem value="Text">
83
+
84
+ ```text
85
+ AllowMembersEditMembership : false
86
+ AllowRequestToJoinLeave : false
87
+ AutoAcceptRequestToJoinLeave : false
88
+ Description : This group contains all project leaders
89
+ Id : 38
90
+ IsHiddenInUI : false
91
+ LoginName : Project leaders
92
+ OnlyAllowMembersViewMembership: true
93
+ OwnerTitle : Jon Doe
94
+ PrincipalType : 8
95
+ RequestToJoinLeaveEmailSetting: null
96
+ Title : Project leaders
97
+ ```
98
+
99
+ </TabItem>
100
+ <TabItem value="CSV">
101
+
102
+ ```csv
103
+ Id,IsHiddenInUI,LoginName,Title,PrincipalType,AllowMembersEditMembership,AllowRequestToJoinLeave,AutoAcceptRequestToJoinLeave,Description,OnlyAllowMembersViewMembership,OwnerTitle
104
+ 39,,Project leaders,Project leaders,8,,,,This group contains all project leaders,1,Jon Doe
105
+ ```
106
+
107
+ </TabItem>
108
+ <TabItem value="Markdown">
109
+
110
+ ```md
111
+ # spo group add --webUrl "https://contoso.sharepoint.com/sites/project-x" --name "Project leaders" --description "This group contains all project leaders"
112
+
113
+ Date: 10/3/2023
114
+
115
+ ## Project leaders (40)
116
+
117
+ Property | Value
118
+ ---------|-------
119
+ Id | 40
120
+ IsHiddenInUI | false
121
+ LoginName | Project leaders
122
+ Title | Project leaders
123
+ PrincipalType | 8
124
+ AllowMembersEditMembership | false
125
+ AllowRequestToJoinLeave | false
126
+ AutoAcceptRequestToJoinLeave | false
127
+ Description | This group contains all project leaders
128
+ OnlyAllowMembersViewMembership | true
129
+ OwnerTitle | Jon Doe
130
+ ```
131
+
132
+ </TabItem>
133
+ </Tabs>
@@ -1,4 +1,6 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo group get
4
6
 
@@ -30,20 +32,96 @@ m365 spo group get [options]
30
32
 
31
33
  ## Examples
32
34
 
33
- Get group with ID _7_ for web _https://contoso.sharepoint.com/sites/project-x_
35
+ Get group with ID for the specified web.
34
36
 
35
37
  ```sh
36
38
  m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --id 7
37
39
  ```
38
40
 
39
- Get group with name _Team Site Members_ for web _https://contoso.sharepoint.com/sites/project-x_
41
+ Get group with name for the specified web.
40
42
 
41
43
  ```sh
42
44
  m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --name "Team Site Members"
43
45
  ```
44
46
 
45
- Get the associated owner group of a specified site
47
+ Get the associated owner group of a specified site.
46
48
 
47
49
  ```sh
48
50
  m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --associatedGroup Owner
49
51
  ```
52
+
53
+ ## Response
54
+
55
+ <Tabs>
56
+ <TabItem value="JSON">
57
+
58
+ ```json
59
+ {
60
+ "Id": 40,
61
+ "IsHiddenInUI": false,
62
+ "LoginName": "Project leaders",
63
+ "Title": "Project leaders",
64
+ "PrincipalType": 8,
65
+ "AllowMembersEditMembership": false,
66
+ "AllowRequestToJoinLeave": false,
67
+ "AutoAcceptRequestToJoinLeave": false,
68
+ "Description": "This group contains all project leaders",
69
+ "OnlyAllowMembersViewMembership": true,
70
+ "OwnerTitle": "Jon Doe",
71
+ "RequestToJoinLeaveEmailSetting": null
72
+ }
73
+ ```
74
+
75
+ </TabItem>
76
+ <TabItem value="Text">
77
+
78
+ ```text
79
+ AllowMembersEditMembership : false
80
+ AllowRequestToJoinLeave : false
81
+ AutoAcceptRequestToJoinLeave : false
82
+ Description : This group contains all project leaders
83
+ Id : 40
84
+ IsHiddenInUI : false
85
+ LoginName : Project leaders
86
+ OnlyAllowMembersViewMembership: true
87
+ OwnerTitle : Jon Doe
88
+ PrincipalType : 8
89
+ RequestToJoinLeaveEmailSetting: null
90
+ Title : Project leaders
91
+ ```
92
+
93
+ </TabItem>
94
+ <TabItem value="CSV">
95
+
96
+ ```csv
97
+ Id,IsHiddenInUI,LoginName,Title,PrincipalType,AllowMembersEditMembership,AllowRequestToJoinLeave,AutoAcceptRequestToJoinLeave,Description,OnlyAllowMembersViewMembership,OwnerTitle
98
+ 40,,Project leaders,Project leaders,8,,,,This group contains all project leaders,1,Jon Doe
99
+ ```
100
+
101
+ </TabItem>
102
+ <TabItem value="Markdown">
103
+
104
+ ```md
105
+ # spo group get --webUrl "https://contoso.sharepoint.com/sites/project-x" --name "Project leaders"
106
+
107
+ Date: 10/3/2023
108
+
109
+ ## Project leaders (40)
110
+
111
+ Property | Value
112
+ ---------|-------
113
+ Id | 40
114
+ IsHiddenInUI | false
115
+ LoginName | Project leaders
116
+ Title | Project leaders
117
+ PrincipalType | 8
118
+ AllowMembersEditMembership | false
119
+ AllowRequestToJoinLeave | false
120
+ AutoAcceptRequestToJoinLeave | false
121
+ Description | This group contains all project leaders
122
+ OnlyAllowMembersViewMembership | true
123
+ OwnerTitle | Jon Doe
124
+ ```
125
+
126
+ </TabItem>
127
+ </Tabs>
@@ -1,4 +1,6 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo group list
4
6
 
@@ -14,7 +16,7 @@ m365 spo group list [options]
14
16
 
15
17
  ```md definition-list
16
18
  `-u, --webUrl <webUrl>`
17
- : Url of the web to list the group within
19
+ : Url of the web to list the group within.
18
20
 
19
21
  `--associatedGroupsOnly`
20
22
  : Get only the associated visitor, member and owner groups of the site.
@@ -24,14 +26,83 @@ m365 spo group list [options]
24
26
 
25
27
  ## Examples
26
28
 
27
- Lists all the groups within a specific web
29
+ Lists all the groups within a specific web.
28
30
 
29
31
  ```sh
30
32
  m365 spo group list --webUrl "https://contoso.sharepoint.com/sites/contoso"
31
33
  ```
32
34
 
33
- Lists the associated groups within a specific web
35
+ Lists the associated groups within a specific web.
34
36
 
35
37
  ```sh
36
38
  m365 spo group list --webUrl "https://contoso.sharepoint.com/sites/contoso" --associatedGroupsOnly
37
39
  ```
40
+
41
+ ## Response
42
+
43
+ <Tabs>
44
+ <TabItem value="JSON">
45
+
46
+ ```json
47
+ [
48
+ {
49
+ "Id": 40,
50
+ "IsHiddenInUI": false,
51
+ "LoginName": "Project leaders",
52
+ "Title": "Project leaders",
53
+ "PrincipalType": 8,
54
+ "AllowMembersEditMembership": false,
55
+ "AllowRequestToJoinLeave": false,
56
+ "AutoAcceptRequestToJoinLeave": false,
57
+ "Description": "This group contains all project leaders",
58
+ "OnlyAllowMembersViewMembership": true,
59
+ "OwnerTitle": "Jon Doe",
60
+ "RequestToJoinLeaveEmailSetting": null
61
+ }
62
+ ]
63
+ ```
64
+
65
+ </TabItem>
66
+ <TabItem value="Text">
67
+
68
+ ```text
69
+ Id Title LoginName IsHiddenInUI PrincipalType
70
+ -- ---------------- ---------------- ------------ ------------- 14 Limited Access System Group Limited Access System Group false 8
71
+ 40 Project leaders Project leaders false 8 19 SharingLinks.303339bc-fc95-470d-bd14-d9d78f7f9851.OrganizationEdit.f3dd85c7-83e2-497d-b738-9cb245547d8e SharingLinks.303339bc-fc95-470d-bd14-d9d78f7f9851.OrganizationEdit.f3dd85c7-83e2-497d-b738-9cb245547d8e false 8 32 SharingLinks.ad2528e7-aee5-472f-bbd3-56a7e5b46814.OrganizationEdit.1ba739c5-e693-4c16-9dfa-042e4ec62972 SharingLinks.ad2528e7-aee5-472f-bbd3-56a7e5b46814.OrganizationEdit.1ba739c5-e693-4c16-9dfa-042e4ec62972 false 8 34 SharingLinks.b22c8e80-ba76-404e-88fa-73dbf5f417c0.AnonymousEdit.9239171b-d85c-4206-a852-45e8d61f9052 SharingLinks.b22c8e80-ba76-404e-88fa-73dbf5f417c0.AnonymousEdit.9239171b-d85c-4206-a852-45e8d61f9052 false 8 33 SharingLinks.b22c8e80-ba76-404e-88fa-73dbf5f417c0.OrganizationEdit.44934455-df4f-48a4-90c9-cd8aec82fa7b SharingLinks.b22c8e80-ba76-404e-88fa-73dbf5f417c0.OrganizationEdit.44934455-df4f-48a4-90c9-cd8aec82fa7b false 8 18 SharingLinks.c21d3841-8e04-410e-a0a7-9488790697ca.OrganizationEdit.eede1a56-f8ef-4a4d-8221-043a146b76bb SharingLinks.c21d3841-8e04-410e-a0a7-9488790697ca.OrganizationEdit.eede1a56-f8ef-4a4d-8221-043a146b76bb false 8 13 SharingLinks.d6af0b1f-9ac8-484d-b87a-38a4012c800a.OrganizationEdit.682b902f-f20b-408c-accd-427fc29c24ab SharingLinks.d6af0b1f-9ac8-484d-b87a-38a4012c800a.OrganizationEdit.682b902f-f20b-408c-accd-427fc29c24ab false 8
72
+ ```
73
+
74
+ </TabItem>
75
+ <TabItem value="CSV">
76
+
77
+ ```csv
78
+ Id,IsHiddenInUI,LoginName,Title,PrincipalType,AllowMembersEditMembership,AllowRequestToJoinLeave,AutoAcceptRequestToJoinLeave,Description,OnlyAllowMembersViewMembership,OwnerTitle
79
+ 40,,Project leaders,Project leaders,8,,,,This group contains all project leaders,1,Jon Doe
80
+ ```
81
+
82
+ </TabItem>
83
+ <TabItem value="Markdown">
84
+
85
+ ```md
86
+ # spo group list --webUrl "https://contoso.sharepoint.com/sites/contoso"
87
+
88
+ Date: 10/3/2023
89
+
90
+ ## Project leaders (40)
91
+
92
+ Property | Value
93
+ ---------|-------
94
+ Id | 40
95
+ IsHiddenInUI | false
96
+ LoginName | Project leaders
97
+ Title | Project leaders
98
+ PrincipalType | 8
99
+ AllowMembersEditMembership | false
100
+ AllowRequestToJoinLeave | false
101
+ AutoAcceptRequestToJoinLeave | false
102
+ Description | This group contains all project leaders
103
+ OnlyAllowMembersViewMembership | true
104
+ OwnerTitle | Jon Doe
105
+ ```
106
+
107
+ </TabItem>
108
+ </Tabs>
@@ -19,10 +19,10 @@ m365 spo group member add [options]
19
19
  : URL of the site where the SharePoint group is available.
20
20
 
21
21
  `--groupId [groupId]`
22
- : Id of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`.
22
+ : Id of the SharePoint Group to which the user needs to be added. Specify either `groupId` or `groupName`.
23
23
 
24
24
  `--groupName [groupName]`
25
- : Name of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`.
25
+ : Name of the SharePoint Group to which the user needs to be added. Specify either `groupId` or `groupName`.
26
26
 
27
27
  `--userNames [userNames]`
28
28
  : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma-separated (e.g. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userIds`, `userNames`, `emails`, `aadGroupIds` or `aadGroupNames`.
@@ -48,53 +48,47 @@ For the `userIds`, `userNames`, `emails`, `aadGroupIds` or `aadGroupNames` optio
48
48
 
49
49
  ## Examples
50
50
 
51
- Add a user with the userNames parameter to a SharePoint group with the groupId parameter
51
+ Add a user with the userNames parameter to a SharePoint group with the groupId parameter.
52
52
 
53
53
  ```sh
54
54
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userNames "Alex.Wilber@contoso.com"
55
55
  ```
56
56
 
57
- Add multiple users with the userNames parameter to a SharePoint group with the groupId parameter
57
+ Add multiple users with the userNames parameter to a SharePoint group with the groupId parameter.
58
58
 
59
59
  ```sh
60
60
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userNames "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
61
61
  ```
62
62
 
63
- Add a user with the emails parameter to a SharePoint group with the groupName parameter
63
+ Add a user with the emails parameter to a SharePoint group with the groupName parameter.
64
64
 
65
65
  ```sh
66
66
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --emails "Alex.Wilber@contoso.com"
67
67
  ```
68
68
 
69
- Add multiple users with the emails parameter to a SharePoint group with the groupName parameter
69
+ Add multiple users with the emails parameter to a SharePoint group with the groupName parameter.
70
70
 
71
71
  ```sh
72
72
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --emails "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
73
73
  ```
74
74
 
75
- Add a user with the userIds parameter to a SharePoint group with the groupId parameter
75
+ Add a user with the userIds parameter to a SharePoint group with the groupId parameter.
76
76
 
77
77
  ```sh
78
78
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userIds 5
79
79
  ```
80
80
 
81
- Add multiple users with the userIds parameter to a SharePoint group with the groupId parameter
81
+ Add multiple users with the userIds parameter to a SharePoint group with the groupId parameter.
82
82
 
83
83
  ```sh
84
84
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userIds "5,12"
85
85
  ```
86
86
 
87
- Add multiple users with the aadUserId parameter to a SharePoint group with the groupId parameter
88
-
89
- ```sh
90
- m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserId "56ca9023-3449-4e98-a96a-69e81a6f4983,a96c1755-8aec-4f4d-955f-08504510dc56"
91
- ```
92
-
93
- Add multiple users with the aadUserName parameter to a SharePoint group with the groupId parameter
94
-
95
- ```sh
96
- m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserName "Azure group one, Azure group two"
97
- ```
87
+ Add multiple users with the aadGroupNames parameter to a SharePoint group with the groupId parameter
88
+
89
+ ```sh
90
+ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadGroupNames "Azure group one, Azure group two"
91
+ ```
98
92
 
99
93
  ## Response
100
94
 
@@ -148,7 +142,6 @@ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --
148
142
 
149
143
  Property | Value
150
144
  ---------|-------
151
- AllowedRoles | [0]
152
145
  CurrentRole | 0
153
146
  DisplayName | All Company Members
154
147
  Email | allcompany@contoso.onmicrosoft.com
@@ -161,4 +154,3 @@ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --
161
154
 
162
155
  </TabItem>
163
156
  </Tabs>
164
-
@@ -1,4 +1,6 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo group member list
4
6
 
@@ -14,27 +16,100 @@ m365 spo group member list [options]
14
16
 
15
17
  ```md definition-list
16
18
  `-u, --webUrl <webUrl>`
17
- : URL of the SharePoint site
19
+ : URL of the SharePoint site.
18
20
 
19
21
  `--groupId [groupId]`
20
- : Id of the SharePoint group. Use either `groupName` or `groupId`, but not both
22
+ : Id of the SharePoint group. Specify either `groupName` or `groupId`, but not both.
21
23
 
22
24
  `--groupName [groupName]`
23
- : Name of the SharePoint group. Use either `groupName` or `groupId`, but not both
25
+ : Name of the SharePoint group. Specify either `groupName` or `groupId`, but not both.
24
26
  ```
25
27
 
26
28
  <Global />
27
29
 
28
30
  ## Examples
29
31
 
30
- List the members of the group with ID _5_ for web _https://contoso.sharepoint.com/sites/SiteA_
32
+ List the members of the group with ID for the specified web.
31
33
 
32
34
  ```sh
33
35
  m365 spo group member list --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5
34
36
  ```
35
37
 
36
- List the members of the group with name _Contoso Site Members_ for web _https://contoso.sharepoint.com/sites/SiteA_
38
+ List the members of the group with name for the specified web.
37
39
 
38
40
  ```sh
39
41
  m365 spo group member list --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Members"
40
42
  ```
43
+
44
+ ## Response
45
+
46
+ <Tabs>
47
+ <TabItem value="JSON">
48
+
49
+ ```json
50
+ [
51
+ {
52
+ "Id": 7,
53
+ "IsHiddenInUI": false,
54
+ "LoginName": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
55
+ "Title": "Jon Doe",
56
+ "PrincipalType": 1,
57
+ "Email": "admin@contoso.onmicrosoft.com",
58
+ "Expiration": "",
59
+ "IsEmailAuthenticationGuestUser": false,
60
+ "IsShareByEmailGuestUser": false,
61
+ "IsSiteAdmin": true,
62
+ "UserId": {
63
+ "NameId": "100320006513e584",
64
+ "NameIdIssuer": "urn:federation:microsoftonline"
65
+ },
66
+ "UserPrincipalName": "admin@contoso.onmicrosoft.com"
67
+ }
68
+ ]
69
+ ```
70
+
71
+ </TabItem>
72
+ <TabItem value="Text">
73
+
74
+ ```text
75
+ Email : admin@contoso.onmicrosoft.com
76
+ Id : 7
77
+ Title : Jon Doe
78
+ UserPrincipalName: admin@contoso.onmicrosoft.com
79
+ ```
80
+
81
+ </TabItem>
82
+ <TabItem value="CSV">
83
+
84
+ ```csv
85
+ Id,IsHiddenInUI,LoginName,Title,PrincipalType,Email,Expiration,IsEmailAuthenticationGuestUser,IsShareByEmailGuestUser,IsSiteAdmin,UserPrincipalName
86
+ 7,,i:0#.f|membership|admin@contoso.onmicrosoft.com,Jon Doe,1,admin@contoso.onmicrosoft.com,,,,1,admin@contoso.onmicrosoft.com
87
+ ```
88
+
89
+ </TabItem>
90
+ <TabItem value="Markdown">
91
+
92
+ ```md
93
+ # spo group member list --webUrl "https://contoso.sharepoint.com/sites/SiteA" --groupName "Contoso Site Members"
94
+
95
+ Date: 10/3/2023
96
+
97
+ ## Jon Doe (7)
98
+
99
+ Property | Value
100
+ ---------|-------
101
+ Id | 7
102
+ IsHiddenInUI | false
103
+ LoginName | i:0#.f\|membership\|admin@contoso.onmicrosoft.com
104
+ Title | Jon Doe
105
+ PrincipalType | 1
106
+ Email | admin@contoso.onmicrosoft.com
107
+ Expiration |
108
+ IsEmailAuthenticationGuestUser | false
109
+ IsShareByEmailGuestUser | false
110
+ IsSiteAdmin | true
111
+ UserPrincipalName | admin@contoso.onmicrosoft.com
112
+ ```
113
+
114
+ </TabItem>
115
+ </Tabs>