@pnp/cli-microsoft365 6.3.0-beta.64eb7da → 6.3.0-beta.80fcd21

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 (192) hide show
  1. package/.eslintrc.js +4 -0
  2. package/dist/Command.js +4 -4
  3. package/dist/appInsights.js +2 -1
  4. package/dist/cli/Cli.js +58 -1
  5. package/dist/m365/aad/commands/license/license-list.js +41 -0
  6. package/dist/m365/aad/commands/user/user-add.js +223 -0
  7. package/dist/m365/aad/commands/user/user-license-add.js +88 -0
  8. package/dist/m365/aad/commands/user/user-license-list.js +99 -0
  9. package/dist/m365/aad/commands/user/user-license-remove.js +114 -0
  10. package/dist/m365/aad/commands/user/user-recyclebinitem-clear.js +103 -0
  11. package/dist/m365/aad/commands/user/user-recyclebinitem-list.js +41 -0
  12. package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
  13. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +77 -0
  14. package/dist/m365/aad/commands/user/user-remove.js +107 -0
  15. package/dist/m365/aad/commands.js +10 -0
  16. package/dist/m365/context/commands/option/option-list.js +54 -0
  17. package/dist/m365/context/commands.js +1 -0
  18. package/dist/m365/flow/commands/environment/FlowEnvironmentDetails.js +3 -0
  19. package/dist/m365/flow/commands/environment/environment-get.js +26 -11
  20. package/dist/m365/pa/commands/environment/environment-get.js +13 -5
  21. package/dist/m365/planner/commands/plan/plan-get.js +17 -10
  22. package/dist/m365/planner/commands/plan/plan-set.js +21 -10
  23. package/dist/m365/planner/commands/roster/roster-get.js +61 -0
  24. package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
  25. package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
  26. package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
  27. package/dist/m365/planner/commands/task/task-add.js +3 -0
  28. package/dist/m365/planner/commands.js +4 -0
  29. package/dist/m365/pp/commands/environment/environment-get.js +18 -9
  30. package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +75 -0
  31. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +46 -0
  32. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
  33. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
  34. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +13 -8
  35. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +43 -0
  36. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
  37. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
  38. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
  39. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
  40. package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
  41. package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
  42. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
  43. package/dist/m365/purview/commands.js +8 -1
  44. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
  45. package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
  46. package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
  47. package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
  48. package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
  49. package/dist/m365/spo/commands/file/file-move.js +0 -2
  50. package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
  51. package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
  52. package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
  53. package/dist/m365/spo/commands/file/file-sharinglink-list.js +7 -28
  54. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
  55. package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
  56. package/dist/m365/spo/commands/folder/folder-copy.js +0 -2
  57. package/dist/m365/spo/commands/folder/folder-move.js +0 -2
  58. package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
  59. package/dist/m365/spo/commands/navigation/navigation-node-get.js +73 -0
  60. package/dist/m365/spo/commands/site/site-add.js +0 -3
  61. package/dist/m365/spo/commands/site/site-remove.js +0 -3
  62. package/dist/m365/spo/commands/site/site-set.js +0 -2
  63. package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
  64. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
  65. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js +0 -1
  66. package/dist/m365/spo/commands.js +5 -0
  67. package/dist/m365/teams/commands/team/team-add.js +3 -8
  68. package/dist/utils/aadUser.js +38 -0
  69. package/dist/utils/planner.js +1 -4
  70. package/dist/utils/session.js +18 -0
  71. package/dist/utils/spo.js +92 -12
  72. package/docs/docs/cmd/aad/license/license-list.md +87 -0
  73. package/docs/docs/cmd/aad/user/user-add.md +168 -0
  74. package/docs/docs/cmd/aad/user/user-license-add.md +108 -0
  75. package/docs/docs/cmd/aad/user/user-license-list.md +98 -0
  76. package/docs/docs/cmd/aad/user/user-license-remove.md +43 -0
  77. package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
  78. package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md +82 -0
  79. package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
  80. package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.md +99 -0
  81. package/docs/docs/cmd/aad/user/user-remove.md +51 -0
  82. package/docs/docs/cmd/aad/user/user-set.md +1 -1
  83. package/docs/docs/cmd/context/option/option-list.md +63 -0
  84. package/docs/docs/cmd/flow/environment/environment-get.md +31 -3
  85. package/docs/docs/cmd/login.md +26 -0
  86. package/docs/docs/cmd/logout.md +4 -0
  87. package/docs/docs/cmd/pa/app/app-get.md +24 -0
  88. package/docs/docs/cmd/pa/app/app-list.md +21 -0
  89. package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
  90. package/docs/docs/cmd/pa/environment/environment-get.md +26 -2
  91. package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
  92. package/docs/docs/cmd/planner/plan/plan-get.md +12 -12
  93. package/docs/docs/cmd/planner/plan/plan-set.md +10 -4
  94. package/docs/docs/cmd/planner/roster/roster-get.md +73 -0
  95. package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
  96. package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
  97. package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
  98. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
  99. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
  100. package/docs/docs/cmd/pp/card/card-clone.md +12 -0
  101. package/docs/docs/cmd/pp/card/card-get.md +49 -0
  102. package/docs/docs/cmd/pp/card/card-list.md +49 -0
  103. package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
  104. package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
  105. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
  106. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
  107. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
  108. package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
  109. package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
  110. package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
  111. package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
  112. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
  113. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
  114. package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
  115. package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
  116. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
  117. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
  118. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
  119. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
  120. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
  121. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
  122. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
  123. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +3 -0
  124. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
  125. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
  126. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
  127. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
  128. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
  129. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
  130. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
  131. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
  132. package/docs/docs/cmd/request.md +74 -0
  133. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
  134. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
  135. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  136. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
  137. package/docs/docs/cmd/spo/homesite/homesite-get.md +20 -1
  138. package/docs/docs/cmd/spo/homesite/homesite-remove.md +8 -2
  139. package/docs/docs/cmd/spo/homesite/homesite-set.md +8 -2
  140. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +9 -9
  141. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md +34 -5
  142. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +6 -6
  143. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +36 -19
  144. package/docs/docs/cmd/spo/hubsite/hubsite-list.md +59 -1
  145. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +30 -1
  146. package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md +6 -6
  147. package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md +4 -4
  148. package/docs/docs/cmd/spo/hubsite/hubsite-set.md +40 -15
  149. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +4 -4
  150. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +7 -1
  151. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +9 -3
  152. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +8 -2
  153. package/docs/docs/cmd/spo/list/list-add.md +123 -57
  154. package/docs/docs/cmd/spo/list/list-contenttype-add.md +50 -5
  155. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +4 -4
  156. package/docs/docs/cmd/spo/list/list-contenttype-list.md +49 -4
  157. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +6 -6
  158. package/docs/docs/cmd/spo/list/list-get.md +70 -4
  159. package/docs/docs/cmd/spo/list/list-list.md +70 -2
  160. package/docs/docs/cmd/spo/list/list-remove.md +6 -6
  161. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +2 -2
  162. package/docs/docs/cmd/spo/list/list-retentionlabel-get.md +36 -3
  163. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +3 -3
  164. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +6 -6
  165. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +3 -3
  166. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +9 -9
  167. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +7 -7
  168. package/docs/docs/cmd/spo/list/list-set.md +61 -61
  169. package/docs/docs/cmd/spo/list/list-sitescript-get.md +35 -3
  170. package/docs/docs/cmd/spo/list/list-view-add.md +66 -5
  171. package/docs/docs/cmd/spo/list/list-view-field-add.md +10 -10
  172. package/docs/docs/cmd/spo/list/list-view-get.md +61 -0
  173. package/docs/docs/cmd/spo/list/list-view-list.md +61 -0
  174. package/docs/docs/cmd/spo/list/list-view-set.md +1 -1
  175. package/docs/docs/cmd/spo/list/list-webhook-add.md +19 -0
  176. package/docs/docs/cmd/spo/list/list-webhook-get.md +19 -0
  177. package/docs/docs/cmd/spo/list/list-webhook-list.md +19 -0
  178. package/docs/docs/cmd/spo/listitem/listitem-add.md +29 -0
  179. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +17 -2
  180. package/docs/docs/cmd/spo/listitem/listitem-get.md +57 -0
  181. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +6 -0
  182. package/docs/docs/cmd/spo/listitem/listitem-list.md +28 -0
  183. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +15 -0
  184. package/docs/docs/cmd/spo/listitem/listitem-set.md +30 -0
  185. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +22 -0
  186. package/docs/docs/cmd/spo/navigation/navigation-node-get.md +91 -0
  187. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
  188. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
  189. package/docs/docs/cmd/status.md +46 -0
  190. package/docs/docs/cmd/version.md +26 -0
  191. package/npm-shrinkwrap.json +912 -876
  192. package/package.json +13 -12
@@ -28,6 +28,9 @@ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
28
28
  !!! attention
29
29
  This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
30
30
 
31
+ !!! attention
32
+ This command currently only supports delegated permissions.
33
+
31
34
  ## More information
32
35
 
33
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.
@@ -0,0 +1,97 @@
1
+ # purview retentioneventtype list
2
+
3
+ Get a list of retention event types
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentioneventtype list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ Get a list of retention event types
18
+
19
+ ```sh
20
+ m365 purview retentioneventtype list
21
+ ```
22
+
23
+ ## Remarks
24
+
25
+ !!! attention
26
+ 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.
27
+
28
+ !!! attention
29
+ This command currently only supports delegated permissions.
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
+ ## Response
36
+
37
+
38
+ === "JSON"
39
+
40
+ ```json
41
+ [
42
+ {
43
+ "displayName": "Contract Expiry",
44
+ "description": "",
45
+ "createdDateTime": "2023-02-02T15:47:54Z",
46
+ "lastModifiedDateTime": "2023-02-02T15:47:54Z",
47
+ "id": "81fa91bd-66cd-4c6c-b0cb-71f37210dc74",
48
+ "createdBy": {
49
+ "user": {
50
+ "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
51
+ "displayName": null
52
+ }
53
+ },
54
+ "lastModifiedBy": {
55
+ "user": {
56
+ "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
57
+ "displayName": null
58
+ }
59
+ }
60
+ }
61
+ ]
62
+ ```
63
+
64
+ === "Text"
65
+
66
+ ```text
67
+ id displayName createdDateTime
68
+ ------------------------------------ --------------------- --------------------
69
+ 81fa91bd-66cd-4c6c-b0cb-71f37210dc74 Contract Expiry 2023-02-02T15:47:54Z
70
+ ```
71
+
72
+ === "CSV"
73
+
74
+ ```csv
75
+ id,displayName,createdDateTime
76
+ 81fa91bd-66cd-4c6c-b0cb-71f37210dc74,Contract Expiry,2023-02-02T15:47:54Z
77
+ ```
78
+
79
+ === "Markdown"
80
+
81
+ ```md
82
+ # purview retentioneventtype list
83
+
84
+ Date: 8/2/2023
85
+
86
+ ## Contract Expiry (81fa91bd-66cd-4c6c-b0cb-71f37210dc74)
87
+
88
+ Property | Value
89
+ ---------|-------
90
+ displayName | Contract Expiry
91
+ description | null
92
+ createdDateTime | 2023-02-02T15:47:54Z
93
+ lastModifiedDateTime | 2023-02-02T15:47:54Z
94
+ id | 81fa91bd-66cd-4c6c-b0cb-71f37210dc74
95
+ createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
96
+ lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
97
+ ```
@@ -0,0 +1,43 @@
1
+ # purview retentioneventtype remove
2
+
3
+ Delete a retention event type
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentioneventtype remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the retention event type.
15
+
16
+ `--confirm`
17
+ : Don't prompt for confirmation to remove the retention event type.
18
+
19
+ --8<-- "docs/cmd/_global.md"
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
+ ## Remarks
30
+
31
+ !!! attention
32
+ 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.
33
+
34
+ !!! attention
35
+ This command currently only supports delegated permissions.
36
+
37
+ ## More information
38
+
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)
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.
@@ -0,0 +1,43 @@
1
+ # purview retentioneventtype set
2
+
3
+ Update a retention event type
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentioneventtype set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The id of the retention event type.
15
+
16
+ `-d, --description [description]`
17
+ : The new description of the event type.
18
+
19
+ --8<-- "docs/cmd/_global.md"
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
+ ## Remarks
30
+
31
+ !!! attention
32
+ 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.
33
+
34
+ !!! attention
35
+ This command currently only supports delegated permissions.
36
+
37
+ ## More information
38
+
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)
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.
@@ -58,6 +58,9 @@ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringReten
58
58
  !!! attention
59
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
60
 
61
+ !!! attention
62
+ This command currently only supports delegated permissions.
63
+
61
64
  ## More information
62
65
 
63
66
  - 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)
@@ -28,6 +28,9 @@ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
28
28
  !!! attention
29
29
  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.
30
30
 
31
+ !!! attention
32
+ This command currently only supports delegated permissions.
33
+
31
34
  ## Response
32
35
 
33
36
 
@@ -25,6 +25,9 @@ m365 purview retentionlabel list
25
25
  !!! attention
26
26
  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.
27
27
 
28
+ !!! attention
29
+ This command currently only supports delegated permissions.
30
+
28
31
  ## Response
29
32
 
30
33
 
@@ -31,6 +31,9 @@ m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
31
31
  !!! attention
32
32
  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.
33
33
 
34
+ !!! attention
35
+ This command currently only supports delegated permissions.
36
+
34
37
  ## Response
35
38
 
36
39
  The command won't return a response on success.
@@ -58,6 +58,9 @@ m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --beha
58
58
  !!! attention
59
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
60
 
61
+ !!! attention
62
+ This command currently only supports delegated permissions.
63
+
61
64
  ## Response
62
65
 
63
66
  The command won't return a response on success.
@@ -74,3 +74,77 @@ Call the Microsoft Graph to get a profile photo.
74
74
  ```sh
75
75
  m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
76
76
  ```
77
+
78
+ ## Response
79
+
80
+ The responses below are an example based on the `url` option with the value 'https://graph.microsoft.com/v1.0/me'. The output may differ based on the `url` options
81
+
82
+ === "JSON"
83
+
84
+ ```json
85
+ {
86
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
87
+ "businessPhones": [
88
+ "123456789"
89
+ ],
90
+ "displayName": "John Doe",
91
+ "givenName": "John",
92
+ "jobTitle": null,
93
+ "mail": "john.doe@contoso.onmicrosoft.com",
94
+ "mobilePhone": null,
95
+ "officeLocation": null,
96
+ "preferredLanguage": "en-US",
97
+ "surname": "Doe",
98
+ "userPrincipalName": "john.doe@contoso.onmicrosoft.com",
99
+ "id": "1df1fffa-62b8-44a9-9c7c-49853f5b4ac6"
100
+ }
101
+ ```
102
+
103
+ === "Text"
104
+
105
+ ```text
106
+ @odata.context : https://graph.microsoft.com/v1.0/$metadata#users/$entity
107
+ businessPhones : ["123456789"]
108
+ displayName : John Doe
109
+ givenName : John
110
+ id : 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
111
+ jobTitle : null
112
+ mail : john.doe@contoso.onmicrosoft.com
113
+ mobilePhone : null
114
+ officeLocation : null
115
+ preferredLanguage: en-US
116
+ surname : Doe
117
+ userPrincipalName: john.doe@contoso.onmicrosoft.com
118
+ ```
119
+
120
+ === "CSV"
121
+
122
+ ```csv
123
+ @odata.context,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
124
+ https://graph.microsoft.com/v1.0/$metadata#users/$entity,"[""123456789""]",John Doe,John,,john.doe@contoso.onmicrosoft.com,,,en-US,Doe,john.doe@contoso.onmicrosoft.com,1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
125
+ ```
126
+
127
+ === "Markdown"
128
+
129
+ ```md
130
+ # request --url "https://graph.microsoft.com/v1.0/me" --method "get"
131
+
132
+ Date: 7/2/2023
133
+
134
+ ## John Doe (1df1fffa-62b8-44a9-9c7c-49853f5b4ac6)
135
+
136
+ Property | Value
137
+ ---------|-------
138
+ @odata.context | https://graph.microsoft.com/v1.0/$metadata#users/$entity
139
+ businessPhones | ["494594133"]
140
+ displayName | John Doe
141
+ givenName | John
142
+ jobTitle | null
143
+ mail | john.doe@contoso.onmicrosoft.com
144
+ mobilePhone | null
145
+ officeLocation | null
146
+ preferredLanguage | en-US
147
+ surname | Doe
148
+ userPrincipalName | john.doe@contoso.onmicrosoft.com
149
+ id | 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
150
+ ```
@@ -0,0 +1,56 @@
1
+ # spo applicationcustomizer add
2
+
3
+ Add an application customizer to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo applicationcustomizer add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : The title of the application customizer.
15
+
16
+ `-u, --webUrl <webUrl>`
17
+ : URL of the site.
18
+
19
+ `-i, --clientSideComponentId <clientSideComponentId>`
20
+ : Client-side component ID of the application customizer (GUID).
21
+
22
+ `--clientSideComponentProperties [clientSideComponentProperties]`
23
+ : JSON string with application customizer properties
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how an application customizer can be created from the Windows cmd.exe:
30
+
31
+ ```sh
32
+ m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
33
+ ```
34
+
35
+ Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
36
+
37
+ !!! warning "Escaping JSON in PowerShell"
38
+ When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
39
+
40
+ ## Examples
41
+
42
+ Adds an application customizer to the sales site.
43
+
44
+ ```sh
45
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webUrl https://contoso.sharepoint.com/sites/sales
46
+ ```
47
+
48
+ Adds an application customizer to the sales site with some properties.
49
+
50
+ ```sh
51
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales
52
+ ```
53
+
54
+ ## Response
55
+
56
+ The command won't return a response on success.
@@ -0,0 +1,46 @@
1
+ # spo file sharinglink clear
2
+
3
+ Removes sharing links of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink clear [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `-s, --scope [scope]`
23
+ : Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes all sharing links from a file specified by id without prompting for confirmation
33
+
34
+ ```sh
35
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --confirm
36
+ ```
37
+
38
+ Removes sharing links of type anonymous from a file specified by url with prompting for confirmation
39
+
40
+ ```sh
41
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --scope anonymous
42
+ ```
43
+
44
+ ## Response
45
+
46
+ The command won't return a response on success.
@@ -19,7 +19,7 @@ m365 spo file sharinglink list [options]
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
- `--scope [scope]`
22
+ `-s, --scope [scope]`
23
23
  : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
@@ -0,0 +1,104 @@
1
+ # spo file sharinglink set
2
+
3
+ Updates a sharing link of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `--id <id>`
23
+ : The ID of the sharing link.
24
+
25
+ `--expirationDateTime <expirationDateTime>`
26
+ : The date and time to set the expiration. This should be defined as a valid ISO 8601 string. This options only works for anonymous links.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Updates an anonymous sharing link from a file by a specified site-relative URL with the expirationDateTime parameter
33
+
34
+ ```sh
35
+ m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Document.docx" --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
36
+ ```
37
+
38
+ Updates an anonymous sharing link from a file by id with the expirationDateTime parameter
39
+
40
+ ```sh
41
+ m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
42
+ ```
43
+
44
+ ## Response
45
+
46
+ === "JSON"
47
+
48
+ ```json
49
+ {
50
+ "id": "7c9f97c9-1bda-433c-9364-bb83e81771ee",
51
+ "roles": [
52
+ "read"
53
+ ],
54
+ "expirationDateTime": "2023-02-09T16:57:00Z",
55
+ "hasPassword": false,
56
+ "grantedToIdentitiesV2": [],
57
+ "grantedToIdentities": [],
58
+ "link": {
59
+ "scope": "anonymous",
60
+ "type": "view",
61
+ "webUrl": "https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g",
62
+ "preventsDownload": false
63
+ }
64
+ }
65
+ ```
66
+
67
+ === "Text"
68
+
69
+ ```text
70
+ expirationDateTime : 2023-02-09T16:57:00Z
71
+ grantedToIdentities : []
72
+ grantedToIdentitiesV2: []
73
+ hasPassword : false
74
+ id : 7c9f97c9-1bda-433c-9364-bb83e81771ee
75
+ link : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g","preventsDownload":false}
76
+ roles : ["read"]
77
+ ```
78
+
79
+ === "CSV"
80
+
81
+ ```csv
82
+ id,roles,expirationDateTime,hasPassword,grantedToIdentitiesV2,grantedToIdentities,link
83
+ 7c9f97c9-1bda-433c-9364-bb83e81771ee,"[""read""]",2023-02-09T16:57:00Z,,[],[],"{""scope"":""anonymous"",""type"":""view"",""webUrl"":""https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g"",""preventsDownload"":false}"
84
+ ```
85
+
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo file sharinglink set --webUrl "https://contoso.sharepoint.com" --fileUrl "/sites/demo/Shared Documents/Document.docx" --expirationDateTime "2023-02-09T16:57:00.000Z" --id "7c9f97c9-1bda-433c-9364-bb83e81771ee"
90
+
91
+ Date: 5/2/2023
92
+
93
+ ## 7c9f97c9-1bda-433c-9364-bb83e81771ee
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ id | 7c9f97c9-1bda-433c-9364-bb83e81771ee
98
+ roles | ["read"]
99
+ expirationDateTime | 2023-02-09T16:57:00Z
100
+ hasPassword | false
101
+ grantedToIdentitiesV2 | []
102
+ grantedToIdentities | []
103
+ link | {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-\_527\_fI9g","preventsDownload":false}
104
+ ```
@@ -14,7 +14,7 @@ m365 spo homesite get [options]
14
14
 
15
15
  ## Examples
16
16
 
17
- Get information about the Home Site
17
+ Get information about the Home Site.
18
18
 
19
19
  ```sh
20
20
  m365 spo homesite get
@@ -51,6 +51,25 @@ m365 spo homesite get
51
51
  af80c11f-0138-4d72-bb37-514542c3aabb,6f90666d-b0e7-40c3-991f-4ab051d00a70,https://contoso.sharepoint.com/sites/intra/siteassets/work.png,Intranet,https://contoso.sharepoint.com/sites/intra
52
52
  ```
53
53
 
54
+ === "Markdown"
55
+
56
+ ```md
57
+ # spo homesite get
58
+
59
+ Date: 2/20/2023
60
+
61
+ ## Intranet (https://contoso.sharepoint.com/sites/intra)
62
+
63
+ Property | Value
64
+ ---------|-------
65
+ IsInDraftMode | false
66
+ SiteId | af80c11f-0138-4d72-bb37-514542c3aabb
67
+ WebId |6f90666d-b0e7-40c3-991f-4ab051d00a70
68
+ LogoUrl | https://contoso.sharepoint.com/sites/intra/siteassets/work.png
69
+ Title | Intranet
70
+ Url | https://contoso.sharepoint.com/sites/intra
71
+ ```
72
+
54
73
  ## More information
55
74
 
56
75
  - SharePoint home sites: a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)
@@ -11,7 +11,7 @@ m365 spo homesite remove [options]
11
11
  ## Options
12
12
 
13
13
  `--confirm`
14
- : Do not prompt for confirmation before removing the Home Site
14
+ : Do not prompt for confirmation before removing the Home Site.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -20,7 +20,7 @@ m365 spo homesite remove [options]
20
20
 
21
21
  ## Examples
22
22
 
23
- Removes the current Home Site without confirmation
23
+ Removes the current Home Site without confirmation.
24
24
 
25
25
  ```sh
26
26
  m365 spo homesite remove --confirm
@@ -46,6 +46,12 @@ m365 spo homesite remove --confirm
46
46
  https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details.
47
47
  ```
48
48
 
49
+ === "Markdown"
50
+
51
+ ```md
52
+ https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details.
53
+ ```
54
+
49
55
  ## More information
50
56
 
51
57
  - SharePoint home sites, a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)
@@ -11,7 +11,7 @@ m365 spo homesite set [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --siteUrl <siteUrl>`
14
- : The URL of the site to set as Home Site
14
+ : The URL of the site to set as Home Site.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -20,7 +20,7 @@ m365 spo homesite set [options]
20
20
 
21
21
  ## Examples
22
22
 
23
- Set the specified site as the Home Site
23
+ Set the specified site as the Home Site.
24
24
 
25
25
  ```sh
26
26
  m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms
@@ -46,6 +46,12 @@ m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms
46
46
  The Home site has been set to https://contoso.sharepoint.com. It may take some time for the change to apply. Check aka.ms/homesites for details.
47
47
  ```
48
48
 
49
+ === "Markdown"
50
+
51
+ ```md
52
+ The Home site has been set to https://contoso.sharepoint.com. It may take some time for the change to apply. Check aka.ms/homesites for details.
53
+ ```
54
+
49
55
  ## More information
50
56
 
51
57
  - SharePoint home sites: a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)