@pnp/cli-microsoft365 11.0.0 → 11.1.0-beta.111c36f

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 (199) hide show
  1. package/.devproxy/api-specs/sharepoint.yaml +41 -0
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/Auth.js +10 -7
  5. package/dist/Command.js +2 -2
  6. package/dist/auth/msalCachePlugin.js +6 -2
  7. package/dist/autocomplete.js +6 -2
  8. package/dist/chili/chili.js +2 -1
  9. package/dist/cli/cli.js +4 -2
  10. package/dist/config.js +0 -1
  11. package/dist/m365/adaptivecard/commands/adaptivecard-send.js +2 -2
  12. package/dist/m365/app/commands/permission/permission-list.js +4 -2
  13. package/dist/m365/booking/commands/business/business-list.js +5 -0
  14. package/dist/m365/commands/setup.js +6 -3
  15. package/dist/m365/commands/status.js +5 -1
  16. package/dist/m365/connection/commands/connection-list.js +5 -1
  17. package/dist/m365/entra/commands/app/app-role-add.js +1 -1
  18. package/dist/m365/entra/commands/group/group-add.js +1 -1
  19. package/dist/m365/entra/commands/group/group-set.js +1 -1
  20. package/dist/m365/entra/commands/license/license-list.js +5 -0
  21. package/dist/m365/entra/commands/m365group/m365group-add.js +0 -1
  22. package/dist/m365/file/commands/convert/convert-pdf.js +1 -6
  23. package/dist/m365/flow/commands/environment/environment-list.js +5 -0
  24. package/dist/m365/flow/commands/flow-export.js +8 -5
  25. package/dist/m365/flow/commands/run/run-get.js +3 -3
  26. package/dist/m365/graph/commands/schemaextension/schemaextension-set.js +1 -1
  27. package/dist/m365/onedrive/commands/onedrive-list.js +5 -0
  28. package/dist/m365/outlook/commands/roomlist/roomlist-list.js +5 -0
  29. package/dist/m365/pa/commands/app/app-export.js +1 -1
  30. package/dist/m365/pa/commands/app/app-get.js +1 -1
  31. package/dist/m365/pa/commands/environment/environment-list.js +5 -0
  32. package/dist/m365/planner/commands/tenant/tenant-settings-list.js +5 -0
  33. package/dist/m365/pp/commands/environment/environment-list.js +10 -23
  34. package/dist/m365/pp/commands/solution/solution-publisher-get.js +1 -1
  35. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +5 -0
  36. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +5 -0
  37. package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
  38. package/dist/m365/spfx/commands/package/package-generate.js +3 -1
  39. package/dist/m365/spfx/commands/project/base-project-command.js +13 -5
  40. package/dist/m365/spfx/commands/project/project-doctor/rules/FN021007_PKG_only_one_rush_stack_compiler_installed.js +1 -1
  41. package/dist/m365/spfx/commands/project/project-externalize/rules/PnPJsRule.js +6 -4
  42. package/dist/m365/spfx/commands/project/project-model/ScssFile.js +3 -1
  43. package/dist/m365/spfx/commands/project/project-model/TsFile.js +6 -2
  44. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +1 -1
  45. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.16.0.js +2 -0
  46. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.17.0.js +2 -0
  47. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.18.0.js +2 -0
  48. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.19.0.js +2 -0
  49. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.20.0.js +2 -0
  50. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.21.0.js +2 -0
  51. package/dist/m365/spfx/commands/spfx-doctor.js +5 -5
  52. package/dist/m365/spo/commands/file/file-add.js +4 -2
  53. package/dist/m365/spo/commands/file/file-rename.js +3 -4
  54. package/dist/m365/spo/commands/hubsite/hubsite-list.js +1 -1
  55. package/dist/m365/spo/commands/listitem/listitem-attachment-add.js +1 -1
  56. package/dist/m365/spo/commands/listitem/listitem-batch-set.js +9 -5
  57. package/dist/m365/spo/commands/page/clientsidepages.js +12 -12
  58. package/dist/m365/spo/commands/page/page-add.js +4 -2
  59. package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +1 -0
  60. package/dist/m365/spo/commands/page/page-set.js +4 -2
  61. package/dist/m365/spo/commands/page/page-text-add.js +1 -0
  62. package/dist/m365/spo/commands/propertybag/propertybag-base.js +34 -54
  63. package/dist/m365/spo/commands/site/site-alert-list.js +107 -0
  64. package/dist/m365/spo/commands/site/site-alert-remove.js +59 -0
  65. package/dist/m365/spo/commands/theme/theme-apply.js +1 -1
  66. package/dist/m365/spo/commands/web/web-reindex.js +17 -27
  67. package/dist/m365/spo/commands.js +2 -0
  68. package/dist/m365/teams/commands/tab/tab-add.js +9 -3
  69. package/dist/m365/viva/commands/connections/connections-app-create.js +1 -1
  70. package/dist/m365/viva/commands/engage/engage-community-user-add.js +1 -1
  71. package/dist/m365/viva/commands/engage/engage-community-user-remove.js +1 -1
  72. package/dist/telemetry.js +3 -1
  73. package/dist/utils/accessToken.js +4 -0
  74. package/dist/utils/cache.js +3 -2
  75. package/dist/utils/customAppScope.js +1 -1
  76. package/dist/utils/directoryExtension.js +1 -1
  77. package/dist/utils/entraAdministrativeUnit.js +1 -1
  78. package/dist/utils/entraApp.js +2 -2
  79. package/dist/utils/entraDevice.js +1 -1
  80. package/dist/utils/entraServicePrincipal.js +2 -2
  81. package/dist/utils/formatting.js +1 -1
  82. package/dist/utils/md.js +2 -2
  83. package/dist/utils/odata.js +2 -0
  84. package/dist/utils/planner.js +1 -1
  85. package/dist/utils/powerPlatform.js +2 -2
  86. package/dist/utils/roleDefinition.js +2 -2
  87. package/dist/utils/spo.js +10 -11
  88. package/dist/utils/urlUtil.js +1 -1
  89. package/dist/utils/validation.js +1 -1
  90. package/dist/utils/vivaEngage.js +3 -3
  91. package/docs/docs/cmd/booking/business/business-get.mdx +18 -1
  92. package/docs/docs/cmd/booking/business/business-list.mdx +18 -1
  93. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-add.mdx +19 -0
  94. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-get.mdx +19 -0
  95. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-list.mdx +19 -0
  96. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-add.mdx +21 -0
  97. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-get.mdx +19 -0
  98. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-list.mdx +19 -0
  99. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-remove.mdx +21 -0
  100. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-remove.mdx +21 -0
  101. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-roleassignment-add.mdx +19 -0
  102. package/docs/docs/cmd/entra/app/app-add.mdx +18 -0
  103. package/docs/docs/cmd/entra/app/app-get.mdx +19 -1
  104. package/docs/docs/cmd/entra/app/app-list.mdx +18 -1
  105. package/docs/docs/cmd/entra/app/app-remove.mdx +20 -0
  106. package/docs/docs/cmd/entra/app/app-set.mdx +20 -0
  107. package/docs/docs/cmd/entra/approleassignment/approleassignment-add.mdx +18 -0
  108. package/docs/docs/cmd/entra/approleassignment/approleassignment-list.mdx +18 -0
  109. package/docs/docs/cmd/entra/approleassignment/approleassignment-remove.mdx +20 -0
  110. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +14 -0
  111. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +15 -0
  112. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +14 -0
  113. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-remove.mdx +14 -0
  114. package/docs/docs/cmd/entra/group/group-add.mdx +18 -0
  115. package/docs/docs/cmd/entra/group/group-get.mdx +18 -0
  116. package/docs/docs/cmd/entra/group/group-list.mdx +18 -0
  117. package/docs/docs/cmd/entra/group/group-member-add.mdx +20 -0
  118. package/docs/docs/cmd/entra/group/group-member-list.mdx +18 -0
  119. package/docs/docs/cmd/entra/group/group-member-remove.mdx +20 -0
  120. package/docs/docs/cmd/entra/group/group-member-set.mdx +20 -0
  121. package/docs/docs/cmd/entra/group/group-remove.mdx +20 -0
  122. package/docs/docs/cmd/entra/group/group-set.mdx +20 -0
  123. package/docs/docs/cmd/entra/groupsetting/groupsetting-add.mdx +19 -0
  124. package/docs/docs/cmd/entra/groupsetting/groupsetting-get.mdx +19 -0
  125. package/docs/docs/cmd/entra/groupsetting/groupsetting-list.mdx +19 -0
  126. package/docs/docs/cmd/entra/groupsetting/groupsetting-remove.mdx +21 -0
  127. package/docs/docs/cmd/entra/groupsetting/groupsetting-set.mdx +21 -0
  128. package/docs/docs/cmd/entra/m365group/m365group-add.mdx +19 -0
  129. package/docs/docs/cmd/entra/m365group/m365group-get.mdx +19 -0
  130. package/docs/docs/cmd/entra/m365group/m365group-list.mdx +19 -0
  131. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-clear.mdx +14 -0
  132. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +19 -0
  133. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-remove.mdx +14 -0
  134. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-restore.mdx +21 -0
  135. package/docs/docs/cmd/entra/m365group/m365group-remove.mdx +21 -0
  136. package/docs/docs/cmd/entra/m365group/m365group-renew.mdx +21 -0
  137. package/docs/docs/cmd/entra/m365group/m365group-report-activitycounts.mdx +18 -0
  138. package/docs/docs/cmd/entra/m365group/m365group-report-activitydetail.mdx +18 -0
  139. package/docs/docs/cmd/entra/m365group/m365group-report-activityfilecounts.mdx +18 -0
  140. package/docs/docs/cmd/entra/m365group/m365group-report-activitygroupcounts.mdx +18 -0
  141. package/docs/docs/cmd/entra/m365group/m365group-report-activitystorage.mdx +18 -0
  142. package/docs/docs/cmd/entra/m365group/m365group-set.mdx +21 -0
  143. package/docs/docs/cmd/entra/m365group/m365group-teamify.mdx +19 -0
  144. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +18 -0
  145. package/docs/docs/cmd/entra/multitenant/multitenant-get.mdx +18 -1
  146. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +20 -0
  147. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +20 -0
  148. package/docs/docs/cmd/entra/oauth2grant/oauth2grant-add.mdx +20 -0
  149. package/docs/docs/cmd/entra/oauth2grant/oauth2grant-list.mdx +17 -0
  150. package/docs/docs/cmd/entra/oauth2grant/oauth2grant-remove.mdx +20 -0
  151. package/docs/docs/cmd/entra/oauth2grant/oauth2grant-set.mdx +20 -0
  152. package/docs/docs/cmd/entra/organization/organization-list.mdx +19 -2
  153. package/docs/docs/cmd/entra/pim/pim-role-assignment-add.mdx +18 -0
  154. package/docs/docs/cmd/entra/pim/pim-role-assignment-eligibility-list.mdx +18 -0
  155. package/docs/docs/cmd/entra/pim/pim-role-assignment-list.mdx +18 -0
  156. package/docs/docs/cmd/entra/pim/pim-role-assignment-remove.mdx +18 -0
  157. package/docs/docs/cmd/entra/pim/pim-role-request-list.mdx +18 -0
  158. package/docs/docs/cmd/graph/directoryextension/directoryextension-add.mdx +18 -0
  159. package/docs/docs/cmd/graph/directoryextension/directoryextension-get.mdx +18 -0
  160. package/docs/docs/cmd/graph/directoryextension/directoryextension-list.mdx +18 -0
  161. package/docs/docs/cmd/graph/directoryextension/directoryextension-remove.mdx +20 -0
  162. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.mdx +18 -1
  163. package/docs/docs/cmd/graph/schemaextension/schemaextension-get.mdx +18 -1
  164. package/docs/docs/cmd/graph/schemaextension/schemaextension-list.mdx +19 -1
  165. package/docs/docs/cmd/graph/schemaextension/schemaextension-remove.mdx +20 -0
  166. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.mdx +23 -3
  167. package/docs/docs/cmd/graph/subscription/subscription-add.mdx +27 -6
  168. package/docs/docs/cmd/outlook/mail/mail-send.mdx +21 -0
  169. package/docs/docs/cmd/outlook/mailbox/mailbox-settings-get.mdx +20 -1
  170. package/docs/docs/cmd/outlook/mailbox/mailbox-settings-set.mdx +20 -1
  171. package/docs/docs/cmd/outlook/room/room-list.mdx +19 -0
  172. package/docs/docs/cmd/outlook/roomlist/roomlist-list.mdx +19 -0
  173. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx +18 -0
  174. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx +18 -0
  175. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx +18 -0
  176. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.mdx +20 -0
  177. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx +18 -0
  178. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.mdx +18 -0
  179. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.mdx +18 -0
  180. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.mdx +21 -1
  181. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.mdx +21 -1
  182. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.mdx +11 -0
  183. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.mdx +12 -1
  184. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.mdx +12 -1
  185. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.mdx +14 -1
  186. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.mdx +13 -0
  187. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.mdx +18 -0
  188. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.mdx +18 -0
  189. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.mdx +18 -0
  190. package/docs/docs/cmd/purview/threatassessment/threatassessment-add.mdx +12 -0
  191. package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +19 -0
  192. package/docs/docs/cmd/purview/threatassessment/threatassessment-list.mdx +19 -0
  193. package/docs/docs/cmd/spo/site/site-alert-list.mdx +187 -0
  194. package/docs/docs/cmd/spo/site/site-alert-remove.mdx +65 -0
  195. package/eslint-rules/lib/rules/correct-command-class-name.js +18 -2
  196. package/eslint.config.mjs +270 -0
  197. package/npm-shrinkwrap.json +1281 -2306
  198. package/package.json +31 -24
  199. package/.eslintrc.cjs +0 -289
@@ -29,6 +29,24 @@ This command is based on an API that is currently in preview and is subject to c
29
29
 
30
30
  :::
31
31
 
32
+ ## Permissions
33
+ <Tabs>
34
+ <TabItem value="Delegated">
35
+
36
+ | Resource | Permissions |
37
+ |-----------------|----------------------------|
38
+ | Microsoft Graph | RecordsManagement.Read.All |
39
+
40
+ </TabItem>
41
+ <TabItem value="Application">
42
+
43
+ | Resource | Permissions |
44
+ |-----------------|----------------------------|
45
+ | Microsoft Graph | RecordsManagement.Read.All |
46
+
47
+ </TabItem>
48
+ </Tabs>
49
+
32
50
  ## Examples
33
51
 
34
52
  Get a retention event type by id.
@@ -24,6 +24,24 @@ This command is based on a Microsoft Graph API that is currently in preview and
24
24
 
25
25
  :::
26
26
 
27
+ ## Permissions
28
+ <Tabs>
29
+ <TabItem value="Delegated">
30
+
31
+ | Resource | Permissions |
32
+ |-----------------|----------------------------|
33
+ | Microsoft Graph | RecordsManagement.Read.All |
34
+
35
+ </TabItem>
36
+ <TabItem value="Application">
37
+
38
+ | Resource | Permissions |
39
+ |-----------------|----------------------------|
40
+ | Microsoft Graph | RecordsManagement.Read.All |
41
+
42
+ </TabItem>
43
+ </Tabs>
44
+
27
45
  ## Examples
28
46
 
29
47
  Get a list of retention event types.
@@ -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
  # purview retentioneventtype remove
4
6
 
@@ -30,9 +32,27 @@ This command is based on a Microsoft Graph API that is currently in preview and
30
32
 
31
33
  :::
32
34
 
35
+ ## Permissions
36
+ <Tabs>
37
+ <TabItem value="Delegated">
38
+
39
+ | Resource | Permissions |
40
+ |-----------------|---------------------------------|
41
+ | Microsoft Graph | RecordsManagement.ReadWrite.All |
42
+
43
+ </TabItem>
44
+ <TabItem value="Application">
45
+
46
+ | Resource | Permissions |
47
+ |-----------------|---------------------------------|
48
+ | Microsoft Graph | RecordsManagement.ReadWrite.All |
49
+
50
+ </TabItem>
51
+ </Tabs>
52
+
33
53
  ## Examples
34
54
 
35
- Delete a retention event type by id
55
+ Delete a retention event type by id.
36
56
 
37
57
  ```sh
38
58
  m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
@@ -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
  # purview retentioneventtype set
4
6
 
@@ -30,9 +32,27 @@ This command is based on a Microsoft Graph API that is currently in preview and
30
32
 
31
33
  :::
32
34
 
35
+ ## Permissions
36
+ <Tabs>
37
+ <TabItem value="Delegated">
38
+
39
+ | Resource | Permissions |
40
+ |-----------------|---------------------------------|
41
+ | Microsoft Graph | RecordsManagement.ReadWrite.All |
42
+
43
+ </TabItem>
44
+ <TabItem value="Application">
45
+
46
+ | Resource | Permissions |
47
+ |-----------------|---------------------------------|
48
+ | Microsoft Graph | RecordsManagement.ReadWrite.All |
49
+
50
+ </TabItem>
51
+ </Tabs>
52
+
33
53
  ## Examples
34
54
 
35
- Update the description of a retention event type
55
+ Update the description of a retention event type.
36
56
 
37
57
  ```sh
38
58
  m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
@@ -59,6 +59,17 @@ This command is based on a Microsoft Graph API that is currently in preview and
59
59
 
60
60
  :::
61
61
 
62
+ ## Permissions
63
+ <Tabs>
64
+ <TabItem value="Delegated">
65
+
66
+ | Resource | Permissions |
67
+ |-----------------|---------------------------------|
68
+ | Microsoft Graph | RecordsManagement.ReadWrite.All |
69
+
70
+ </TabItem>
71
+ </Tabs>
72
+
62
73
  ## Examples
63
74
 
64
75
  Create a retention label that retains documents and deletes them after one year.
@@ -29,9 +29,20 @@ This command is based on a Microsoft Graph API that is currently in preview and
29
29
 
30
30
  :::
31
31
 
32
+ ## Permissions
33
+ <Tabs>
34
+ <TabItem value="Delegated">
35
+
36
+ | Resource | Permissions |
37
+ |-----------------|----------------------------|
38
+ | Microsoft Graph | RecordsManagement.Read.All |
39
+
40
+ </TabItem>
41
+ </Tabs>
42
+
32
43
  ## Examples
33
44
 
34
- Get a retention label
45
+ Get a retention label.
35
46
 
36
47
  ```sh
37
48
  m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
@@ -24,9 +24,20 @@ This command is based on a Microsoft Graph API that is currently in preview and
24
24
 
25
25
  :::
26
26
 
27
+ ## Permissions
28
+ <Tabs>
29
+ <TabItem value="Delegated">
30
+
31
+ | Resource | Permissions |
32
+ |-----------------|----------------------------|
33
+ | Microsoft Graph | RecordsManagement.Read.All |
34
+
35
+ </TabItem>
36
+ </Tabs>
37
+
27
38
  ## Examples
28
39
 
29
- Get a list of retention labels
40
+ Get a list of retention labels.
30
41
 
31
42
  ```sh
32
43
  m365 purview retentionlabel list
@@ -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
  # purview retentionlabel remove
4
6
 
@@ -30,9 +32,20 @@ This command is based on a Microsoft Graph API that is currently in preview and
30
32
 
31
33
  :::
32
34
 
35
+ ## Permissions
36
+ <Tabs>
37
+ <TabItem value="Delegated">
38
+
39
+ | Resource | Permissions |
40
+ |-----------------|---------------------------------|
41
+ | Microsoft Graph | RecordsManagement.ReadWrite.All |
42
+
43
+ </TabItem>
44
+ </Tabs>
45
+
33
46
  ## Examples
34
47
 
35
- Delete a retention label
48
+ Delete a retention label.
36
49
 
37
50
  ```sh
38
51
  m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
@@ -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
  # purview retentionlabel set
4
6
 
@@ -51,6 +53,17 @@ This command is based on a Microsoft Graph API that is currently in preview and
51
53
 
52
54
  :::
53
55
 
56
+ ## Permissions
57
+ <Tabs>
58
+ <TabItem value="Delegated">
59
+
60
+ | Resource | Permissions |
61
+ |-----------------|---------------------------------|
62
+ | Microsoft Graph | RecordsManagement.ReadWrite.All |
63
+
64
+ </TabItem>
65
+ </Tabs>
66
+
54
67
  ## Examples
55
68
 
56
69
  Update a retention label so that it retains documents as records and deletes them after one year.
@@ -41,6 +41,24 @@ When operating in app-only mode, you have the option to use either the `userName
41
41
 
42
42
  :::
43
43
 
44
+ ## Permissions
45
+ <Tabs>
46
+ <TabItem value="Delegated">
47
+
48
+ | Resource | Permissions |
49
+ |-----------------|----------------------------------|
50
+ | Microsoft Graph | InformationProtectionPolicy.Read |
51
+
52
+ </TabItem>
53
+ <TabItem value="Application">
54
+
55
+ | Resource | Permissions |
56
+ |-----------------|--------------------------------------|
57
+ | Microsoft Graph | InformationProtectionPolicy.Read.All |
58
+
59
+ </TabItem>
60
+ </Tabs>
61
+
44
62
  ## Examples
45
63
 
46
64
  Get a sensitivity label.
@@ -38,6 +38,24 @@ When operating in app-only mode, you have the option to use either the `userName
38
38
 
39
39
  :::
40
40
 
41
+ ## Permissions
42
+ <Tabs>
43
+ <TabItem value="Delegated">
44
+
45
+ | Resource | Permissions |
46
+ |-----------------|----------------------------------|
47
+ | Microsoft Graph | InformationProtectionPolicy.Read |
48
+
49
+ </TabItem>
50
+ <TabItem value="Application">
51
+
52
+ | Resource | Permissions |
53
+ |-----------------|--------------------------------------|
54
+ | Microsoft Graph | InformationProtectionPolicy.Read.All |
55
+
56
+ </TabItem>
57
+ </Tabs>
58
+
41
59
  ## Examples
42
60
 
43
61
  Get a list of sensitivity labels.
@@ -38,6 +38,24 @@ When operating in app-only mode, you have the option to use either the `userName
38
38
 
39
39
  :::
40
40
 
41
+ ## Permissions
42
+ <Tabs>
43
+ <TabItem value="Delegated">
44
+
45
+ | Resource | Permissions |
46
+ |-----------------|----------------------------------|
47
+ | Microsoft Graph | InformationProtectionPolicy.Read |
48
+
49
+ </TabItem>
50
+ <TabItem value="Application">
51
+
52
+ | Resource | Permissions |
53
+ |-----------------|--------------------------------------|
54
+ | Microsoft Graph | InformationProtectionPolicy.Read.All |
55
+
56
+ </TabItem>
57
+ </Tabs>
58
+
41
59
  ## Examples
42
60
 
43
61
  Get a list of policy settings for a sensitivity label.
@@ -33,6 +33,18 @@ m365 purview threatassessment add [options]
33
33
 
34
34
  <Global />
35
35
 
36
+ ## Permissions
37
+
38
+ <Tabs>
39
+ <TabItem value="Delegated">
40
+
41
+ | Resource | Permissions |
42
+ |-----------------|--------------------------------|
43
+ | Microsoft Graph | ThreatAssessment.ReadWrite.All |
44
+
45
+ </TabItem>
46
+ </Tabs>
47
+
36
48
  ## Remarks
37
49
 
38
50
  :::info
@@ -24,6 +24,25 @@ m365 purview threatassessment get [options]
24
24
 
25
25
  <Global />
26
26
 
27
+ ## Permissions
28
+
29
+ <Tabs>
30
+ <TabItem value="Delegated">
31
+
32
+ | Resource | Permissions |
33
+ |-----------------|--------------------------------|
34
+ | Microsoft Graph | ThreatAssessment.ReadWrite.All |
35
+
36
+ </TabItem>
37
+ <TabItem value="Application">
38
+
39
+ | Resource | Permissions |
40
+ |-----------------|--------------------------------|
41
+ | Microsoft Graph | ThreatAssessment.Read.All |
42
+
43
+ </TabItem>
44
+ </Tabs>
45
+
27
46
  ## Examples
28
47
 
29
48
  Get a threat assessment.
@@ -21,6 +21,25 @@ m365 purview threatassessment list [options]
21
21
 
22
22
  <Global />
23
23
 
24
+ ## Permissions
25
+
26
+ <Tabs>
27
+ <TabItem value="Delegated">
28
+
29
+ | Resource | Permissions |
30
+ |-----------------|--------------------------------|
31
+ | Microsoft Graph | ThreatAssessment.ReadWrite.All |
32
+
33
+ </TabItem>
34
+ <TabItem value="Application">
35
+
36
+ | Resource | Permissions |
37
+ |-----------------|--------------------------------|
38
+ | Microsoft Graph | ThreatAssessment.Read.All |
39
+
40
+ </TabItem>
41
+ </Tabs>
42
+
24
43
  ## Examples
25
44
 
26
45
  Get a list of threat assessments
@@ -0,0 +1,187 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # spo site alert list
6
+
7
+ Lists all SharePoint list alerts
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 spo site alert list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-u, --webUrl <webUrl>`
19
+ : The URL of the SharePoint site.
20
+
21
+ `--listId [listId]`
22
+ : The ID of the SharePoint list. Specify either `listId`, `listUrl`, or `listTitle`, but not more than one.
23
+
24
+ `--listUrl [listUrl]`
25
+ : The URL of the SharePoint list. Specify either `listId`, `listUrl`, or `listTitle`, but not more than one.
26
+
27
+ `--listTitle [listTitle]`
28
+ : The title of the SharePoint list. Specify either `listId`, `listUrl`, or `listTitle`, but not more than one.
29
+
30
+ `--userName [userName]`
31
+ : The user name to filter alerts for. Specify either `userName` or `userId`, but not both.
32
+
33
+ `--userId [userId]`
34
+ : The user ID to filter alerts for. Specify either `userName` or `userId`, but not both.
35
+ ```
36
+
37
+ <Global />
38
+
39
+ ## Permissions
40
+
41
+ <Tabs>
42
+ <TabItem value="Delegated">
43
+
44
+ | Resource | Permissions |
45
+ |------------|----------------------|
46
+ | SharePoint | AllSites.FullControl |
47
+
48
+ </TabItem>
49
+ <TabItem value="Application">
50
+
51
+ | Resource | Permissions |
52
+ |------------|-----------------------|
53
+ | SharePoint | Sites.FullControl.All |
54
+
55
+ </TabItem>
56
+ </Tabs>
57
+
58
+ ## Examples
59
+
60
+ List all alerts for a SharePoint site:
61
+
62
+ ```sh
63
+ m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing
64
+ ```
65
+
66
+ List alerts for a SharePoint list by listUrl:
67
+
68
+ ```sh
69
+ m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing --listUrl /sites/Marketing/lists/Tasks
70
+ ```
71
+
72
+ List alerts for a specific user by userId:
73
+
74
+ ```sh
75
+ m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing --userId 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e
76
+ ```
77
+
78
+ List alerts for a specific list by title and user by username:
79
+
80
+ ```sh
81
+ m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing --listTitle "Tasks" --userName jane.doe@contoso.com
82
+ ```
83
+
84
+ ## Response
85
+
86
+ <Tabs>
87
+ <TabItem value="JSON">
88
+
89
+ ```json
90
+ [
91
+ {
92
+ "AlertFrequency": 0,
93
+ "AlertTemplateName": "SPAlertTemplateType.DocumentLibrary",
94
+ "AlertType": 1,
95
+ "AlwaysNotify": false,
96
+ "DeliveryChannels": 1,
97
+ "EventType": -1,
98
+ "Filter": "",
99
+ "ID": "c52b4bf0-add0-4323-b670-f765bb46337b",
100
+ "Properties": [
101
+ {
102
+ "Key": "dispformurl",
103
+ "Value": "Shared Documents/Forms/DispForm.aspx",
104
+ "ValueType": "Edm.String"
105
+ }
106
+ ],
107
+ "Status": 0,
108
+ "Title": "Documents: ProjectPlan.docx",
109
+ "UserId": 9,
110
+ "Item": {
111
+ "Id": 37326,
112
+ "FileRef": "/sites/marketing/Shared Documents/ProjectPlan.docx",
113
+ "GUID": "ef5cc60b-71c0-4357-a291-14274234efde"
114
+ },
115
+ "List": {
116
+ "Id": "6b4f195c-02da-47f4-8237-065b96258cf3",
117
+ "Title": "Documents",
118
+ "RootFolder": {
119
+ "ServerRelativeUrl": "/sites/marketing/Shared Documents"
120
+ }
121
+ },
122
+ "User": {
123
+ "Id": 9,
124
+ "IsHiddenInUI": false,
125
+ "LoginName": "i:0#.f|membership|jane.doe@contoso.onmicrosoft.com",
126
+ "Title": "Jane Doe",
127
+ "PrincipalType": 1,
128
+ "Email": "jane.doe@contoso.onmicrosoft.com",
129
+ "Expiration": "",
130
+ "IsEmailAuthenticationGuestUser": false,
131
+ "IsShareByEmailGuestUser": false,
132
+ "IsSiteAdmin": false,
133
+ "UserId": {
134
+ "NameId": "10037ffeaed549a5",
135
+ "NameIdIssuer": "urn:federation:microsoftonline"
136
+ },
137
+ "UserPrincipalName": "jane.doe@contoso.onmicrosoft.com"
138
+ }
139
+ }
140
+ ]
141
+ ```
142
+
143
+ </TabItem>
144
+ <TabItem value="Text">
145
+
146
+ ```txt
147
+ ID Title UserPrincipalName
148
+ ------------------------------------ --------------------------- --------------------
149
+ fa5115ee-0c72-4d17-9fda-ee2451ba1c6d Documents: ProjectPlan.docx jane.doe@contoso.com
150
+ ```
151
+
152
+ </TabItem>
153
+ <TabItem value="CSV">
154
+
155
+ ```csv
156
+ AlertFrequency,AlertTemplateName,AlertType,AlwaysNotify,DeliveryChannels,EventType,Filter,ID,Status,Title,UserId,UserPrincipalName
157
+ 0,SPAlertTemplateType.DocumentLibrary,1,0,1,-1,,fa5115ee-0c72-4d17-9fda-ee2451ba1c6d,0,Documents: ProjectPlan.docx,6,jane.doe@contoso.com
158
+ ```
159
+
160
+ </TabItem>
161
+ <TabItem value="Markdown">
162
+
163
+ ```md
164
+ # spo site alert list --webUrl "https://contoso.sharepoint.com/sites/marketing" --listUrl "/sites/marketing/Shared Documents"
165
+
166
+ Date: 10/6/2025
167
+
168
+ ## Documents: ProjectPlan.docx (c52b4bf0-add0-4323-b670-f765bb46337b)
169
+
170
+ Property | Value
171
+ ---------|-------
172
+ AlertFrequency | 0
173
+ AlertTemplateName | SPAlertTemplateType.DocumentLibrary
174
+ AlertType | 1
175
+ AlwaysNotify | false
176
+ DeliveryChannels | 1
177
+ EventType | -1
178
+ Filter |
179
+ ID | c52b4bf0-add0-4323-b670-f765bb46337b
180
+ Status | 0
181
+ Title | Documents: ProjectPlan.docx
182
+ UserId | 9
183
+ UserPrincipalName | jane.doe@contoso.com
184
+ ```
185
+
186
+ </TabItem>
187
+ </Tabs>
@@ -0,0 +1,65 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # spo site alert remove
6
+
7
+ Removes an alert from a SharePoint list
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 spo site alert remove [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-u, --webUrl <webUrl>`
19
+ : The URL of the SharePoint site.
20
+
21
+ `--id <id>`
22
+ : The ID of the alert.
23
+
24
+ `-f, --force`
25
+ : Don't prompt for confirmation.
26
+ ```
27
+
28
+ <Global />
29
+
30
+ ## Permissions
31
+
32
+ <Tabs>
33
+ <TabItem value="Delegated">
34
+
35
+ | Resource | Permissions |
36
+ |------------|----------------------|
37
+ | SharePoint | AllSites.FullControl |
38
+
39
+ </TabItem>
40
+ <TabItem value="Application">
41
+
42
+ | Resource | Permissions |
43
+ |------------|-----------------------|
44
+ | SharePoint | Sites.FullControl.All |
45
+
46
+ </TabItem>
47
+ </Tabs>
48
+
49
+ ## Examples
50
+
51
+ Remove an alert by ID
52
+
53
+ ```sh
54
+ m365 spo site alert remove --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e
55
+ ```
56
+
57
+ Remove another alert without confirmation
58
+
59
+ ```sh
60
+ m365 spo site alert remove --webUrl https://contoso.sharepoint.com/sites/Marketing --id 2b6f1c8a-3e6a-4c7e-b8c0-7bf4c8e6d7f1 --force
61
+ ```
62
+
63
+ ## Response
64
+
65
+ The command won't return a response on success.
@@ -42,7 +42,7 @@ function capitalizeWord(word, capitalized) {
42
42
  return word.substr(0, 1).toUpperCase() + word.substr(1).toLowerCase();
43
43
  }
44
44
 
45
- function breakWords(longWord, dictionary) {
45
+ function breakWords(longWord, dictionary) {
46
46
  const words = [];
47
47
  for (let i = 0; i < dictionary.length; i++) {
48
48
  if (longWord.indexOf(dictionary[i]) === 0) {
@@ -72,7 +72,23 @@ module.exports = {
72
72
  fixable: 'code',
73
73
  messages: {
74
74
  invalidName: "'{{ actualClassName }}' is not a valid command class name. Expected '{{ expectedClassName }}'"
75
- }
75
+ },
76
+ schema: [
77
+ {
78
+ type: 'array',
79
+ items: { type: 'string' },
80
+ uniqueItems: true,
81
+ title: 'dictionary',
82
+ description: 'List of known word parts used to break long command names into words.'
83
+ },
84
+ {
85
+ type: 'array',
86
+ items: { type: 'string' },
87
+ uniqueItems: true,
88
+ title: 'capitalized',
89
+ description: 'List of known word parts that should be capitalized.'
90
+ }
91
+ ]
76
92
  },
77
93
  create: context => {
78
94
  return {