@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.289ab69

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 (225) hide show
  1. package/.eslintrc.js +2 -0
  2. package/README.md +6 -1
  3. package/dist/Command.js +6 -0
  4. package/dist/chili/chili.js +298 -0
  5. package/dist/chili/index.js +20 -0
  6. package/dist/cli/Cli.js +2 -2
  7. package/dist/m365/aad/commands/user/user-add.js +30 -21
  8. package/dist/m365/app/commands/permission/permission-add.js +279 -0
  9. package/dist/m365/app/commands.js +1 -0
  10. package/dist/m365/commands/commands.js +2 -0
  11. package/dist/m365/commands/docs.js +42 -0
  12. package/dist/m365/commands/login.js +1 -1
  13. package/dist/m365/commands/setup.js +180 -0
  14. package/dist/m365/commands/setupPresets.js +25 -0
  15. package/dist/m365/pa/commands/app/app-consent-set.js +101 -0
  16. package/dist/m365/pa/commands.js +1 -0
  17. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-get.js +97 -0
  18. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-list.js +85 -0
  19. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-policysettings-list.js +89 -0
  20. package/dist/m365/purview/commands.js +3 -0
  21. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.17.2.js +25 -0
  22. package/dist/m365/spfx/commands/project/project-doctor/rules/FN001035_DEP_fluentui_react.js +18 -0
  23. package/dist/m365/spfx/commands/project/project-doctor/rules/FN021009_PKG_no_duplicate_oui_deps.js +11 -4
  24. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  25. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN001035_DEP_fluentui_react.js +18 -0
  26. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +2 -0
  27. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.17.2.js +61 -0
  28. package/dist/m365/spfx/commands/project/project-upgrade.js +2 -1
  29. package/dist/m365/spfx/commands/spfx-doctor.js +29 -30
  30. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-remove.js +146 -0
  31. package/dist/m365/spo/commands/file/file-list.js +15 -4
  32. package/dist/m365/spo/commands/file/file-remove.js +3 -0
  33. package/dist/m365/spo/commands/list/list-get.js +30 -3
  34. package/dist/m365/spo/commands/list/list-list.js +39 -2
  35. package/dist/m365/spo/commands/listitem/listitem-batch-set.js +308 -0
  36. package/dist/m365/spo/commands/page/page-section-add.js +2 -3
  37. package/dist/m365/spo/commands/site/site-recyclebinitem-move.js +119 -0
  38. package/dist/m365/spo/commands/site/site-recyclebinitem-remove.js +106 -0
  39. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +30 -39
  40. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-list.js +47 -0
  41. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-remove.js +151 -0
  42. package/dist/m365/spo/commands/tenant/tenant-commandset-remove.js +152 -0
  43. package/dist/m365/spo/commands/tenant/tenant-commandset-set.js +203 -0
  44. package/dist/m365/spo/commands/term/term-add.js +13 -4
  45. package/dist/m365/spo/commands/term/term-get.js +14 -5
  46. package/dist/m365/spo/commands/term/term-group-get.js +12 -3
  47. package/dist/m365/spo/commands/term/term-group-list.js +39 -4
  48. package/dist/m365/spo/commands/term/term-list.js +18 -9
  49. package/dist/m365/spo/commands/term/term-set-add.js +13 -4
  50. package/dist/m365/spo/commands/term/term-set-get.js +12 -3
  51. package/dist/m365/spo/commands/term/term-set-list.js +12 -3
  52. package/dist/m365/spo/commands.js +9 -0
  53. package/dist/m365/teams/commands/chat/chat-member-remove.js +137 -0
  54. package/dist/m365/teams/commands.js +1 -0
  55. package/dist/utils/formatting.js +35 -11
  56. package/dist/utils/pid.js +5 -0
  57. package/docs/docs/cmd/aad/o365group/o365group-get.md +0 -12
  58. package/docs/docs/cmd/aad/user/user-add.md +4 -0
  59. package/docs/docs/cmd/aad/user/user-set.md +2 -2
  60. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +13 -13
  61. package/docs/docs/cmd/app/app-get.md +25 -6
  62. package/docs/docs/cmd/app/app-open.md +8 -2
  63. package/docs/docs/cmd/app/permission/permission-add.md +53 -0
  64. package/docs/docs/cmd/app/permission/permission-list.md +19 -19
  65. package/docs/docs/cmd/booking/business/business-get.md +30 -8
  66. package/docs/docs/cmd/booking/business/business-list.md +17 -8
  67. package/docs/docs/cmd/cli/cli-consent.md +6 -0
  68. package/docs/docs/cmd/cli/cli-doctor.md +17 -0
  69. package/docs/docs/cmd/cli/cli-issue.md +6 -0
  70. package/docs/docs/cmd/cli/cli-reconsent.md +6 -0
  71. package/docs/docs/cmd/cli/completion/completion-sh-setup.md +6 -0
  72. package/docs/docs/cmd/cli/config/config-get.md +6 -0
  73. package/docs/docs/cmd/docs.md +51 -0
  74. package/docs/docs/cmd/flow/environment/environment-list.md +18 -0
  75. package/docs/docs/cmd/flow/flow-get.md +20 -0
  76. package/docs/docs/cmd/flow/flow-list.md +17 -0
  77. package/docs/docs/cmd/graph/changelog/changelog-list.md +52 -0
  78. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +61 -0
  79. package/docs/docs/cmd/graph/schemaextension/schemaextension-get.md +61 -0
  80. package/docs/docs/cmd/graph/schemaextension/schemaextension-list.md +61 -0
  81. package/docs/docs/cmd/graph/schemaextension/schemaextension-remove.md +4 -0
  82. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -0
  83. package/docs/docs/cmd/graph/subscription/subscription-add.md +73 -0
  84. package/docs/docs/cmd/login.md +1 -1
  85. package/docs/docs/cmd/onedrive/onedrive-list.md +225 -0
  86. package/docs/docs/cmd/onedrive/report/report-activityfilecounts.md +39 -0
  87. package/docs/docs/cmd/onedrive/report/report-activityusercounts.md +39 -0
  88. package/docs/docs/cmd/onedrive/report/report-activityuserdetail.md +43 -0
  89. package/docs/docs/cmd/onedrive/report/report-usageaccountcounts.md +38 -0
  90. package/docs/docs/cmd/onedrive/report/report-usageaccountdetail.md +43 -0
  91. package/docs/docs/cmd/onedrive/report/report-usagefilecounts.md +38 -0
  92. package/docs/docs/cmd/onedrive/report/report-usagestorage.md +37 -0
  93. package/docs/docs/cmd/onenote/notebook/notebook-list.md +79 -0
  94. package/docs/docs/cmd/pa/app/app-consent-set.md +47 -0
  95. package/docs/docs/cmd/planner/plan/plan-get.md +1 -1
  96. package/docs/docs/cmd/planner/plan/plan-list.md +1 -1
  97. package/docs/docs/cmd/planner/roster/roster-add.md +2 -1
  98. package/docs/docs/cmd/planner/roster/roster-get.md +1 -1
  99. package/docs/docs/cmd/planner/roster/roster-remove.md +2 -1
  100. package/docs/docs/cmd/planner/task/task-get.md +0 -6
  101. package/docs/docs/cmd/planner/task/task-set.md +1 -1
  102. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +6 -7
  103. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +6 -7
  104. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +4 -4
  105. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +4 -4
  106. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +10 -10
  107. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +11 -11
  108. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +10 -10
  109. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +10 -10
  110. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +10 -10
  111. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -12
  112. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +8 -9
  113. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +8 -9
  114. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +8 -8
  115. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +8 -8
  116. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.md +118 -0
  117. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.md +111 -0
  118. package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.md +97 -0
  119. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +17 -0
  120. package/docs/docs/cmd/search/externalconnection/externalconnection-list.md +17 -0
  121. package/docs/docs/cmd/setup.md +86 -0
  122. package/docs/docs/cmd/spfx/project/project-doctor.md +1 -1
  123. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  124. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +1 -1
  125. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.md +77 -0
  126. package/docs/docs/cmd/spo/commandset/commandset-set.md +1 -1
  127. package/docs/docs/cmd/spo/contenttype/contenttype-set.md +2 -2
  128. package/docs/docs/cmd/spo/customaction/customaction-add.md +1 -1
  129. package/docs/docs/cmd/spo/customaction/customaction-set.md +1 -1
  130. package/docs/docs/cmd/spo/file/file-list.md +9 -6
  131. package/docs/docs/cmd/spo/file/file-remove.md +12 -0
  132. package/docs/docs/cmd/spo/folder/folder-copy.md +1 -1
  133. package/docs/docs/cmd/spo/list/list-get.md +10 -0
  134. package/docs/docs/cmd/spo/list/list-list.md +28 -0
  135. package/docs/docs/cmd/spo/listitem/listitem-batch-set.md +67 -0
  136. package/docs/docs/cmd/spo/listitem/listitem-list.md +1 -1
  137. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +19 -0
  138. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +12 -0
  139. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +6 -0
  140. package/docs/docs/cmd/spo/page/page-column-get.md +15 -0
  141. package/docs/docs/cmd/spo/page/page-column-list.md +16 -0
  142. package/docs/docs/cmd/spo/page/page-control-get.md +18 -0
  143. package/docs/docs/cmd/spo/page/page-control-list.md +18 -0
  144. package/docs/docs/cmd/spo/page/page-copy.md +35 -0
  145. package/docs/docs/cmd/spo/page/page-get.md +39 -0
  146. package/docs/docs/cmd/spo/page/page-list.md +53 -0
  147. package/docs/docs/cmd/spo/page/page-section-get.md +12 -0
  148. package/docs/docs/cmd/spo/page/page-section-list.md +13 -0
  149. package/docs/docs/cmd/spo/page/page-template-list.md +31 -0
  150. package/docs/docs/cmd/spo/propertybag/propertybag-get.md +6 -0
  151. package/docs/docs/cmd/spo/propertybag/propertybag-list.md +13 -0
  152. package/docs/docs/cmd/spo/report/report-activityfilecounts.md +7 -0
  153. package/docs/docs/cmd/spo/report/report-activitypages.md +7 -0
  154. package/docs/docs/cmd/spo/report/report-activityusercounts.md +7 -0
  155. package/docs/docs/cmd/spo/report/report-activityuserdetail.md +7 -0
  156. package/docs/docs/cmd/spo/report/report-siteusagedetail.md +7 -0
  157. package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +7 -0
  158. package/docs/docs/cmd/spo/report/report-siteusagepages.md +7 -0
  159. package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +7 -0
  160. package/docs/docs/cmd/spo/report/report-siteusagestorage.md +7 -0
  161. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +20 -0
  162. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +20 -0
  163. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +20 -0
  164. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +18 -0
  165. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +20 -0
  166. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +17 -0
  167. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +13 -0
  168. package/docs/docs/cmd/spo/site/site-recyclebinitem-move.md +43 -0
  169. package/docs/docs/cmd/spo/site/site-recyclebinitem-remove.md +45 -0
  170. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +1 -1
  171. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.md +103 -0
  172. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.md +49 -0
  173. package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.md +49 -0
  174. package/docs/docs/cmd/spo/tenant/tenant-commandset-set.md +57 -0
  175. package/docs/docs/cmd/spo/term/term-add.md +107 -6
  176. package/docs/docs/cmd/spo/term/term-get.md +111 -10
  177. package/docs/docs/cmd/spo/term/term-group-get.md +71 -5
  178. package/docs/docs/cmd/spo/term/term-group-list.md +70 -2
  179. package/docs/docs/cmd/spo/term/term-list.md +80 -8
  180. package/docs/docs/cmd/spo/term/term-set-add.md +95 -11
  181. package/docs/docs/cmd/spo/term/term-set-get.md +92 -8
  182. package/docs/docs/cmd/spo/term/term-set-list.md +85 -5
  183. package/docs/docs/cmd/teams/app/app-list.md +17 -0
  184. package/docs/docs/cmd/teams/app/app-publish.md +18 -1
  185. package/docs/docs/cmd/teams/channel/channel-add.md +20 -0
  186. package/docs/docs/cmd/teams/channel/channel-get.md +21 -0
  187. package/docs/docs/cmd/teams/channel/channel-list.md +21 -0
  188. package/docs/docs/cmd/teams/channel/channel-member-list.md +20 -0
  189. package/docs/docs/cmd/teams/channel/channel-member-set.md +21 -0
  190. package/docs/docs/cmd/teams/chat/chat-get.md +22 -0
  191. package/docs/docs/cmd/teams/chat/chat-list.md +22 -0
  192. package/docs/docs/cmd/teams/chat/chat-member-list.md +20 -0
  193. package/docs/docs/cmd/teams/chat/chat-member-remove.md +52 -0
  194. package/docs/docs/cmd/teams/chat/chat-message-list.md +23 -0
  195. package/docs/docs/cmd/teams/funsettings/funsettings-list.md +15 -0
  196. package/docs/docs/cmd/teams/guestsettings/guestsettings-list.md +13 -0
  197. package/docs/docs/cmd/teams/membersettings/membersettings-list.md +17 -0
  198. package/docs/docs/cmd/teams/tab/tab-remove.md +1 -1
  199. package/docs/docs/cmd/todo/list/list-add.md +18 -0
  200. package/docs/docs/cmd/todo/list/list-get.md +18 -0
  201. package/docs/docs/cmd/todo/list/list-list.md +18 -0
  202. package/docs/docs/cmd/todo/task/task-get.md +21 -0
  203. package/docs/docs/cmd/todo/task/task-list.md +21 -0
  204. package/docs/docs/cmd/util/accesstoken/accesstoken-get.md +6 -0
  205. package/docs/docs/cmd/version.md +1 -1
  206. package/docs/docs/cmd/viva/connections/connections-app-create.md +3 -3
  207. package/docs/docs/cmd/yammer/group/group-list.md +42 -0
  208. package/docs/docs/cmd/yammer/message/message-add.md +32 -0
  209. package/docs/docs/cmd/yammer/message/message-get.md +32 -0
  210. package/docs/docs/cmd/yammer/message/message-list.md +34 -0
  211. package/docs/docs/cmd/yammer/network/network-list.md +70 -0
  212. package/docs/docs/cmd/yammer/report/report-activitycounts.md +7 -0
  213. package/docs/docs/cmd/yammer/report/report-activityusercounts.md +7 -0
  214. package/docs/docs/cmd/yammer/report/report-activityuserdetail.md +7 -0
  215. package/docs/docs/cmd/yammer/report/report-deviceusagedistributionusercounts.md +7 -0
  216. package/docs/docs/cmd/yammer/report/report-deviceusageusercounts.md +7 -0
  217. package/docs/docs/cmd/yammer/report/report-deviceusageuserdetail.md +7 -0
  218. package/docs/docs/cmd/yammer/report/report-groupsactivitycounts.md +7 -0
  219. package/docs/docs/cmd/yammer/report/report-groupsactivitydetail.md +7 -0
  220. package/docs/docs/cmd/yammer/report/report-groupsactivitygroupcounts.md +7 -0
  221. package/docs/docs/cmd/yammer/user/user-get.md +55 -0
  222. package/docs/docs/cmd/yammer/user/user-list.md +55 -0
  223. package/docs/docs/cmd/yammer/yammer-search.md +15 -3
  224. package/npm-shrinkwrap.json +3 -2
  225. package/package.json +2 -1
@@ -24,7 +24,7 @@ m365 planner plan list [options]
24
24
  ## Remarks
25
25
 
26
26
  !!! attention
27
- When using rosterId, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
27
+ When using rosterId, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
28
28
 
29
29
  ## Examples
30
30
 
@@ -71,5 +71,6 @@ m365 planner roster add
71
71
  assignedSensitivityLabel | null
72
72
  ```
73
73
 
74
- ## Additional information
74
+ ## More information
75
+
75
76
  Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
@@ -68,6 +68,6 @@ m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd
68
68
  assignedSensitivityLabel | null
69
69
  ```
70
70
 
71
- ## Additional information
71
+ ## More information
72
72
 
73
73
  Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
@@ -44,5 +44,6 @@ m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd --confirm
44
44
 
45
45
  The command won't return a response on success.
46
46
 
47
- ## Additional information
47
+ ## More information
48
+
48
49
  Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
@@ -8,12 +8,6 @@ Retrieve the specified planner task
8
8
  m365 planner task get [options]
9
9
  ```
10
10
 
11
- ## Alias
12
-
13
- ```sh
14
- m365 planner task details get [options]
15
- ```
16
-
17
11
  ## Options
18
12
 
19
13
  `-i, --id [id]`
@@ -335,7 +335,7 @@ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50
335
335
  checklist | {}
336
336
  ```
337
337
 
338
- ## Additional information
338
+ ## More information
339
339
 
340
340
  - Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
341
341
  - Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)
@@ -49,13 +49,6 @@ Create a retention event to start retention at the end of 2022 for all employee
49
49
  m365 purview retentionevent add --displayName 'Employee information expiration' --description 'Employee documents expired due to offboarding' --eventTypeName 'CustomRetentionTime' --triggerDateTime '2022-12-31' --assetIds 'ComplianceAssetId:EmployeeNr1234'
50
50
  ```
51
51
 
52
- ## More information
53
-
54
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
55
-
56
- [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
57
-
58
-
59
52
  ## Response
60
53
 
61
54
  === "JSON"
@@ -147,3 +140,9 @@ This command is part of a series of commands that have to do with event-based re
147
140
  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
148
141
  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
149
142
  ```
143
+
144
+ ## More information
145
+
146
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
147
+
148
+ [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
@@ -31,13 +31,6 @@ m365 purview retentionevent get --id c37d695e-d581-4ae9-82a0-9364eba4291e
31
31
  !!! attention
32
32
  This command currently only supports delegated permissions.
33
33
 
34
- ## More information
35
-
36
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
37
-
38
- [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
39
-
40
-
41
34
  ## Response
42
35
 
43
36
  === "JSON"
@@ -130,3 +123,9 @@ This command is part of a series of commands that have to do with event-based re
130
123
  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
131
124
  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
132
125
  ```
126
+
127
+ ## More information
128
+
129
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
130
+
131
+ [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
@@ -28,10 +28,6 @@ m365 purview retentionevent list
28
28
  !!! attention
29
29
  This command currently only supports delegated permissions.
30
30
 
31
- ## More information
32
-
33
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
34
-
35
31
  ## Response
36
32
 
37
33
 
@@ -105,3 +101,7 @@ This command is part of a series of commands that have to do with event-based re
105
101
  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
106
102
  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
107
103
  ```
104
+
105
+ ## More information
106
+
107
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
@@ -34,12 +34,12 @@ m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
34
34
  !!! attention
35
35
  This command currently only supports delegated permissions.
36
36
 
37
+ ## Response
38
+
39
+ The command won't return a response on success.
40
+
37
41
  ## More information
38
42
 
39
43
  This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
40
44
 
41
45
  [Read more on event-based retention here](https://learn.microsoft.com/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
42
-
43
- ## Response
44
-
45
- The command won't return a response on success.
@@ -18,14 +18,6 @@ m365 purview retentioneventtype add [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
- ## Examples
22
-
23
- Create a retention event type *Contract Expiry*.
24
-
25
- ```sh
26
- m365 purview retentioneventtype add --displayName 'Contract Expiry' --description 'A retention event type to start a retention period based on the date that a contract expired.'
27
- ```
28
-
29
21
  ## Remarks
30
22
 
31
23
  !!! attention
@@ -34,9 +26,13 @@ m365 purview retentioneventtype add --displayName 'Contract Expiry' --descriptio
34
26
  !!! attention
35
27
  This command currently only supports delegated permissions.
36
28
 
37
- ## More information
29
+ ## Examples
38
30
 
39
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
31
+ Create a retention event type *Contract Expiry*.
32
+
33
+ ```sh
34
+ m365 purview retentioneventtype add --displayName 'Contract Expiry' --description 'A retention event type to start a retention period based on the date that a contract expired.'
35
+ ```
40
36
 
41
37
  ## Response
42
38
 
@@ -104,3 +100,7 @@ This command is part of a series of commands that have to do with event-based re
104
100
  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
105
101
  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
106
102
  ```
103
+
104
+ ## More information
105
+
106
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
@@ -15,14 +15,6 @@ m365 purview retentioneventtype get [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- ## Examples
19
-
20
- Get a retention event type by id
21
-
22
- ```sh
23
- m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
24
- ```
25
-
26
18
  ## Remarks
27
19
 
28
20
  !!! attention
@@ -31,11 +23,13 @@ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
31
23
  !!! attention
32
24
  This command currently only supports delegated permissions.
33
25
 
34
- ## More information
26
+ ## Examples
35
27
 
36
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
28
+ Get a retention event type by id
37
29
 
38
- [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
30
+ ```sh
31
+ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
32
+ ```
39
33
 
40
34
  ## Response
41
35
 
@@ -101,3 +95,9 @@ This command is part of a series of commands that have to do with event-based re
101
95
  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
102
96
  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
103
97
  ```
98
+
99
+ ## More information
100
+
101
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
102
+
103
+ [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
@@ -12,14 +12,6 @@ m365 purview retentioneventtype list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
- ## Examples
16
-
17
- Get a list of retention event types
18
-
19
- ```sh
20
- m365 purview retentioneventtype list
21
- ```
22
-
23
15
  ## Remarks
24
16
 
25
17
  !!! attention
@@ -28,9 +20,13 @@ m365 purview retentioneventtype list
28
20
  !!! attention
29
21
  This command currently only supports delegated permissions.
30
22
 
31
- ## More information
23
+ ## Examples
32
24
 
33
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
25
+ Get a list of retention event types
26
+
27
+ ```sh
28
+ m365 purview retentioneventtype list
29
+ ```
34
30
 
35
31
  ## Response
36
32
 
@@ -95,3 +91,7 @@ This command is part of a series of commands that have to do with event-based re
95
91
  createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
96
92
  lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
97
93
  ```
94
+
95
+ ## More information
96
+
97
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
@@ -18,14 +18,6 @@ m365 purview retentioneventtype remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
- ## Examples
22
-
23
- Delete a retention event type by id
24
-
25
- ```sh
26
- m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
27
- ```
28
-
29
21
  ## Remarks
30
22
 
31
23
  !!! attention
@@ -34,10 +26,18 @@ m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
34
26
  !!! attention
35
27
  This command currently only supports delegated permissions.
36
28
 
37
- ## More information
29
+ ## Examples
38
30
 
39
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
31
+ Delete a retention event type by id
32
+
33
+ ```sh
34
+ m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
35
+ ```
40
36
 
41
37
  ## Response
42
38
 
43
39
  The command won't return a response on success.
40
+
41
+ ## More information
42
+
43
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
@@ -18,14 +18,6 @@ m365 purview retentioneventtype set [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
- ## Examples
22
-
23
- Update the description of a retention event type
24
-
25
- ```sh
26
- m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
27
- ```
28
-
29
21
  ## Remarks
30
22
 
31
23
  !!! attention
@@ -34,10 +26,18 @@ m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --
34
26
  !!! attention
35
27
  This command currently only supports delegated permissions.
36
28
 
37
- ## More information
29
+ ## Examples
38
30
 
39
- This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
31
+ Update the description of a retention event type
32
+
33
+ ```sh
34
+ m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
35
+ ```
40
36
 
41
37
  ## Response
42
38
 
43
39
  The command won't return a response on success.
40
+
41
+ ## More information
42
+
43
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
@@ -45,6 +45,14 @@ m365 purview retentionlabel add [options]
45
45
 
46
46
  --8<-- "docs/cmd/_global.md"
47
47
 
48
+ ## Remarks
49
+
50
+ !!! attention
51
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
52
+
53
+ !!! attention
54
+ This command currently only supports delegated permissions.
55
+
48
56
  ## Examples
49
57
 
50
58
  Create a retention label that retains documents and deletes them after one year.
@@ -65,18 +73,6 @@ Create an event-based retention label that retains documents as records and dele
65
73
  m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365 --retentionTrigger dateOfEvent --eventTypeName "Contract Expiry"
66
74
  ```
67
75
 
68
- ## Remarks
69
-
70
- !!! attention
71
- This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
72
-
73
- !!! attention
74
- This command currently only supports delegated permissions.
75
-
76
- ## More information
77
-
78
- - Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
79
-
80
76
  ## Response
81
77
 
82
78
  === "JSON"
@@ -141,3 +137,7 @@ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringReten
141
137
  displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
142
138
  some label,Description for admins,Description for users,,dateLabeled,retain,delete,2022-12-21T09:33:32Z,2022-12-21T09:33:32Z,another label,startLocked,cfc8b132-7aef-45f4-9fcf-3c199090ba2a,"{""days"":365}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
143
139
  ```
140
+
141
+ ## More information
142
+
143
+ - Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
@@ -15,14 +15,6 @@ m365 purview retentionlabel get [options]
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
18
- ## Examples
19
-
20
- Get a retention label
21
-
22
- ```sh
23
- m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
24
- ```
25
-
26
18
  ## Remarks
27
19
 
28
20
  !!! attention
@@ -31,8 +23,15 @@ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
31
23
  !!! attention
32
24
  This command currently only supports delegated permissions.
33
25
 
34
- ## Response
26
+ ## Examples
27
+
28
+ Get a retention label
29
+
30
+ ```sh
31
+ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
32
+ ```
35
33
 
34
+ ## Response
36
35
 
37
36
  === "JSON"
38
37
 
@@ -12,14 +12,6 @@ m365 purview retentionlabel list [options]
12
12
 
13
13
  --8<-- "docs/cmd/_global.md"
14
14
 
15
- ## Examples
16
-
17
- Get a list of retention labels
18
-
19
- ```sh
20
- m365 purview retentionlabel list
21
- ```
22
-
23
15
  ## Remarks
24
16
 
25
17
  !!! attention
@@ -28,8 +20,15 @@ m365 purview retentionlabel list
28
20
  !!! attention
29
21
  This command currently only supports delegated permissions.
30
22
 
31
- ## Response
23
+ ## Examples
24
+
25
+ Get a list of retention labels
26
+
27
+ ```sh
28
+ m365 purview retentionlabel list
29
+ ```
32
30
 
31
+ ## Response
33
32
 
34
33
  === "JSON"
35
34
 
@@ -18,14 +18,6 @@ m365 purview retentionlabel remove [options]
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
- ## Examples
22
-
23
- Delete a retention label
24
-
25
- ```sh
26
- m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
27
- ```
28
-
29
21
  ## Remarks
30
22
 
31
23
  !!! attention
@@ -34,6 +26,14 @@ m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
34
26
  !!! attention
35
27
  This command currently only supports delegated permissions.
36
28
 
29
+ ## Examples
30
+
31
+ Delete a retention label
32
+
33
+ ```sh
34
+ m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
35
+ ```
36
+
37
37
  ## Response
38
38
 
39
39
  The command won't return a response on success.
@@ -39,6 +39,14 @@ m365 purview retentionlabel set [options]
39
39
 
40
40
  --8<-- "docs/cmd/_global.md"
41
41
 
42
+ ## Remarks
43
+
44
+ !!! attention
45
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
46
+
47
+ !!! attention
48
+ This command currently only supports delegated permissions.
49
+
42
50
  ## Examples
43
51
 
44
52
  Update a retention label so that it retains documents as records and deletes them after one year.
@@ -53,14 +61,6 @@ Update a retention label so that it retains documents as regulatory records and
53
61
  m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRegulatoryRecord --actionAfterRetentionPeriod startDispositionReview --retentionDuration 365 --retentionTrigger dateModified
54
62
  ```
55
63
 
56
- ## Remarks
57
-
58
- !!! attention
59
- This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
60
-
61
- !!! attention
62
- This command currently only supports delegated permissions.
63
-
64
64
  ## Response
65
65
 
66
66
  The command won't return a response on success.
@@ -0,0 +1,118 @@
1
+ # purview sensitivitylabel get
2
+
3
+ Retrieve the specified sensitivity label
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview sensitivitylabel get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the sensitivity label.
15
+
16
+ `--userId [userId]`
17
+ : User's Azure AD ID. Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
18
+
19
+ `--userName [userName]`
20
+ : User's UPN (user principal name, e.g. johndoe@example.com). Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! attention
27
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
28
+
29
+ !!! attention
30
+ When operating in app-only mode, you have the option to use either the `userName` or `userId` parameters to retrieve the sensitivity policy settings for a specific user. Without specifying either of these parameters, the command will retrieve the sensitivity policy settings for the currently authenticated user when operating in delegated mode.
31
+
32
+
33
+ ## Examples
34
+
35
+ Get a sensitivity label
36
+
37
+ ```sh
38
+ m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e
39
+ ```
40
+
41
+ Get a sensitivity label that a specific user has access to by its Id
42
+
43
+ ```sh
44
+ m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userId 59f80e08-24b1-41f8-8586-16765fd830d3
45
+ ```
46
+
47
+ Get a sensitivity label that a specific user has access to by its UPN
48
+
49
+ ```sh
50
+ m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userName john.doe@contoso.com
51
+ ```
52
+
53
+ ## Response
54
+
55
+ === "JSON"
56
+
57
+ ```json
58
+ {
59
+ "id": "6f4fb2db-ecf4-4279-94ba-23d059bf157e",
60
+ "name": "Unrestricted",
61
+ "description": "",
62
+ "color": "",
63
+ "sensitivity": 0,
64
+ "tooltip": "Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",
65
+ "isActive": true,
66
+ "isAppliable": true,
67
+ "contentFormats": [
68
+ "file",
69
+ "email"
70
+ ],
71
+ "hasProtection": false
72
+ }
73
+ ```
74
+
75
+ === "Text"
76
+
77
+ ```text
78
+ color :
79
+ contentFormats: ["file","email"]
80
+ description :
81
+ hasProtection : false
82
+ id : 6f4fb2db-ecf4-4279-94ba-23d059bf157e
83
+ isActive : true
84
+ isAppliable : true
85
+ name : Unrestricted
86
+ sensitivity : 0
87
+ tooltip : Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
88
+ ```
89
+
90
+ === "CSV"
91
+
92
+ ```csv
93
+ id,name,description,color,sensitivity,tooltip,isActive,isAppliable,contentFormats,hasProtection
94
+ 6f4fb2db-ecf4-4279-94ba-23d059bf157e,Unrestricted,,,0,"Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",1,1,"[""file"",""email""]",
95
+ ```
96
+
97
+ === "Markdown"
98
+
99
+ ```md
100
+ # purview sensitivitylabel get --id "6f4fb2db-ecf4-4279-94ba-23d059bf157e"
101
+
102
+ Date: 3/25/2023
103
+
104
+ ## Unrestricted (6f4fb2db-ecf4-4279-94ba-23d059bf157e)
105
+
106
+ Property | Value
107
+ ---------|-------
108
+ id | 6f4fb2db-ecf4-4279-94ba-23d059bf157e
109
+ name | Unrestricted
110
+ description |
111
+ color |
112
+ sensitivity | 0
113
+ tooltip | Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
114
+ isActive | true
115
+ isAppliable | true
116
+ contentFormats | ["file","email"]
117
+ hasProtection | false
118
+ ```