@pnp/cli-microsoft365 6.3.0 → 6.4.0-beta.39e5130

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 (185) hide show
  1. package/.eslintrc.js +1 -0
  2. package/README.md +12 -1
  3. package/dist/Command.js +1 -0
  4. package/dist/m365/aad/commands/user/user-get.js +3 -0
  5. package/dist/m365/aad/commands/user/user-license-remove.js +2 -1
  6. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +2 -9
  7. package/dist/m365/aad/commands/user/user-set.js +3 -0
  8. package/dist/m365/aad/commands/user/user-signin-list.js +3 -0
  9. package/dist/m365/flow/commands/flow-disable.js +9 -2
  10. package/dist/m365/flow/commands/flow-enable.js +9 -2
  11. package/dist/m365/flow/commands/flow-get.js +9 -2
  12. package/dist/m365/flow/commands/flow-list.js +1 -1
  13. package/dist/m365/flow/commands/flow-remove.js +2 -2
  14. package/dist/m365/flow/commands/owner/owner-add.js +147 -0
  15. package/dist/m365/flow/commands/owner/owner-list.js +89 -0
  16. package/dist/m365/flow/commands/owner/owner-remove.js +147 -0
  17. package/dist/m365/flow/commands/run/run-cancel.js +9 -2
  18. package/dist/m365/flow/commands/run/run-list.js +5 -2
  19. package/dist/m365/flow/commands.js +3 -0
  20. package/dist/m365/planner/commands/roster/roster-member-add.js +3 -0
  21. package/dist/m365/planner/commands/roster/roster-member-get.js +98 -0
  22. package/dist/m365/planner/commands.js +1 -0
  23. package/dist/m365/spfx/commands/spfx-doctor.js +43 -29
  24. package/dist/m365/spo/commands/customaction/customaction-get.js +27 -7
  25. package/dist/m365/spo/commands/file/file-move.js +1 -1
  26. package/dist/m365/spo/commands/group/group-member-add.js +54 -95
  27. package/dist/m365/spo/commands/list/list-add.js +11 -8
  28. package/dist/m365/spo/commands/list/list-set.js +3 -3
  29. package/dist/m365/spo/commands/navigation/navigation-node-add.js +5 -4
  30. package/dist/m365/spo/commands/navigation/navigation-node-set.js +5 -1
  31. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +118 -0
  32. package/dist/m365/spo/commands/term/term-get.js +68 -48
  33. package/dist/m365/spo/commands.js +1 -0
  34. package/dist/utils/aadGroup.js +18 -0
  35. package/dist/utils/aadUser.js +20 -0
  36. package/dist/utils/md.js +7 -0
  37. package/dist/utils/spo.js +32 -0
  38. package/docs/docs/cmd/aad/approleassignment/approleassignment-add.md +5 -5
  39. package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +3 -3
  40. package/docs/docs/cmd/aad/user/user-remove.md +1 -1
  41. package/docs/docs/cmd/cli/completion/completion-clink-update.md +4 -4
  42. package/docs/docs/cmd/flow/owner/owner-add.md +61 -0
  43. package/docs/docs/cmd/flow/owner/owner-list.md +90 -0
  44. package/docs/docs/cmd/flow/owner/owner-remove.md +67 -0
  45. package/docs/docs/cmd/flow/run/run-list.md +28 -0
  46. package/docs/docs/cmd/onenote/page/page-list.md +1 -1
  47. package/docs/docs/cmd/outlook/mail/mail-send.md +7 -3
  48. package/docs/docs/cmd/outlook/message/message-get.md +143 -0
  49. package/docs/docs/cmd/outlook/message/message-list.md +119 -0
  50. package/docs/docs/cmd/outlook/message/message-move.md +4 -0
  51. package/docs/docs/cmd/outlook/report/report-mailactivitycounts.md +40 -0
  52. package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.md +40 -0
  53. package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.md +45 -0
  54. package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.md +43 -0
  55. package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.md +44 -0
  56. package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.md +48 -0
  57. package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.md +41 -0
  58. package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.md +49 -0
  59. package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.md +37 -0
  60. package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.md +40 -0
  61. package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.md +36 -0
  62. package/docs/docs/cmd/outlook/room/room-list.md +81 -0
  63. package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +58 -0
  64. package/docs/docs/cmd/planner/plan/plan-add.md +3 -3
  65. package/docs/docs/cmd/planner/plan/plan-set.md +73 -7
  66. package/docs/docs/cmd/planner/roster/roster-add.md +16 -1
  67. package/docs/docs/cmd/planner/roster/roster-member-get.md +87 -0
  68. package/docs/docs/cmd/planner/task/task-add.md +230 -0
  69. package/docs/docs/cmd/planner/task/task-checklistitem-add.md +55 -0
  70. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +55 -0
  71. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +4 -0
  72. package/docs/docs/cmd/planner/task/task-get.md +131 -0
  73. package/docs/docs/cmd/planner/task/task-list.md +92 -0
  74. package/docs/docs/cmd/planner/task/task-reference-add.md +46 -0
  75. package/docs/docs/cmd/planner/task/task-reference-list.md +46 -0
  76. package/docs/docs/cmd/planner/task/task-reference-remove.md +4 -0
  77. package/docs/docs/cmd/planner/task/task-remove.md +4 -0
  78. package/docs/docs/cmd/planner/task/task-set.md +230 -0
  79. package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +55 -0
  80. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +55 -0
  81. package/docs/docs/cmd/pp/card/card-get.md +2 -2
  82. package/docs/docs/cmd/pp/card/card-list.md +2 -2
  83. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +7 -7
  84. package/docs/docs/cmd/skype/report/report-activitycounts.md +38 -0
  85. package/docs/docs/cmd/skype/report/report-activityusercounts.md +38 -0
  86. package/docs/docs/cmd/skype/report/report-activityuserdetail.md +67 -0
  87. package/docs/docs/cmd/spfx/project/project-doctor.md +3 -3
  88. package/docs/docs/cmd/spfx/project/project-externalize.md +3 -3
  89. package/docs/docs/cmd/spfx/project/project-upgrade.md +3 -3
  90. package/docs/docs/cmd/spfx/spfx-doctor.md +3 -3
  91. package/docs/docs/cmd/spo/cdn/cdn-get.md +6 -6
  92. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +3 -3
  93. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +3 -3
  94. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +3 -3
  95. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +3 -3
  96. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +3 -3
  97. package/docs/docs/cmd/spo/cdn/cdn-set.md +3 -3
  98. package/docs/docs/cmd/spo/customaction/customaction-get.md +113 -11
  99. package/docs/docs/cmd/spo/externaluser/externaluser-list.md +2 -0
  100. package/docs/docs/cmd/spo/group/group-member-add.md +26 -4
  101. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.md +2 -0
  102. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md +2 -0
  103. package/docs/docs/cmd/spo/homesite/homesite-remove.md +2 -0
  104. package/docs/docs/cmd/spo/homesite/homesite-set.md +2 -0
  105. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +2 -0
  106. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +2 -0
  107. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +3 -3
  108. package/docs/docs/cmd/spo/list/list-add.md +2 -2
  109. package/docs/docs/cmd/spo/list/list-set.md +2 -2
  110. package/docs/docs/cmd/spo/listitem/listitem-add.md +1 -1
  111. package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +1 -1
  112. package/docs/docs/cmd/spo/listitem/listitem-set.md +1 -1
  113. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +3 -3
  114. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +2 -2
  115. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +2 -0
  116. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +2 -0
  117. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +2 -0
  118. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +2 -0
  119. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +2 -0
  120. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +3 -3
  121. package/docs/docs/cmd/spo/site/site-appcatalog-add.md +2 -0
  122. package/docs/docs/cmd/spo/site/site-appcatalog-remove.md +3 -3
  123. package/docs/docs/cmd/spo/site/site-commsite-enable.md +2 -0
  124. package/docs/docs/cmd/spo/site/site-list.md +3 -3
  125. package/docs/docs/cmd/spo/site/site-remove.md +3 -3
  126. package/docs/docs/cmd/spo/site/site-rename.md +3 -3
  127. package/docs/docs/cmd/spo/site/site-set.md +5 -5
  128. package/docs/docs/cmd/spo/storageentity/storageentity-remove.md +3 -3
  129. package/docs/docs/cmd/spo/storageentity/storageentity-set.md +3 -3
  130. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.md +3 -3
  131. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.md +2 -0
  132. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +3 -3
  133. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.md +142 -0
  134. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.md +2 -0
  135. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.md +3 -3
  136. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md +3 -3
  137. package/docs/docs/cmd/spo/tenant/tenant-settings-list.md +2 -0
  138. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +28 -26
  139. package/docs/docs/cmd/spo/term/term-add.md +3 -3
  140. package/docs/docs/cmd/spo/term/term-get.md +3 -3
  141. package/docs/docs/cmd/spo/term/term-group-add.md +2 -0
  142. package/docs/docs/cmd/spo/term/term-group-get.md +2 -0
  143. package/docs/docs/cmd/spo/term/term-group-list.md +2 -0
  144. package/docs/docs/cmd/spo/term/term-list.md +3 -1
  145. package/docs/docs/cmd/spo/term/term-set-add.md +3 -3
  146. package/docs/docs/cmd/spo/term/term-set-get.md +2 -0
  147. package/docs/docs/cmd/spo/term/term-set-list.md +2 -0
  148. package/docs/docs/cmd/spo/theme/theme-apply.md +3 -3
  149. package/docs/docs/cmd/spo/theme/theme-get.md +2 -0
  150. package/docs/docs/cmd/spo/theme/theme-list.md +2 -0
  151. package/docs/docs/cmd/spo/theme/theme-remove.md +2 -0
  152. package/docs/docs/cmd/spo/theme/theme-set.md +3 -3
  153. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  154. package/docs/docs/cmd/teams/channel/channel-member-add.md +2 -2
  155. package/docs/docs/cmd/teams/message/message-get.md +39 -4
  156. package/docs/docs/cmd/teams/message/message-list.md +41 -6
  157. package/docs/docs/cmd/teams/message/message-reply-list.md +39 -4
  158. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +20 -2
  159. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +8 -8
  160. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +12 -5
  161. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +13 -6
  162. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +14 -7
  163. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +13 -6
  164. package/docs/docs/cmd/teams/report/report-pstncalls.md +13 -6
  165. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +13 -6
  166. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +13 -6
  167. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +13 -6
  168. package/docs/docs/cmd/teams/tab/tab-add.md +16 -0
  169. package/docs/docs/cmd/teams/tab/tab-get.md +17 -0
  170. package/docs/docs/cmd/teams/tab/tab-list.md +19 -0
  171. package/docs/docs/cmd/teams/team/team-add.md +77 -8
  172. package/docs/docs/cmd/teams/team/team-app-list.md +18 -2
  173. package/docs/docs/cmd/teams/team/team-archive.md +2 -2
  174. package/docs/docs/cmd/teams/team/team-clone.md +8 -8
  175. package/docs/docs/cmd/teams/team/team-get.md +34 -4
  176. package/docs/docs/cmd/teams/team/team-list.md +34 -3
  177. package/docs/docs/cmd/teams/team/team-remove.md +3 -3
  178. package/docs/docs/cmd/teams/team/team-set.md +8 -8
  179. package/docs/docs/cmd/teams/team/team-unarchive.md +3 -2
  180. package/docs/docs/cmd/teams/user/user-app-add.md +3 -3
  181. package/docs/docs/cmd/teams/user/user-app-list.md +18 -2
  182. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -4
  183. package/docs/docs/cmd/teams/user/user-list.md +21 -4
  184. package/npm-shrinkwrap.json +279 -194
  185. package/package.json +14 -14
@@ -11,10 +11,13 @@ m365 spo customaction get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : ID of the user custom action to retrieve information for. Specify either `id` or `title`
14
+ : ID of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
15
15
 
16
16
  `-t, --title [title]`
17
- : Title of the user custom action to retrieve information for. Specify either `id` or `title`
17
+ : Title of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
18
+
19
+ `-c, --clientSideComponentId [clientSideComponentId]`
20
+ : clientSideComponentId of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
18
21
 
19
22
  `-u, --webUrl <webUrl>`
20
23
  : Url of the site or site collection to retrieve the custom action from
@@ -26,34 +29,133 @@ m365 spo customaction get [options]
26
29
 
27
30
  ## Remarks
28
31
 
29
- If the command finds multiple user custom actions with the specified title, it will prompt you to disambiguate which user custom action it should use, listing the discovered IDs.
32
+ If the command finds multiple user custom actions with the specified `title` or `clientSideComponentId`, it will prompt you to disambiguate which user custom action it should get, listing the discovered IDs.
30
33
 
31
34
  ## Examples
32
35
 
33
- Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
36
+ Return details about the user custom action based on the id and a given url
34
37
 
35
38
  ```sh
36
39
  m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test
37
40
  ```
38
41
 
39
- Return details about the user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
42
+ Return details about the user custom action based on the title and a given url
40
43
 
41
44
  ```sh
42
45
  m365 spo customaction get --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test
43
46
  ```
44
47
 
45
- Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site collection _https://contoso.sharepoint.com/sites/test_
48
+ Return details about the user custom action based on the clientSideComponentId and a given url
49
+
50
+ ```sh
51
+ m365 spo customaction get --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --webUrl https://contoso.sharepoint.com/sites/test
52
+ ```
53
+
54
+ Return details about the user custom action based on the id and a given url and the scope
46
55
 
47
56
  ```sh
48
- m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Site
57
+ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Site
49
58
  ```
50
59
 
51
- Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site _https://contoso.sharepoint.com/sites/test_
60
+ Return details about the user custom action based on the id and a given url and the scope
52
61
 
53
62
  ```sh
54
- m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Web
63
+ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
55
64
  ```
56
65
 
57
- ## More information
66
+ Return details about the user custom action based on the id and a given url and the scope
67
+
68
+ ```sh
69
+ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
70
+ ```
58
71
 
59
- - UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
72
+ ## Response
73
+
74
+ === "JSON"
75
+
76
+ ```json
77
+ {
78
+ "ClientSideComponentId": "34a019f9-6198-4053-a3b6-fbdea9a107fd",
79
+ "ClientSideComponentProperties": "{\"sampleTextOne\":\"One item is selected in the list.\", \"sampleTextTwo\":\"This command is always visible.\"}",
80
+ "CommandUIExtension": null,
81
+ "Description": null,
82
+ "Group": null,
83
+ "Id": "158cb0d1-8703-4a36-866d-84aed8233bd3",
84
+ "ImageUrl": null,
85
+ "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
86
+ "Name": "{158cb0d1-8703-4a36-866d-84aed8233bd3}",
87
+ "RegistrationId": "100",
88
+ "RegistrationType": 1,
89
+ "Rights": "{\"High\":0,\"Low\":0}",
90
+ "Scope": "Web",
91
+ "ScriptBlock": null,
92
+ "ScriptSrc": null,
93
+ "Sequence": 65536,
94
+ "Title": "ExtensionTraining",
95
+ "Url": null,
96
+ "VersionOfUserCustomAction": "1.0.1.0"
97
+ }
98
+ ```
99
+
100
+ === "Text"
101
+
102
+ ```text
103
+ ClientSideComponentId : 34a019f9-6198-4053-a3b6-fbdea9a107fd
104
+ ClientSideComponentProperties: {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
105
+ CommandUIExtension : null
106
+ Description : null
107
+ Group : null
108
+ Id : 158cb0d1-8703-4a36-866d-84aed8233bd3
109
+ ImageUrl : null
110
+ Location : ClientSideExtension.ListViewCommandSet.CommandBar
111
+ Name : {158cb0d1-8703-4a36-866d-84aed8233bd3}
112
+ RegistrationId : 100
113
+ RegistrationType : 1
114
+ Rights : {"High":0,"Low":0}
115
+ Scope : Web
116
+ ScriptBlock : null
117
+ ScriptSrc : null
118
+ Sequence : 65536
119
+ Title : ExtensionTraining
120
+ Url : null
121
+ VersionOfUserCustomAction : 1.0.1.0
122
+ ```
123
+
124
+ === "CSV"
125
+
126
+ ```csv
127
+ ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
128
+ 34a019f9-6198-4053-a3b6-fbdea9a107fd,"{""sampleTextOne"":""One item is selected in the list."", ""sampleTextTwo"":""This command is always visible.""}",,,,158cb0d1-8703-4a36-866d-84aed8233bd3,,ClientSideExtension.ListViewCommandSet.CommandBar,{158cb0d1-8703-4a36-866d-84aed8233bd3},100,1,"{""High"":0,""Low"":0}",Web,,,65536,ExtensionTraining,,1.0.1.0
129
+ ```
130
+
131
+ === "Markdown"
132
+
133
+ ```md
134
+ # spo customaction get --webUrl "https://contoso.sharepoint.com" --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --scope "Web"
135
+
136
+ Date: 27/1/2023
137
+
138
+ ## ExtensionTraining (158cb0d1-8703-4a36-866d-84aed8233bd3)
139
+
140
+ Property | Value
141
+ ---------|-------
142
+ ClientSideComponentId | 34a019f9-6198-4053-a3b6-fbdea9a107fd
143
+ ClientSideComponentProperties | {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
144
+ CommandUIExtension | null
145
+ Description | null
146
+ Group | null
147
+ Id | 158cb0d1-8703-4a36-866d-84aed8233bd3
148
+ ImageUrl | null
149
+ Location | ClientSideExtension.ListViewCommandSet.CommandBar
150
+ Name | {158cb0d1-8703-4a36-866d-84aed8233bd3}
151
+ RegistrationId | 100
152
+ RegistrationType | 1
153
+ Rights | {"High":0,"Low":0}
154
+ Scope | Web
155
+ ScriptBlock | null
156
+ ScriptSrc | null
157
+ Sequence | 65536
158
+ Title | ExtensionTraining
159
+ Url | null
160
+ VersionOfUserCustomAction | 1.0.1.0
161
+ ```
@@ -27,6 +27,8 @@ m365 spo externaluser list [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
+ ## Remarks
31
+
30
32
  !!! important
31
33
  To use this command you have to have permissions to access the tenant admin site.
32
34
 
@@ -20,16 +20,16 @@ m365 spo group member add [options]
20
20
  : Name of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`
21
21
 
22
22
  `--userName [userName]`
23
- : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
23
+ : 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 `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
24
24
 
25
25
  `--email [email]`
26
- : User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
26
+ : User's email (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 `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
27
27
 
28
28
  `--userId [userId]`
29
- : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
29
+ : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma-separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
30
30
 
31
31
  `--aadGroupId [aadGroupId]`
32
- : The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
32
+ : The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma-separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
33
33
 
34
34
  `--aadGroupName [aadGroupName]`
35
35
  : The name of the Azure AD group to add as a member. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
@@ -126,3 +126,25 @@ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --
126
126
  DisplayName,Email
127
127
  John Doe,john.doe@contoso.onmicrosoft.com
128
128
  ```
129
+
130
+ === "Markdown"
131
+
132
+ ```md
133
+ # spo group member add --webUrl "https://contoso.sharepoint.com" --groupId "5" --aadGroupId "f2fb2f10-cfd2-4054-8ffd-64533657a5ab"
134
+
135
+ Date: 13/2/2023
136
+
137
+ ## All Company Members
138
+
139
+ Property | Value
140
+ ---------|-------
141
+ AllowedRoles | [0]
142
+ CurrentRole | 0
143
+ DisplayName | All Company Members
144
+ Email | allcompany@contoso.onmicrosoft.com
145
+ InvitationLink | null
146
+ IsUserKnown | true
147
+ Message | null
148
+ Status | true
149
+ User | c:0o.c\|federateddirectoryclaimprovider\|f2fb2f10-cfd2-4054-8ffd-64533657a5ab
150
+ ```
@@ -12,6 +12,8 @@ m365 spo hidedefaultthemes get [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -15,6 +15,8 @@ m365 spo hidedefaultthemes set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,6 +15,8 @@ m365 spo homesite remove [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,6 +15,8 @@ m365 spo homesite set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -12,6 +12,8 @@ m365 spo knowledgehub get [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -15,6 +15,8 @@ m365 spo knowledgehub remove [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,13 +15,13 @@ m365 spo knowledgehub set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  If the specified url doesn't refer to an existing site collection, you will get a `404 - "404 FILE NOT FOUND"` error.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Sets the Knowledge Hub Site for your tenant.
@@ -13,8 +13,8 @@ m365 spo list add [options]
13
13
  `-t, --title <title>`
14
14
  : Title of the list to add.
15
15
 
16
- `--baseTemplate <baseTemplate>`
17
- : The list definition type on which the list is based. Allowed values `Announcements`, `Contacts`, `CustomGrid`, `DataSources`,`DiscussionBoard`, `DocumentLibrary`, `Events`, `GanttTasks`, `GenericList`, `IssuesTracking`, `Links`, `NoCodeWorkflows`,`PictureLibrary`, `Survey`, `Tasks`, `WebPageLibrary`, `WorkflowHistory`, `WorkflowProcess`, `XmlForm`. Default `GenericList`.
16
+ `--baseTemplate [baseTemplate]`
17
+ : The list definition type on which the list is based. Allowed values `Announcements`, `Contacts`, `CustomGrid`, `DataSources`,`DiscussionBoard`, `DocumentLibrary`, `Events`, `GanttTasks`, `GenericList`, `IssuesTracking`, `Links`, `NoCodeWorkflows`,`PictureLibrary`, `Survey`, `Tasks`, `WebPageLibrary`, `WorkflowHistory`, `WorkflowProcess`, `XmlForm`. Default value is `GenericList`.
18
18
 
19
19
  `-u, --webUrl <webUrl>`
20
20
  : URL of the site where the list should be added.
@@ -59,7 +59,7 @@ m365 spo list set [options]
59
59
  : Property for assigning or retrieving grid editing on the list. Valid values are `true`, `false`.
60
60
 
61
61
  `--draftVersionVisibility [draftVersionVisibility]`
62
- : Value that specifies the minimum permission required to view minor versions and drafts within the list. Allowed values `Reader`, `Author`, `Approver`. Default `Reader`.
62
+ : Value that specifies the minimum permission required to view minor versions and drafts within the list. Allowed values `Reader`, `Author`, `Approver`.
63
63
 
64
64
  `--emailAlias [emailAlias]`
65
65
  : If e-mail notification is enabled, gets or sets the e-mail address to use tonotify to the owner of an item when an assignment has changed or the item has been updated.
@@ -137,7 +137,7 @@ m365 spo list set [options]
137
137
  : Indicates whether this list should be treated as a top level navigation object or not.
138
138
 
139
139
  `--listExperienceOptions [listExperienceOptions]`
140
- : Gets or sets the list experience for the list. Allowed values `Auto`, `NewExperience`, `ClassicExperience`. Default `Auto`.
140
+ : Gets or sets the list experience for the list. Allowed values `Auto`, `NewExperience`, `ClassicExperience`.
141
141
 
142
142
  `--majorVersionLimit [majorVersionLimit]`
143
143
  : Gets or sets the maximum number of major versions allowed for an item in a document library that uses version control with major versions only.
@@ -59,7 +59,7 @@ m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoin
59
59
  Add an item with Title _Demo Multi Person Field_ and a multi-select people field named _MultiPeopleField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
60
60
 
61
61
  ```sh
62
- m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|adamb@conotoso.com'}]"
62
+ m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|john.doe@conotoso.com'}]"
63
63
  ```
64
64
 
65
65
  Add an item with Title _Demo Hyperlink Field_ and a hyperlink field named _CustomHyperlink_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -53,7 +53,7 @@ A sample CSV can be found below. The first line of the CSV-file should contain t
53
53
 
54
54
  ```csv
55
55
  ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMetadataField,SinglePeopleField,MultiPeopleField,CustomHyperlink,NumberField
56
- Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|adamb@contoso.com'}]","https://bing.com, URL",5
56
+ Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|john.doe@contoso.com'}]","https://bing.com, URL",5
57
57
  ```
58
58
 
59
59
  ## Response
@@ -62,7 +62,7 @@ m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.
62
62
  Update an item with id _147_ with Title _Demo Multi Person Field_ and a multi-select people field named _MultiPeopleField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
63
63
 
64
64
  ```sh
65
- m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|adamb@conotoso.com'}]"
65
+ m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|john.doe@conotoso.com'}]"
66
66
  ```
67
67
 
68
68
  Update the field _Title_ and _CustomHyperlink_ of an item with a specific id in a list retrieved by server-relative URL in a specific site
@@ -19,8 +19,8 @@ m365 spo navigation node add [options]
19
19
  `-t, --title <title>`
20
20
  : Navigation node title.
21
21
 
22
- `--url <url>`
23
- : Navigation node URL.
22
+ `--url [url]`
23
+ : Navigation node URL. When not specified a linkless label will be created.
24
24
 
25
25
  `--parentNodeId [parentNodeId]`
26
26
  : ID of the node below which the node should be added. Specify either `location` or `parentNodeId` but not both.
@@ -29,7 +29,7 @@ m365 spo navigation node add [options]
29
29
  : Set, if the navigation node points to an external URL.
30
30
 
31
31
  `--audienceIds [audienceIds]`
32
- : Comma separated list of group IDs that will be used for audience targeting. The limit is 10 ids per navigation node.
32
+ : Comma-separated list of group IDs that will be used for audience targeting. The limit is 10 ids per navigation node.
33
33
 
34
34
  --8<-- "docs/cmd/_global.md"
35
35
 
@@ -20,10 +20,10 @@ m365 spo navigation node set [options]
20
20
  : New title of the navigation node.
21
21
 
22
22
  `--url [url]`
23
- : New URL of the navigation node.
23
+ : New URL of the navigation node. Specify an empty string `""` to update the navigation label to a linkless label.
24
24
 
25
25
  `--audienceIds [audienceIds]`
26
- : Comma separated list of group IDs that will be used for audience targeting. Speficy an empty string `""` to clear this value. The limit is 10 ids per navigation node.
26
+ : Comma-separated list of group IDs that will be used for audience targeting. Speficy an empty string `""` to clear this value. The limit is 10 ids per navigation node.
27
27
 
28
28
  `--isExternal [isExternal]`
29
29
  : Whether the navigation node points to an external URL. Valid values: `true` or `false`.
@@ -21,6 +21,8 @@ m365 spo orgassetslibrary add [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
+ ## Remarks
25
+
24
26
  !!! important
25
27
  To use this command you have to have permissions to access the tenant admin site.
26
28
 
@@ -12,6 +12,8 @@ m365 spo orgassetslibrary list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -18,6 +18,8 @@ m365 spo orgassetslibrary remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -12,6 +12,8 @@ m365 spo orgnewssite list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
+ ## Remarks
16
+
15
17
  !!! important
16
18
  To use this command you have to have permissions to access the tenant admin site.
17
19
 
@@ -18,6 +18,8 @@ m365 spo orgnewssite remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -15,13 +15,13 @@ m365 spo orgnewssite set [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  Using the `-u, --url` option you can specify which site to add to the list of organizational news sites.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Set a site as an organizational news site
@@ -15,6 +15,8 @@ m365 spo site appcatalog add [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
+ ## Remarks
19
+
18
20
  !!! important
19
21
  To use this command you have to have permissions to access the tenant admin site.
20
22
 
@@ -15,13 +15,13 @@ m365 spo site appcatalog remove [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- !!! important
19
- To use this command you have to have permissions to access the tenant admin site.
20
-
21
18
  ## Remarks
22
19
 
23
20
  While the command uses the term *'remove'*, like its equivalent PowerShell cmdlet, it does not remove the special library **Apps for SharePoint** from the site collection. Instead, it disables the site collection app catalog in that site. Packages deployed to the app catalog are not available within the site collection.
24
21
 
22
+ !!! important
23
+ To use this command you have to have permissions to access the tenant admin site.
24
+
25
25
  ## Examples
26
26
 
27
27
  Remove the site collection app catalog from specified site
@@ -18,6 +18,8 @@ m365 spo site commsite enable [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
+ ## Remarks
22
+
21
23
  !!! important
22
24
  To use this command you have to have permissions to access the tenant admin site.
23
25
 
@@ -27,15 +27,15 @@ m365 spo site list [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- To use this command you have to have permissions to access the tenant admin site.
32
-
33
30
  ## Remarks
34
31
 
35
32
  Using the `-f, --filter` option you can specify which sites you want to retrieve. For example, to get sites with _project_ in their URL, use `Url -like 'project'` as the filter.
36
33
 
37
34
  When using the text output type, the command lists only the values of the `Title`, and `Url` properties of the site. When setting the output type to JSON, all available properties are included in the command output.
38
35
 
36
+ !!! important
37
+ To use this command you have to have permissions to access the tenant admin site.
38
+
39
39
  ## Examples
40
40
 
41
41
  List all sites in the currently connected tenant
@@ -27,9 +27,6 @@ m365 spo site remove [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- To use this command you have to have permissions to access the tenant admin site.
32
-
33
30
  ## Remarks
34
31
 
35
32
  Deleting a site collection is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully deleted, you should use the `--wait` flag. When using this flag, the `spo site remove` command will keep running until it received confirmation from Microsoft 365 that the site has been fully deleted.
@@ -38,6 +35,9 @@ If the site which you have selected to remove is groupified (Modern Team Site) a
38
35
 
39
36
  If the argument `--fromRecycleBin` is passed, the selected site will be permanently removed even if it's a groupified one.
40
37
 
38
+ !!! important
39
+ To use this command you have to have permissions to access the tenant admin site.
40
+
41
41
  ## Examples
42
42
 
43
43
  Remove the specified site and place it in the Recycle Bin
@@ -30,13 +30,13 @@ m365 spo site rename [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
- !!! important
34
- To use this command you must have permissions to access the tenant admin site.
35
-
36
33
  ## Remarks
37
34
 
38
35
  Renaming site collections is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the operation to complete fully, you should use the `--wait` flag. When using this flag, the `spo site rename` command will keep running until it receives confirmation from Microsoft 365 that the site rename operation has completed.
39
36
 
37
+ !!! important
38
+ To use this command you must have permissions to access the tenant admin site.
39
+
40
40
  ## Examples
41
41
 
42
42
  Starts the rename of the site collection with name "samplesite" to "renamed" without modifying the title
@@ -69,9 +69,6 @@ m365 spo site set [options]
69
69
 
70
70
  --8<-- "docs/cmd/_global.md"
71
71
 
72
- !!! important
73
- To use this command you have to have permissions to access the tenant admin site.
74
-
75
72
  ## Remarks
76
73
 
77
74
  If the specified url doesn't refer to an existing site collection, you will get a `404 - "404 FILE NOT FOUND"` error.
@@ -94,6 +91,9 @@ For more information on configuring no script sites see [https://support.office.
94
91
 
95
92
  Setting site properties is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully configured, you should use the `--wait` flag. When using this flag, the `spo site set` command will keep running until it received confirmation from Microsoft 365 that the site has been fully configured.
96
93
 
94
+ !!! important
95
+ To use this command you have to have permissions to access the tenant admin site.
96
+
97
97
  ## Examples
98
98
 
99
99
  Update site collection's classification
@@ -159,13 +159,13 @@ m365 spo site set --url https://contoso.sharepoint.com/sites/sales --sharingCapa
159
159
  Set the logo on the site
160
160
 
161
161
  ```sh
162
- m365 spo site set --url https://estruyfdev2.sharepoint.com/sites/sales --siteLogoUrl "/sites/sales/SiteAssets/parker-ms-1200.png"
162
+ m365 spo site set --url https://contoso.sharepoint.com/sites/sales --siteLogoUrl "/sites/sales/SiteAssets/parker-ms-1200.png"
163
163
  ```
164
164
 
165
165
  Unset the logo on the site
166
166
 
167
167
  ```sh
168
- m365 spo site set --url https://estruyfdev2.sharepoint.com/sites/sales --siteLogoUrl ""
168
+ m365 spo site set --url https://contoso.sharepoint.com/sites/sales --siteLogoUrl ""
169
169
  ```
170
170
 
171
171
  Lock the site preventing users from accessing it. Wait for the configuration to complete
@@ -21,13 +21,13 @@ m365 spo storageentity remove [options]
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
- !!! important
25
- To use this command you have to have permissions to access the tenant admin site.
26
-
27
24
  ## Remarks
28
25
 
29
26
  Tenant properties are stored in the app catalog site associated with that tenant. To remove a property, you have to specify the absolute URL of the app catalog site. If you specify the URL of a site different than the app catalog, you will get an access denied error.
30
27
 
28
+ !!! important
29
+ To use this command you have to have permissions to access the tenant admin site.
30
+
31
31
  ## Examples
32
32
 
33
33
  Remove the _AnalyticsId_ tenant property. Yields a confirmation prompt before actually removing the property
@@ -27,15 +27,15 @@ m365 spo storageentity set [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
- !!! important
31
- To use this command you have to have permissions to access the tenant admin site.
32
-
33
30
  ## Remarks
34
31
 
35
32
  Tenant properties are stored in the app catalog site associated with that tenant. To set a property, you have to specify the absolute URL of the app catalog site without a trailing slash. If you specify the URL with trailing slash you get the error `The managed path sites/apps is not a managed path in this tenant.`
36
33
 
37
34
  If you specify the URL of a site different than the app catalog, you will get an access denied error.
38
35
 
36
+ !!! important
37
+ To use this command you have to have permissions to access the tenant admin site.
38
+
39
39
  ## Examples
40
40
 
41
41
  Set _123_ as the value of the _AnalyticsId_ tenant property. Also include a description and a comment for additional clarification of the usage of the property.