@pnp/cli-microsoft365 9.0.0-beta.f2c5f82 → 9.1.0-beta.2d61838

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 (197) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +17 -16
  4. package/dist/AuthServer.js +7 -7
  5. package/dist/Command.js +5 -4
  6. package/dist/api.js +1 -1
  7. package/dist/cli/cli.js +57 -8
  8. package/dist/config.js +61 -5
  9. package/dist/m365/app/commands/permission/permission-add.js +9 -9
  10. package/dist/m365/base/PowerAutomateCommand.js +1 -1
  11. package/dist/m365/base/SpoCommand.js +1 -1
  12. package/dist/m365/cli/commands/cli-consent.js +9 -5
  13. package/dist/m365/cli/commands/cli-doctor.js +2 -2
  14. package/dist/m365/cli/commands/cli-reconsent.js +2 -3
  15. package/dist/m365/cli/commands/config/config-set.js +12 -3
  16. package/dist/m365/commands/login.js +38 -14
  17. package/dist/m365/commands/setup.js +256 -33
  18. package/dist/m365/commands/status.js +2 -2
  19. package/dist/m365/connection/commands/connection-list.js +4 -4
  20. package/dist/m365/entra/commands/app/app-add.js +52 -288
  21. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
  22. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
  23. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
  24. package/dist/m365/entra/commands/group/group-user-list.js +4 -4
  25. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  26. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  27. package/dist/m365/entra/commands/m365group/m365group-user-list.js +9 -6
  28. package/dist/m365/external/commands/item/item-add.js +2 -5
  29. package/dist/m365/file/commands/file-move.js +135 -0
  30. package/dist/m365/file/commands.js +2 -1
  31. package/dist/m365/flow/commands/environment/environment-get.js +1 -1
  32. package/dist/m365/flow/commands/environment/environment-list.js +1 -1
  33. package/dist/m365/flow/commands/flow-disable.js +1 -1
  34. package/dist/m365/flow/commands/flow-enable.js +1 -1
  35. package/dist/m365/flow/commands/flow-export.js +17 -16
  36. package/dist/m365/flow/commands/flow-get.js +1 -1
  37. package/dist/m365/flow/commands/flow-list.js +1 -1
  38. package/dist/m365/flow/commands/flow-remove.js +1 -1
  39. package/dist/m365/flow/commands/owner/owner-ensure.js +1 -1
  40. package/dist/m365/flow/commands/owner/owner-list.js +1 -1
  41. package/dist/m365/flow/commands/owner/owner-remove.js +1 -1
  42. package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-list.js +47 -0
  43. package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-restore.js +48 -0
  44. package/dist/m365/flow/commands/run/run-cancel.js +1 -1
  45. package/dist/m365/flow/commands/run/run-get.js +1 -1
  46. package/dist/m365/flow/commands/run/run-list.js +1 -1
  47. package/dist/m365/flow/commands/run/run-resubmit.js +2 -2
  48. package/dist/m365/flow/commands.js +2 -0
  49. package/dist/m365/onenote/commands/notebook/notebook-add.js +132 -0
  50. package/dist/m365/onenote/commands.js +1 -0
  51. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  52. package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
  53. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.20.0-rc.1.js +25 -0
  54. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  55. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +10 -1
  56. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.20.0-rc.1.js +57 -0
  57. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  58. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  59. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +1 -0
  60. package/dist/m365/spo/commands/file/file-copy.js +34 -55
  61. package/dist/m365/spo/commands/file/file-roleassignment-add.js +17 -54
  62. package/dist/m365/spo/commands/file/file-roleassignment-remove.js +13 -40
  63. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +5 -13
  64. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +5 -13
  65. package/dist/m365/spo/commands/folder/folder-set.js +4 -0
  66. package/dist/m365/spo/commands/folder/folder-sharinglink-add.js +143 -0
  67. package/dist/m365/spo/commands/folder/folder-sharinglink-clear.js +111 -0
  68. package/dist/m365/spo/commands/folder/folder-sharinglink-remove.js +95 -0
  69. package/dist/m365/spo/commands/list/list-get.js +17 -4
  70. package/dist/m365/spo/commands/list/list-list.js +4 -1
  71. package/dist/m365/spo/commands/page/page-remove.js +37 -16
  72. package/dist/m365/spo/commands/page/page-section-add.js +185 -34
  73. package/dist/m365/spo/commands/site/SiteAdmin.js +2 -0
  74. package/dist/m365/spo/commands/site/site-admin-add.js +252 -0
  75. package/dist/m365/spo/commands/site/site-admin-list.js +10 -36
  76. package/dist/m365/spo/commands/site/site-admin-remove.js +194 -0
  77. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +24 -48
  78. package/dist/m365/spo/commands/site/site-get.js +12 -16
  79. package/dist/m365/spo/commands/site/site-remove.js +7 -1
  80. package/dist/m365/spo/commands/site/site-sharingpermission-set.js +68 -0
  81. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +22 -2
  82. package/dist/m365/spo/commands/user/user-get.js +67 -9
  83. package/dist/m365/spo/commands.js +7 -0
  84. package/dist/m365/spp/commands/contentcenter/contentcenter-list.js +56 -0
  85. package/dist/m365/spp/commands.js +5 -0
  86. package/dist/m365/teams/MeetingTranscript.js +2 -0
  87. package/dist/m365/teams/commands/meeting/meeting-transcript-get.js +152 -0
  88. package/dist/m365/teams/commands.js +1 -0
  89. package/dist/m365/viva/commands/engage/Community.js +2 -0
  90. package/dist/m365/viva/commands/engage/engage-community-list.js +28 -0
  91. package/dist/m365/viva/commands/engage/engage-group-list.js +5 -0
  92. package/dist/m365/viva/commands/engage/engage-group-user-add.js +5 -0
  93. package/dist/m365/viva/commands/engage/engage-group-user-remove.js +5 -0
  94. package/dist/m365/viva/commands/engage/engage-message-add.js +5 -0
  95. package/dist/m365/viva/commands/engage/engage-message-get.js +5 -0
  96. package/dist/m365/viva/commands/engage/engage-message-like-set.js +5 -0
  97. package/dist/m365/viva/commands/engage/engage-message-list.js +5 -0
  98. package/dist/m365/viva/commands/engage/engage-message-remove.js +5 -0
  99. package/dist/m365/viva/commands/engage/engage-network-list.js +5 -0
  100. package/dist/m365/viva/commands/engage/engage-report-activitycounts.js +8 -0
  101. package/dist/m365/viva/commands/engage/engage-report-activityusercounts.js +8 -0
  102. package/dist/m365/viva/commands/engage/engage-report-activityuserdetail.js +8 -0
  103. package/dist/m365/viva/commands/engage/engage-report-deviceusagedistributionusercounts.js +8 -0
  104. package/dist/m365/viva/commands/engage/engage-report-deviceusageusercounts.js +8 -0
  105. package/dist/m365/viva/commands/engage/engage-report-deviceusageuserdetail.js +8 -0
  106. package/dist/m365/viva/commands/engage/engage-report-groupsactivitycounts.js +8 -0
  107. package/dist/m365/viva/commands/engage/engage-report-groupsactivitydetail.js +8 -0
  108. package/dist/m365/viva/commands/engage/engage-report-groupsactivitygroupcounts.js +8 -0
  109. package/dist/m365/viva/commands/engage/engage-search.js +5 -0
  110. package/dist/m365/viva/commands/engage/engage-user-get.js +5 -0
  111. package/dist/m365/viva/commands/engage/engage-user-list.js +5 -0
  112. package/dist/m365/viva/commands/engage/yammerCommands.js +25 -0
  113. package/dist/m365/viva/commands.js +1 -0
  114. package/dist/request.js +46 -61
  115. package/dist/settingsNames.js +7 -1
  116. package/dist/utils/driveUtil.js +51 -0
  117. package/dist/utils/entraApp.js +283 -0
  118. package/dist/utils/spo.js +58 -66
  119. package/dist/utils/timersUtil.js +12 -0
  120. package/dist/utils/urlUtil.js +8 -0
  121. package/dist/utils/zod.js +1 -1
  122. package/docs/docs/_clisettings.mdx +6 -0
  123. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  124. package/docs/docs/cmd/cli/cli-consent.mdx +1 -1
  125. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
  126. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
  127. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
  128. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  129. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  130. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  131. package/docs/docs/cmd/entra/m365group/m365group-report-activitystorage.mdx +2 -2
  132. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  133. package/docs/docs/cmd/external/item/item-add.mdx +3 -3
  134. package/docs/docs/cmd/file/file-move.mdx +79 -0
  135. package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-list.mdx +132 -0
  136. package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-restore.mdx +55 -0
  137. package/docs/docs/cmd/onenote/notebook/notebook-add.mdx +169 -0
  138. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  139. package/docs/docs/cmd/setup.mdx +16 -3
  140. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +12 -11
  141. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +5 -6
  142. package/docs/docs/cmd/spo/cdn/cdn-get.mdx +1 -1
  143. package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +1 -1
  144. package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +1 -1
  145. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +1 -1
  146. package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +1 -1
  147. package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +1 -1
  148. package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +1 -1
  149. package/docs/docs/cmd/spo/file/file-copy.mdx +12 -119
  150. package/docs/docs/cmd/spo/folder/folder-set.mdx +6 -0
  151. package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +125 -0
  152. package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +50 -0
  153. package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +50 -0
  154. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +1 -1
  155. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +1 -1
  156. package/docs/docs/cmd/spo/homesite/homesite-remove.mdx +1 -1
  157. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.mdx +1 -1
  158. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.mdx +1 -1
  159. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.mdx +1 -1
  160. package/docs/docs/cmd/spo/list/list-list.mdx +7 -5
  161. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.mdx +1 -1
  162. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.mdx +1 -1
  163. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.mdx +1 -1
  164. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.mdx +1 -1
  165. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.mdx +1 -1
  166. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.mdx +1 -1
  167. package/docs/docs/cmd/spo/page/page-remove.mdx +30 -12
  168. package/docs/docs/cmd/spo/page/page-section-add.mdx +57 -2
  169. package/docs/docs/cmd/spo/site/site-admin-add.mdx +67 -0
  170. package/docs/docs/cmd/spo/site/site-admin-list.mdx +64 -12
  171. package/docs/docs/cmd/spo/site/site-admin-remove.mdx +67 -0
  172. package/docs/docs/cmd/spo/site/site-appcatalog-add.mdx +1 -1
  173. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +3 -12
  174. package/docs/docs/cmd/spo/site/site-commsite-enable.mdx +1 -1
  175. package/docs/docs/cmd/spo/site/site-list.mdx +6 -4
  176. package/docs/docs/cmd/spo/site/site-remove.mdx +3 -0
  177. package/docs/docs/cmd/spo/site/site-set.mdx +1 -1
  178. package/docs/docs/cmd/spo/site/site-sharingpermission-set.mdx +58 -0
  179. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +1 -1
  180. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +1 -1
  181. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx +1 -1
  182. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx +1 -1
  183. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.mdx +1 -1
  184. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.mdx +1 -1
  185. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +49 -2
  186. package/docs/docs/cmd/spo/tenant/tenant-settings-list.mdx +1 -1
  187. package/docs/docs/cmd/spo/theme/theme-apply.mdx +1 -1
  188. package/docs/docs/cmd/spo/theme/theme-get.mdx +1 -1
  189. package/docs/docs/cmd/spo/theme/theme-list.mdx +1 -1
  190. package/docs/docs/cmd/spo/theme/theme-remove.mdx +1 -1
  191. package/docs/docs/cmd/spo/theme/theme-set.mdx +1 -1
  192. package/docs/docs/cmd/spo/user/user-get.mdx +35 -9
  193. package/docs/docs/cmd/spp/contentcenter/contentcenter-list.mdx +287 -0
  194. package/docs/docs/cmd/teams/meeting/meeting-transcript-get.mdx +132 -0
  195. package/docs/docs/cmd/viva/engage/engage-community-list.mdx +81 -0
  196. package/npm-shrinkwrap.json +205 -377
  197. package/package.json +16 -17
@@ -28,12 +28,10 @@ m365 spo site admin list [options]
28
28
 
29
29
  :::info
30
30
 
31
- To use this command with the `--asAdmin` mode, you must have permission to access the tenant admin site.
31
+ To use this command with the `--asAdmin` mode, you must be at least SharePoint administrator.
32
32
 
33
33
  Without this parameter, you must have site collection admin permissions for the requested site.
34
34
 
35
- In `--asAdmin` mode, the Id, PrincipalType, and PrincipalTypeString properties are not exported.
36
-
37
35
  :::
38
36
 
39
37
  ## Examples
@@ -52,6 +50,8 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
52
50
 
53
51
  ## Response
54
52
 
53
+ ### Standard response
54
+
55
55
  <Tabs>
56
56
  <TabItem value="JSON">
57
57
 
@@ -73,13 +73,9 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
73
73
  <TabItem value="Text">
74
74
 
75
75
  ```text
76
- Email : user@contoso.com
77
- Id : 6
78
- LoginName : i:0#.f|membership|user@contoso.com
79
- PrincipalType : 1
80
- PrincipalTypeString : User
81
- Title : User Example
82
- IsPrimaryAdmin : true
76
+ Id LoginName Title PrincipalTypeString
77
+ -- --------------------------------------------------------------------------- ------- -------------------
78
+ 15 c:0o.c|federateddirectoryclaimprovider|d8430798-5a00-00ba-83b0-dd7a032d549a Members SecurityGroup
83
79
  ```
84
80
 
85
81
  </TabItem>
@@ -98,7 +94,7 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
98
94
 
99
95
  Date: 20/03/2024
100
96
 
101
- ## User
97
+ ## User Example
102
98
 
103
99
  Property | Value
104
100
  ---------|-------
@@ -112,4 +108,60 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
112
108
  ```
113
109
 
114
110
  </TabItem>
115
- </Tabs>
111
+ </Tabs>
112
+
113
+ ### `asAdmin` response
114
+
115
+ When we make use of the option `asAdmin` the response will differ.
116
+
117
+ <Tabs>
118
+ <TabItem value="JSON">
119
+
120
+ ```json
121
+ [
122
+ {
123
+ "Email": "user@contoso.com",
124
+ "LoginName": "i:0#.f|membership|user@contoso.com",
125
+ "Title": "User Example",
126
+ "IsPrimaryAdmin": true
127
+ }
128
+ ]
129
+ ```
130
+
131
+ </TabItem>
132
+ <TabItem value="Text">
133
+
134
+ ```text
135
+ LoginName Title
136
+ --------------------------------------------------------------------------- ---------------
137
+ c:0o.c|federateddirectoryclaimprovider|d8430798-5a00-00ba-83b0-dd7a032d549a Members
138
+ ```
139
+
140
+ </TabItem>
141
+ <TabItem value="CSV">
142
+
143
+ ```csv
144
+ Email,LoginName,Title,IsPrimaryAdmin
145
+ user@contoso.com,i:0#.f|membership|user@contoso.com,User Example,1
146
+ ```
147
+
148
+ </TabItem>
149
+ <TabItem value="Markdown">
150
+
151
+ ```md
152
+ # spo site admin list --siteUrl "https://contoso.sharepoint.com/sites/Test" --asAdmin
153
+
154
+ Date: 20/03/2024
155
+
156
+ ## User Example
157
+
158
+ Property | Value
159
+ ---------|-------
160
+ Email | user@contoso.com
161
+ LoginName | i:0#.f\|membership\|user@contoso.com
162
+ Title | User Example
163
+ IsPrimaryAdmin | true
164
+ ```
165
+
166
+ </TabItem>
167
+ </Tabs>
@@ -0,0 +1,67 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # spo site admin remove
6
+
7
+ Removes a user or group as site collection administrator
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 spo site admin remove [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-u, --siteUrl <siteUrl>`
19
+ : The URL of the SharePoint site
20
+
21
+ `--userId [userId]`
22
+ : The ID of the user to remove as a site collection admin
23
+
24
+ `--userName [userName]`
25
+ : The user principal name of the user to remove as a site collection admin
26
+
27
+ `--groupId [groupId]`
28
+ : The ID of the Microsoft Entra ID group to remove as a site collection admin
29
+
30
+ `--groupName [groupName]`
31
+ : The name of the Microsoft Entra ID group to remove as a site collection admin
32
+
33
+ `--asAdmin`
34
+ : If specified, we will use the SharePoint admin center to execute the command
35
+
36
+ `-f, --force`
37
+ : Don't prompt for confirmation
38
+ ```
39
+
40
+ <Global />
41
+
42
+ ## Remarks
43
+
44
+ :::info
45
+
46
+ To use this command with the `--asAdmin` mode, you have to have permissions to access the tenant admin site.
47
+
48
+ Without this parameter, you have to have site collection admin permissions for the requested site.
49
+
50
+ :::
51
+
52
+ ## Examples
53
+
54
+ Removes user as site collection admin
55
+
56
+ ```sh
57
+ m365 spo site admin remove --siteUrl https://contoso.sharepoint.com --userId 600713c5-53c6-4f24-b454-3c35e22b2639
58
+ ```
59
+
60
+ Removes group as site collection admin without prompting for confirmation as SharePoint Admin
61
+
62
+ ```sh
63
+ m365 spo site admin remove --siteUrl https://contoso.sharepoint.com --groupName SP_Administrators --force --asAdmin
64
+ ```
65
+ ## Response
66
+
67
+ The command won't return a response on success.
@@ -23,7 +23,7 @@ m365 spo site appcatalog add [options]
23
23
 
24
24
  :::info
25
25
 
26
- To use this command you have to have permissions to access the tenant admin site.
26
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
27
27
 
28
28
  :::
29
29
 
@@ -14,10 +14,7 @@ m365 spo site appcatalog remove [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --siteUrl <siteUrl>`
17
- : URL of the site collection containing the app catalog to disable.
18
-
19
- `-f, --force`
20
- : Don't prompt for confirmation.
17
+ : URL of the site collection containing the app catalog to disable
21
18
  ```
22
19
 
23
20
  <Global />
@@ -28,24 +25,18 @@ While the command uses the term *'remove'*, like its equivalent PowerShell cmdle
28
25
 
29
26
  :::info
30
27
 
31
- To use this command you have to have permissions to access the tenant admin site.
28
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
32
29
 
33
30
  :::
34
31
 
35
32
  ## Examples
36
33
 
37
- Remove the site collection app catalog from specified site.
34
+ Remove the site collection app catalog from specified site
38
35
 
39
36
  ```sh
40
37
  m365 spo site appcatalog remove --siteUrl https://contoso.sharepoint/sites/site
41
38
  ```
42
39
 
43
- Remove the site collection app catalog from specified site without prompting for confirmation.
44
-
45
- ```sh
46
- m365 spo site appcatalog remove --siteUrl https://contoso.sharepoint/sites/site --force
47
- ```
48
-
49
40
  ## Response
50
41
 
51
42
  The command won't return a response on success.
@@ -29,7 +29,7 @@ m365 spo site commsite enable [options]
29
29
 
30
30
  :::info
31
31
 
32
- To use this command you have to have permissions to access the tenant admin site.
32
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
33
33
 
34
34
  :::
35
35
 
@@ -173,6 +173,7 @@ m365 spo site list --includeOneDriveSites
173
173
  "SharingLockDownEnabled": false,
174
174
  "ShowPeoplePickerSuggestionsForGuestUsers": false,
175
175
  "SiteDefinedSharingCapability": 1,
176
+ "SiteId": "/Guid(a7c46398-494d-4a8d-b0db-f6e58432eb67)/",
176
177
  "SocialBarOnSitePagesDisabled": false,
177
178
  "Status": "Active",
178
179
  "StorageMaximumLevel": 1048576,
@@ -205,10 +206,10 @@ m365 spo site list --includeOneDriveSites
205
206
  <TabItem value="CSV">
206
207
 
207
208
  ```csv
208
- _ObjectType_;_ObjectIdentity_;AllowDownloadingNonWebViewableFiles;AllowEditing;AllowSelfServiceUpgrade;AnonymousLinkExpirationInDays;AuthenticationContextLimitedAccess;AverageResourceUsage;BlockDownloadLinksFileType;BlockDownloadPolicy;BlockGuestsAsSiteAdmin;ClearRestrictedAccessControl;CommentsOnSitePagesDisabled;CompatibilityLevel;ConditionalAccessPolicy;CurrentResourceUsage;DefaultLinkPermission;DefaultLinkToExistingAccess;DefaultLinkToExistingAccessReset;DefaultShareLinkRole;DefaultShareLinkScope;DefaultSharingLinkType;DenyAddAndCustomizePages;DisableAppViews;DisableCompanyWideSharingLinks;DisableFlows;ExcludeBlockDownloadPolicySiteOwners;ExternalUserExpirationInDays;GroupId;HasHolds;HubSiteId;IsGroupOwnerSiteAdmin;IsHubSite;IsTeamsChannelConnected;IsTeamsConnected;LastContentModifiedDate;Lcid;LimitedAccessFileType;ListsShowHeaderAndNavigation;LockState;LoopDefaultSharingLinkRole;LoopDefaultSharingLinkScope;LoopOverrideSharingCapability;LoopSharingCapability;MediaTranscription;OverrideBlockUserInfoVisibility;OverrideSharingCapability;OverrideTenantAnonymousLinkExpirationPolicy;OverrideTenantExternalUserExpirationPolicy;Owner;PWAEnabled;ReadOnlyAccessPolicy;ReadOnlyForBlockDownloadPolicy;ReadOnlyForUnmanagedDevices;RelatedGroupId;RequestFilesLinkEnabled;RequestFilesLinkExpirationInDays;RestrictedAccessControl;RestrictedToRegion;SandboxedCodeActivationCapability;SensitivityLabel;SetOwnerWithoutUpdatingSecondaryAdmin;SharingCapability;SharingDomainRestrictionMode;SharingLockDownCanBeCleared;SharingLockDownEnabled;ShowPeoplePickerSuggestionsForGuestUsers;SiteDefinedSharingCapability;SocialBarOnSitePagesDisabled;Status;StorageMaximumLevel;StorageUsage;StorageWarningLevel;TeamsChannelType;Template;TimeZoneId;Title;Url;UserCodeMaximumLevel;UserCodeWarningLevel;WebsCount
209
- Microsoft.Online.SharePoint.TenantAdministration.SiteProperties;"0a05bfa0-c046-6000-c2a5-1da5123cf537|908bed80-a04a-4433-b4a0-883d9847d110:1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
210
- SiteProperties
211
- https%3a%2f%2fcontoso.sharepoint.com%2fsites%2fteam1";;;1;0;;0;0;;0;;;15;0;0;0;;;0;0;0;2;0;0;0;;0;/Guid(00000000-0000-0000-0000-000000000000)/;;/Guid(5337976b-b560-4b64-b3fa-8eaf0339501a)/;;;;;/Date(2023,5,6,12,43,38,333)/;1033;0;;Unlock;0;0;;0;0;0;;;;john@contoso.onmicrosoft.com;1;;;;/Guid(00000000-0000-0000-0000-000000000000)/;;0;;3;0;/Guid(00000000-0000-0000-0000-000000000000)/;;0;0;;;;0;;Active;1048576;10;1022361;0;SITEPAGEPUBLISHING#0;13;Give @ Contoso;https://contoso.sharepoint.com/sites/team1;300;200;0
209
+ _ObjectType_,_ObjectIdentity_,AllowDownloadingNonWebViewableFiles,AllowEditing,AllowSelfServiceUpgrade,AnonymousLinkExpirationInDays,ApplyToExistingDocumentLibraries,ApplyToNewDocumentLibraries,ArchivedBy,ArchivedTime,ArchiveStatus,AuthContextStrength,AuthenticationContextLimitedAccess,AuthenticationContextName,AverageResourceUsage,BlockDownloadLinksFileType,BlockDownloadMicrosoft365GroupIds,BlockDownloadPolicy,BlockDownloadPolicyFileTypeIds,BlockGuestsAsSiteAdmin,BonusDiskQuota,ClearGroupId,ClearRestrictedAccessControl,CommentsOnSitePagesDisabled,CompatibilityLevel,ConditionalAccessPolicy,CurrentResourceUsage,DefaultLinkPermission,DefaultLinkToExistingAccess,DefaultLinkToExistingAccessReset,DefaultShareLinkRole,DefaultShareLinkScope,DefaultSharingLinkType,DenyAddAndCustomizePages,Description,DisableAppViews,DisableCompanyWideSharingLinks,DisableFlows,EnableAutoExpirationVersionTrim,ExcludeBlockDownloadPolicySiteOwners,ExpireVersionsAfterDays,ExternalUserExpirationInDays,GroupId,GroupOwnerLoginName,HasHolds,HubSiteId,IBMode,IBSegments,IBSegmentsToAdd,IBSegmentsToRemove,InheritVersionPolicyFromTenant,IsGroupOwnerSiteAdmin,IsHubSite,IsTeamsChannelConnected,IsTeamsConnected,LastContentModifiedDate,Lcid,LimitedAccessFileType,ListsShowHeaderAndNavigation,LockIssue,LockReason,LockState,LoopDefaultSharingLinkRole,LoopDefaultSharingLinkScope,MajorVersionLimit,MajorWithMinorVersionsLimit,MediaTranscription,OverrideBlockUserInfoVisibility,OverrideSharingCapability,OverrideTenantAnonymousLinkExpirationPolicy,OverrideTenantExternalUserExpirationPolicy,Owner,OwnerEmail,OwnerLoginName,OwnerName,PWAEnabled,ReadOnlyAccessPolicy,ReadOnlyForBlockDownloadPolicy,ReadOnlyForUnmanagedDevices,RelatedGroupId,RequestFilesLinkEnabled,RequestFilesLinkExpirationInDays,RestrictContentOrgWideSearch,RestrictedAccessControl,RestrictedAccessControlGroups,RestrictedAccessControlGroupsToAdd,RestrictedAccessControlGroupsToRemove,RestrictedToRegion,SandboxedCodeActivationCapability,SensitivityLabel,SensitivityLabel2,SetOwnerWithoutUpdatingSecondaryAdmin,SharingAllowedDomainList,SharingBlockedDomainList,SharingCapability,SharingDomainRestrictionMode,SharingLockDownCanBeCleared,SharingLockDownEnabled,ShowPeoplePickerSuggestionsForGuestUsers,SiteDefinedSharingCapability,SiteId,SocialBarOnSitePagesDisabled,Status,StorageMaximumLevel,StorageQuotaType,StorageUsage,StorageWarningLevel,TeamsChannelType,Template,TimeZoneId,Title,TitleTranslations,Url,UserCodeMaximumLevel,UserCodeWarningLevel,WebsCount
210
+ Microsoft.Online.SharePoint.TenantAdministration.SiteProperties,"7f934fa1-20ab-9000-f15c-df8f2970f555|908bed80-a04a-4433-b4a0-883d9847d110:18c58817-3bc9-489d-ac63-f7264fb357e5
211
+ SiteProperties
212
+ https%3a%2f%2fcontoso.sharepoint.com%2fsites%2fteam1",,,1,0,,,,"/Date(1,0,1,0,0,0,0)/",NotArchived,,,,0,0,,,,0,0,,,,15,0,0,0,,,0,0,0,2,,0,0,0,,,0,0,/Guid(004db326-a1de-4c5e-ad45-746fd89f57bb)/,,,/Guid(00000000-0000-0000-0000-000000000000)/,,,,,,,,,,"/Date(2024,6,17,21,54,44,437)/",1033,0,,,0,Unlock,0,0,0,0,0,0,,,,,,,,1,,,,/Guid(004db326-a1de-4c5e-ad45-746fd89f57bb)/,,0,,,,,,3,0,/Guid(00000000-0000-0000-0000-000000000000)/,,,,,1,0,,,,1,/Guid(a7c46398-494d-4a8d-b0db-f6e58432eb67)/,,Active,26214400,,1,25574400,0,GROUP#0,3,team1,,https://contoso.sharepoint.com/sites/team1,300,200,0
212
213
  ```
213
214
 
214
215
  </TabItem>
@@ -291,6 +292,7 @@ m365 spo site list --includeOneDriveSites
291
292
  SharingLockDownEnabled | false
292
293
  ShowPeoplePickerSuggestionsForGuestUsers | false
293
294
  SiteDefinedSharingCapability | 0
295
+ SiteId | /Guid(a7c46398-494d-4a8d-b0db-f6e58432eb67)/,
294
296
  SocialBarOnSitePagesDisabled | false
295
297
  Status | Active
296
298
  StorageMaximumLevel | 0
@@ -22,6 +22,9 @@ m365 spo site remove [options]
22
22
  `--fromRecycleBin`
23
23
  : Set to remove the site from the recycle bin.
24
24
 
25
+ `--wait`
26
+ : (deprecated) Wait for the site to be removed before completing the command.
27
+
25
28
  `-f, --force`
26
29
  : Don't prompt for confirmation.
27
30
  ```
@@ -103,7 +103,7 @@ Setting site properties is by default asynchronous and depending on the current
103
103
 
104
104
  :::info
105
105
 
106
- To use this command you have to have permissions to access the tenant admin site.
106
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
107
107
 
108
108
  :::
109
109
 
@@ -0,0 +1,58 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # spo site sharingpermission set
4
+
5
+ Controls how a site and its components can be shared
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 spo site sharingpermission set [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-u, --url <url>`
17
+ : URL of the site.
18
+
19
+ `--capability <capability>`
20
+ : Define how the site is shared. Possible values: `full`, `limited`, `ownersOnly`.
21
+ ```
22
+
23
+ <Global />
24
+
25
+ ## Remarks
26
+
27
+ When specifying `capability`, consider the following:
28
+ - `full`: Site owners and members can share files, folders, and the site. People with Edit permissions can share files and folders.
29
+ - `limited`: Site owners and members, and people with Edit permissions can share files and folders, but only site owners can share the site.
30
+ - `ownersOnly`: Only site owners can share files, folders, and the site.
31
+
32
+ ## Examples
33
+
34
+ Update the sharing permissions for a site so only owners can share files and the site
35
+
36
+ ```sh
37
+ m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename --capability ownersOnly
38
+ ```
39
+
40
+ Update the sharing permissions for a site where so both owners and members can share files and the site
41
+
42
+ ```sh
43
+ m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename --capability full
44
+ ```
45
+
46
+ Update the sharing permissions for a site where so owners can share the site, but members can only share files
47
+
48
+ ```sh
49
+ m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename --capability full
50
+ ```
51
+
52
+ ## Response
53
+
54
+ The command won't return a response on success.
55
+
56
+ ## More information
57
+
58
+ - Sharing a SharePoint site: [https://support.microsoft.com/office/share-a-site-958771a8-d041-4eb8-b51c-afea2eae3658](https://support.microsoft.com/office/share-a-site-958771a8-d041-4eb8-b51c-afea2eae3658)
@@ -31,7 +31,7 @@ Tenant properties are stored in the app catalog site associated with that tenant
31
31
 
32
32
  :::info
33
33
 
34
- To use this command you have to have permissions to access the tenant admin site.
34
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
35
35
 
36
36
  :::
37
37
 
@@ -39,7 +39,7 @@ If you specify the URL of a site different than the app catalog, you will get an
39
39
 
40
40
  :::info
41
41
 
42
- To use this command you have to have permissions to access the tenant admin site.
42
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
43
43
 
44
44
  :::
45
45
 
@@ -41,7 +41,7 @@ Creating an app catalog site might take a while. If you need to wait for the sit
41
41
 
42
42
  :::info
43
43
 
44
- To use this command you have to have permissions to access the tenant admin site.
44
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
45
45
 
46
46
  :::
47
47
 
@@ -20,7 +20,7 @@ m365 spo tenant appcatalogurl get [options]
20
20
 
21
21
  :::info
22
22
 
23
- To use this command you have to have permissions to access the tenant admin site.
23
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
24
24
 
25
25
  :::
26
26
 
@@ -20,7 +20,7 @@ m365 spo tenant recyclebinitem list [options]
20
20
 
21
21
  :::info
22
22
 
23
- To use this command you have to have permissions to access the tenant admin site.
23
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
24
24
 
25
25
  :::
26
26
 
@@ -31,7 +31,7 @@ Removing a site collection is by default asynchronous and depending on the curre
31
31
 
32
32
  :::info
33
33
 
34
- To use this command you have to have permissions to access the tenant admin site.
34
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
35
35
 
36
36
  :::
37
37
 
@@ -17,6 +17,9 @@ m365 spo tenant recyclebinitem restore [options]
17
17
  ```md definition-list
18
18
  `-u, --siteUrl <siteUrl>`
19
19
  : URL of the site.
20
+
21
+ `--wait`
22
+ : (deprecated) Wait for the site collection to be restored before completing the command.
20
23
  ```
21
24
 
22
25
  <Global />
@@ -31,7 +34,7 @@ To use this command you must be a Global or SharePoint administrator.
31
34
 
32
35
  ## Examples
33
36
 
34
- Restores a deleted site collection from tenant recycle bin.
37
+ Restore a deleted site collection from tenant recycle bin
35
38
 
36
39
  ```sh
37
40
  m365 spo tenant recyclebinitem restore --siteUrl https://contoso.sharepoint.com/sites/team
@@ -39,4 +42,48 @@ m365 spo tenant recyclebinitem restore --siteUrl https://contoso.sharepoint.com/
39
42
 
40
43
  ## Response
41
44
 
42
- The command won't return a response on success.
45
+ <Tabs>
46
+ <TabItem value="JSON">
47
+
48
+ ```json
49
+ {
50
+ "HasTimedout": false,
51
+ "IsComplete": true,
52
+ "PollingInterval": 15000
53
+ }
54
+ ```
55
+
56
+ </TabItem>
57
+ <TabItem value="Text">
58
+
59
+ ```text
60
+ HasTimedout : false
61
+ IsComplete : true
62
+ PollingInterval: 15000
63
+ ```
64
+
65
+ </TabItem>
66
+ <TabItem value="CSV">
67
+
68
+ ```csv
69
+ HasTimedout,IsComplete,PollingInterval
70
+ ,1,15000
71
+ ```
72
+
73
+ </TabItem>
74
+ <TabItem value="Markdown">
75
+
76
+ ```md
77
+ # spo tenant recyclebinitem restore --siteUrl "https://contoso.sharepoint.com/teams/team1"
78
+
79
+ Date: 2023-06-22
80
+
81
+ Property | Value
82
+ ---------|-------
83
+ HasTimedout | false
84
+ IsComplete | true
85
+ PollingInterval | 15000
86
+ ```
87
+
88
+ </TabItem>
89
+ </Tabs>
@@ -20,7 +20,7 @@ m365 spo tenant settings list [options]
20
20
 
21
21
  :::info
22
22
 
23
- To use this command you have to have permissions to access the tenant admin site.
23
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
24
24
 
25
25
  :::
26
26
 
@@ -33,7 +33,7 @@ Following standard SharePoint themes are supported by the CLI for Microsoft 365:
33
33
 
34
34
  :::info
35
35
 
36
- To use this command you have to have permissions to access the tenant admin site.
36
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
37
37
 
38
38
  :::
39
39
 
@@ -25,7 +25,7 @@ m365 spo theme get [options]
25
25
 
26
26
  :::info
27
27
 
28
- To use this command you have to have permissions to access the tenant admin site.
28
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
29
29
 
30
30
  :::
31
31
 
@@ -20,7 +20,7 @@ m365 spo theme list [options]
20
20
 
21
21
  :::info
22
22
 
23
- To use this command you have to have permissions to access the tenant admin site.
23
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
24
24
 
25
25
  :::
26
26
 
@@ -26,7 +26,7 @@ m365 spo theme remove [options]
26
26
 
27
27
  :::info
28
28
 
29
- To use this command you have to have permissions to access the tenant admin site.
29
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
30
30
 
31
31
  :::
32
32
 
@@ -67,7 +67,7 @@ If any of these checks fails you are presented with a `The specified theme is no
67
67
 
68
68
  :::info
69
69
 
70
- To use this command you have to have permissions to access the tenant admin site.
70
+ To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
71
71
 
72
72
  :::
73
73
 
@@ -16,41 +16,68 @@ m365 spo user get [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-u, --webUrl <webUrl>`
19
- : URL of the web to get the user within
19
+ : URL of the web to get the user within.
20
20
 
21
21
  `-i, --id [id]`
22
- : ID of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
22
+ : ID of the user to retrieve information for. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.
23
23
 
24
24
  `--email [email]`
25
- : Email of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
25
+ : Email of the user to retrieve information for. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.
26
26
 
27
27
  `--loginName [loginName]`
28
- : Login name of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
28
+ : Login name of the user to retrieve information for. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.
29
+
30
+ `--userName [userName]`
31
+ : User's UPN (user principal name, eg. megan.bowen@contoso.com). Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.
32
+
33
+ `--entraGroupId [entraGroupId]`
34
+ : The object ID of the Microsoft Entra group. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.
35
+
36
+ `--entraGroupName [entraGroupName]`
37
+ : The name of the Microsoft Entra group. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.
29
38
  ```
30
39
 
31
40
  <Global />
32
41
 
33
42
  ## Examples
34
43
 
35
- Get user by email for a web
44
+ Get user by email for a web.
36
45
 
37
46
  ```sh
38
47
  m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --email john.doe@mytenant.onmicrosoft.com
39
48
  ```
40
49
 
41
- Get user by ID for a web
50
+ Get user by ID for a web.
42
51
 
43
52
  ```sh
44
53
  m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --id 6
45
54
  ```
46
55
 
47
- Get user by login name for a web
56
+ Get user by login name for a web.
48
57
 
49
58
  ```sh
50
59
  m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --loginName "i:0#.f|membership|john.doe@mytenant.onmicrosoft.com"
51
60
  ```
52
61
 
53
- Get the currently logged-in user
62
+ Get user by user's UPN for a web.
63
+
64
+ ```sh
65
+ m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --userName "john.doe@mytenant.onmicrosoft.com"
66
+ ```
67
+
68
+ Get user by entraGroupId for a web.
69
+
70
+ ```sh
71
+ m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --entraGroupId f832a493-de73-4fef-87ed-8c6fffd91be6
72
+ ```
73
+
74
+ Get user by entraGroupName for a web.
75
+
76
+ ```sh
77
+ m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --entraGroupName "Test Members"
78
+ ```
79
+
80
+ Get the currently logged-in user.
54
81
 
55
82
  ```sh
56
83
  m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x
@@ -134,4 +161,3 @@ m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x
134
161
 
135
162
  </TabItem>
136
163
  </Tabs>
137
-