@pnp/cli-microsoft365 12.0.0-beta.0be7d8d → 12.0.0-beta.1752794

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 (190) hide show
  1. package/.devproxy/generate-openapi-spec.json +1 -1
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/Auth.js +2 -6
  5. package/dist/auth/FileTokenStorage.js +0 -3
  6. package/dist/auth/msalCachePlugin.js +201 -12
  7. package/dist/googleAnalytics.js +96 -0
  8. package/dist/m365/commands/logout.js +2 -4
  9. package/dist/m365/entra/commands/m365group/m365group-remove.js +4 -3
  10. package/dist/m365/spe/commands/container/container-remove.js +6 -7
  11. package/dist/m365/spo/commands/app/app-add.js +35 -56
  12. package/dist/m365/spo/commands/app/app-deploy.js +41 -59
  13. package/dist/m365/spo/commands/app/app-get.js +40 -56
  14. package/dist/m365/spo/commands/app/app-install.js +20 -41
  15. package/dist/m365/spo/commands/app/app-instance-list.js +12 -24
  16. package/dist/m365/spo/commands/app/app-list.js +26 -44
  17. package/dist/m365/spo/commands/app/app-remove.js +32 -52
  18. package/dist/m365/spo/commands/app/app-retract.js +32 -51
  19. package/dist/m365/spo/commands/app/app-teamspackage-download.js +35 -54
  20. package/dist/m365/spo/commands/app/app-uninstall.js +21 -44
  21. package/dist/m365/spo/commands/app/app-upgrade.js +20 -41
  22. package/dist/m365/spo/commands/feature/feature-disable.js +20 -50
  23. package/dist/m365/spo/commands/feature/feature-enable.js +22 -50
  24. package/dist/m365/spo/commands/feature/feature-list.js +11 -36
  25. package/dist/m365/spo/commands/field/field-add.js +33 -62
  26. package/dist/m365/spo/commands/field/field-get.js +30 -57
  27. package/dist/m365/spo/commands/field/field-list.js +21 -46
  28. package/dist/m365/spo/commands/field/field-remove.js +32 -63
  29. package/dist/m365/spo/commands/field/field-set.js +34 -66
  30. package/dist/m365/spo/commands/file/file-archive.js +1 -1
  31. package/dist/m365/spo/commands/file/file-get.js +4 -3
  32. package/dist/m365/spo/commands/file/file-remove.js +5 -5
  33. package/dist/m365/spo/commands/file/file-unarchive.js +1 -1
  34. package/dist/m365/spo/commands/folder/folder-archive.js +1 -1
  35. package/dist/m365/spo/commands/folder/folder-remove.js +5 -5
  36. package/dist/m365/spo/commands/folder/folder-unarchive.js +90 -0
  37. package/dist/m365/spo/commands/hidedefaultthemes/hidedefaultthemes-get.js +5 -0
  38. package/dist/m365/spo/commands/hidedefaultthemes/hidedefaultthemes-set.js +8 -26
  39. package/dist/m365/spo/commands/homesite/homesite-list.js +5 -0
  40. package/dist/m365/spo/commands/hubsite/hubsite-connect.js +38 -63
  41. package/dist/m365/spo/commands/hubsite/hubsite-data-get.js +11 -27
  42. package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +25 -47
  43. package/dist/m365/spo/commands/hubsite/hubsite-get.js +25 -37
  44. package/dist/m365/spo/commands/hubsite/hubsite-list.js +12 -24
  45. package/dist/m365/spo/commands/hubsite/hubsite-register.js +10 -18
  46. package/dist/m365/spo/commands/hubsite/hubsite-rights-grant.js +14 -32
  47. package/dist/m365/spo/commands/hubsite/hubsite-rights-revoke.js +12 -29
  48. package/dist/m365/spo/commands/hubsite/hubsite-set.js +19 -46
  49. package/dist/m365/spo/commands/hubsite/hubsite-unregister.js +11 -27
  50. package/dist/m365/spo/commands/list/list-remove.js +4 -4
  51. package/dist/m365/spo/commands/listitem/listitem-batch-remove.js +5 -4
  52. package/dist/m365/spo/commands/listitem/listitem-get.js +1 -12
  53. package/dist/m365/spo/commands/listitem/listitem-remove.js +8 -5
  54. package/dist/m365/spo/commands/navigation/navigation-node-list.js +6 -4
  55. package/dist/m365/spo/commands/page/page-remove.js +7 -7
  56. package/dist/m365/spo/commands/site/site-list.js +60 -49
  57. package/dist/m365/spo/commands/site/site-remove.js +7 -7
  58. package/dist/m365/spo/commands/spo-get.js +5 -0
  59. package/dist/m365/spo/commands/spo-set.js +10 -21
  60. package/dist/m365/spo/commands/storageentity/storageentity-get.js +23 -17
  61. package/dist/m365/spo/commands/storageentity/storageentity-list.js +39 -36
  62. package/dist/m365/spo/commands/storageentity/storageentity-remove.js +26 -33
  63. package/dist/m365/spo/commands/storageentity/storageentity-set.js +26 -36
  64. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +1 -1
  65. package/dist/m365/spo/commands/user/user-ensure.js +24 -60
  66. package/dist/m365/spo/commands/user/user-get.js +25 -65
  67. package/dist/m365/spo/commands/user/user-list.js +10 -18
  68. package/dist/m365/spo/commands/user/user-remove.js +26 -68
  69. package/dist/m365/spo/commands/userprofile/userprofile-get.js +10 -23
  70. package/dist/m365/spo/commands/userprofile/userprofile-set.js +10 -19
  71. package/dist/m365/spo/commands/web/web-add.js +20 -55
  72. package/dist/m365/spo/commands/web/web-clientsidewebpart-list.js +10 -18
  73. package/dist/m365/spo/commands/web/web-get.js +12 -30
  74. package/dist/m365/spo/commands/web/web-installedlanguage-list.js +10 -18
  75. package/dist/m365/spo/commands/web/web-list.js +10 -18
  76. package/dist/m365/spo/commands/web/web-reindex.js +10 -18
  77. package/dist/m365/spo/commands/web/web-remove.js +11 -27
  78. package/dist/m365/spo/commands/web/web-retentionlabel-list.js +10 -18
  79. package/dist/m365/spo/commands/web/web-roleassignment-add.js +40 -64
  80. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +31 -58
  81. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +12 -36
  82. package/dist/m365/spo/commands/web/web-roleinheritance-reset.js +11 -29
  83. package/dist/m365/spo/commands/web/web-rule-get.js +47 -0
  84. package/dist/m365/spo/commands/web/web-rule-list.js +6 -4
  85. package/dist/m365/spo/commands/web/web-rule-remove.js +0 -3
  86. package/dist/m365/spo/commands/web/web-set.js +26 -96
  87. package/dist/m365/spo/commands.js +3 -3
  88. package/dist/m365/teams/commands/channel/channel-add.js +46 -57
  89. package/dist/m365/teams/commands/channel/channel-get.js +41 -48
  90. package/dist/m365/teams/commands/channel/channel-list.js +30 -48
  91. package/dist/m365/teams/commands/channel/channel-member-add.js +55 -60
  92. package/dist/m365/teams/commands/channel/channel-member-list.js +49 -61
  93. package/dist/m365/teams/commands/channel/channel-member-remove.js +64 -68
  94. package/dist/m365/teams/commands/channel/channel-member-set.js +63 -71
  95. package/dist/m365/teams/commands/channel/channel-remove.js +49 -57
  96. package/dist/m365/teams/commands/channel/channel-set.js +49 -62
  97. package/dist/m365/teams/commands/chat/chat-get.js +30 -45
  98. package/dist/m365/teams/commands/chat/chat-list.js +22 -42
  99. package/dist/m365/teams/commands/chat/chat-member-add.js +43 -64
  100. package/dist/m365/teams/commands/chat/chat-member-list.js +10 -23
  101. package/dist/m365/teams/commands/chat/chat-member-remove.js +28 -50
  102. package/dist/m365/teams/commands/chat/chat-message-send.js +32 -55
  103. package/dist/m365/teams/commands/tab/tab-get.js +2 -6
  104. package/dist/m365/teams/commands/team/team-archive.js +2 -6
  105. package/dist/m365/teams/commands/team/team-remove.js +2 -6
  106. package/dist/m365/teams/commands/team/team-unarchive.js +2 -6
  107. package/dist/m365/util/commands/accesstoken/accesstoken-get.js +10 -28
  108. package/dist/telemetry.js +7 -11
  109. package/dist/utils/spo.js +1 -3
  110. package/dist/utils/urlUtil.js +2 -2
  111. package/docs/docs/cmd/entra/m365group/m365group-remove.mdx +4 -4
  112. package/docs/docs/cmd/spe/container/container-remove.mdx +5 -5
  113. package/docs/docs/cmd/spo/file/file-archive.mdx +9 -1
  114. package/docs/docs/cmd/spo/file/file-checkin.mdx +2 -2
  115. package/docs/docs/cmd/spo/file/file-checkout-undo.mdx +1 -1
  116. package/docs/docs/cmd/spo/file/file-checkout.mdx +2 -2
  117. package/docs/docs/cmd/spo/file/file-copy.mdx +2 -2
  118. package/docs/docs/cmd/spo/file/file-get.mdx +6 -6
  119. package/docs/docs/cmd/spo/file/file-remove.mdx +4 -4
  120. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  121. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +1 -1
  122. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +1 -1
  123. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  124. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +3 -3
  125. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +2 -2
  126. package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +2 -2
  127. package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +22 -1
  128. package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +24 -1
  129. package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +22 -1
  130. package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +22 -1
  131. package/docs/docs/cmd/spo/file/file-sharinglink-remove.mdx +24 -1
  132. package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +22 -1
  133. package/docs/docs/cmd/spo/file/file-unarchive.mdx +9 -1
  134. package/docs/docs/cmd/spo/file/file-version-clear.mdx +1 -1
  135. package/docs/docs/cmd/spo/file/file-version-get.mdx +1 -1
  136. package/docs/docs/cmd/spo/file/file-version-keep.mdx +1 -1
  137. package/docs/docs/cmd/spo/file/file-version-list.mdx +1 -1
  138. package/docs/docs/cmd/spo/file/file-version-remove.mdx +1 -1
  139. package/docs/docs/cmd/spo/file/file-version-restore.mdx +1 -1
  140. package/docs/docs/cmd/spo/folder/folder-archive.mdx +7 -1
  141. package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
  142. package/docs/docs/cmd/spo/folder/folder-get.mdx +2 -2
  143. package/docs/docs/cmd/spo/folder/folder-remove.mdx +4 -4
  144. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +1 -1
  145. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +1 -1
  146. package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +22 -1
  147. package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +23 -0
  148. package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +21 -0
  149. package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +22 -1
  150. package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +24 -1
  151. package/docs/docs/cmd/spo/folder/folder-sharinglink-set.mdx +21 -0
  152. package/docs/docs/cmd/spo/folder/folder-unarchive.mdx +76 -0
  153. package/docs/docs/cmd/spo/list/list-remove.mdx +4 -4
  154. package/docs/docs/cmd/spo/listitem/listitem-batch-remove.mdx +8 -2
  155. package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -6
  156. package/docs/docs/cmd/spo/listitem/listitem-remove.mdx +8 -2
  157. package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +37 -27
  158. package/docs/docs/cmd/spo/page/page-remove.mdx +4 -4
  159. package/docs/docs/cmd/spo/site/site-apppermission-add.mdx +52 -21
  160. package/docs/docs/cmd/spo/site/site-list.mdx +22 -1
  161. package/docs/docs/cmd/spo/site/site-remove.mdx +3 -3
  162. package/docs/docs/cmd/spo/storageentity/storageentity-get.mdx +11 -2
  163. package/docs/docs/cmd/spo/storageentity/storageentity-list.mdx +9 -3
  164. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +6 -6
  165. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +10 -4
  166. package/docs/docs/cmd/spo/web/web-rule-get.mdx +108 -0
  167. package/docs/docs/cmd/spo/web/web-rule-list.mdx +8 -12
  168. package/docs/docs/cmd/spo/web/web-rule-remove.mdx +0 -6
  169. package/docs/docs/cmd/spp/model/model-get.mdx +1 -1
  170. package/docs/docs/cmd/spp/model/model-remove.mdx +1 -1
  171. package/docs/docs/cmd/teams/app/app-install.mdx +21 -0
  172. package/docs/docs/cmd/teams/app/app-list.mdx +19 -0
  173. package/docs/docs/cmd/teams/app/app-publish.mdx +17 -0
  174. package/docs/docs/cmd/teams/app/app-remove.mdx +19 -0
  175. package/docs/docs/cmd/teams/app/app-uninstall.mdx +21 -0
  176. package/docs/docs/cmd/teams/app/app-update.mdx +19 -0
  177. package/docs/docs/cmd/tenant/people/people-profilecardproperty-add.mdx +19 -0
  178. package/docs/docs/cmd/tenant/people/people-profilecardproperty-get.mdx +19 -0
  179. package/docs/docs/cmd/tenant/people/people-profilecardproperty-list.mdx +19 -0
  180. package/docs/docs/cmd/tenant/people/people-profilecardproperty-remove.mdx +19 -0
  181. package/docs/docs/cmd/tenant/people/people-profilecardproperty-set.mdx +19 -0
  182. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.mdx +19 -0
  183. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.mdx +19 -0
  184. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.mdx +19 -0
  185. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.mdx +19 -0
  186. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.mdx +19 -0
  187. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.mdx +19 -0
  188. package/npm-shrinkwrap.json +1120 -3216
  189. package/package.json +23 -33
  190. package/dist/appInsights.js +0 -43
@@ -27,8 +27,8 @@ m365 spe container remove [options]
27
27
  `--containerTypeName [containerTypeName]`
28
28
  : The name of the container type. Specify either `containerTypeId` or `containerTypeName` when using `name` but not both.
29
29
 
30
- `--recycle`
31
- : Recycle the container instance instead of permanently deleting it.
30
+ `--permanent`
31
+ : Permanently delete the container instance instead of moving it to the recycle bin.
32
32
 
33
33
  `-f, --force`
34
34
  : Do not prompt for confirmation.
@@ -67,16 +67,16 @@ The command is based on an API that is currently in preview and is subject to ch
67
67
 
68
68
  ## Examples
69
69
 
70
- Remove a container by ID.
70
+ Move a container specified by ID to the recycle bin.
71
71
 
72
72
  ```sh
73
73
  m365 spe container remove --id "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z"
74
74
  ```
75
75
 
76
- Move a container specified by ID to the recycle bin.
76
+ Permanently remove a container by ID.
77
77
 
78
78
  ```sh
79
- m365 spe container remove --id "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z" --recycle
79
+ m365 spe container remove --id "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z" --permanent
80
80
  ```
81
81
 
82
82
  Remove a container by name specifying the container type id.
@@ -22,7 +22,7 @@ m365 spo file archive [options]
22
22
  : The server- or site-relative decoded URL of the file to archive. Specify either `url` or `id`, but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to archive. Specify either `url` or `id`, but not both.
25
+ : The unique ID (GUID) of the file to archive. Specify either `url` or `id`, but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -30,6 +30,14 @@ m365 spo file archive [options]
30
30
 
31
31
  <Global />
32
32
 
33
+ ## Remarks
34
+
35
+ :::warning
36
+
37
+ You will be able to reactivate an archived file instantly for the first 7 days. After that, it will take up to 24 hours to reactivate.
38
+
39
+ :::
40
+
33
41
  ## Permissions
34
42
 
35
43
  <Tabs>
@@ -22,7 +22,7 @@ m365 spo file checkin [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
26
26
 
27
27
  `-t, --type [type]`
28
28
  : Type of the check in. Allowed values: `Minor`, `Major`, `Overwrite`. Defaults to `Major`.
@@ -54,7 +54,7 @@ m365 spo file checkin [options]
54
54
 
55
55
  ## Examples
56
56
 
57
- Checks in file with the specified UniqueId located in the specified site.
57
+ Checks in file with the specified unique ID located in the specified site.
58
58
 
59
59
  ```sh
60
60
  m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
@@ -22,7 +22,7 @@ m365 spo file checkout undo [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -22,7 +22,7 @@ m365 spo file checkout [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -48,7 +48,7 @@ m365 spo file checkout [options]
48
48
 
49
49
  ## Examples
50
50
 
51
- Checks out file with the specified UniqueId located in the specified site.
51
+ Checks out file with the specified unique ID located in the specified site.
52
52
 
53
53
  ```sh
54
54
  m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
@@ -85,13 +85,13 @@ Copy a file by site-relative URL to a document library in another site collectio
85
85
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --ignoreVersionHistory
86
86
  ```
87
87
 
88
- Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file (without specifying the file extension).
88
+ Copy file by sourceId (unique ID) to a document library in another site collection and rename the file (without specifying the file extension).
89
89
 
90
90
  ```sh
91
91
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf"
92
92
  ```
93
93
 
94
- Copy file by sourceId (UniqueId) to a document library in another site collection with a new name, rename the file if it already exists.
94
+ Copy file by sourceId (unique ID) to a document library in another site collection with a new name, rename the file if it already exists.
95
95
 
96
96
  ```sh
97
97
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf" --nameConflictBehavior rename
@@ -22,7 +22,7 @@ m365 spo file get [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
26
26
 
27
27
  `--asString`
28
28
  : Set to retrieve the contents of the specified file as string.
@@ -63,25 +63,25 @@ m365 spo file get [options]
63
63
 
64
64
  ## Examples
65
65
 
66
- Get file properties for a file with id (UniqueId) parameter located in a site.
66
+ Get file properties for a file with id (unique ID) parameter located in a site.
67
67
 
68
68
  ```sh
69
69
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
70
70
  ```
71
71
 
72
- Get contents of the file with id (UniqueId) parameter located in a site.
72
+ Get contents of the file with id (unique ID) parameter located in a site.
73
73
 
74
74
  ```sh
75
75
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asString
76
76
  ```
77
77
 
78
- Get list item properties for a file with id (UniqueId) parameter located in a site.
78
+ Get list item properties for a file with id (unique ID) parameter located in a site.
79
79
 
80
80
  ```sh
81
81
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asListItem
82
82
  ```
83
83
 
84
- Saves the file with id (UniqueId) parameter located in a site to a local file.
84
+ Saves the file with id (unique ID) parameter located in a site to a local file.
85
85
 
86
86
  ```sh
87
87
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asFile --path /Users/user/documents/SavedAsTest1.docx
@@ -111,7 +111,7 @@ Saves a file with the server-relative url located in a site to a local file.
111
111
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asFile --path /Users/user/documents/SavedAsTest1.docx
112
112
  ```
113
113
 
114
- Gets the file properties for a file with id (UniqueId) parameter located in a site with permissions.
114
+ Gets the file properties for a file with id (unique ID) parameter located in a site with permissions.
115
115
 
116
116
  ```sh
117
117
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --withPermissions
@@ -30,8 +30,8 @@ m365 spo page template remove
30
30
  `--url [url]`
31
31
  : The server- or site-relative decoded URL of the file to remove. Specify either `id` or `url` but not both.
32
32
 
33
- `--recycle`
34
- : Recycle the file instead of actually deleting it.
33
+ `--permanent`
34
+ : Permanently delete the file instead of moving it to the recycle bin.
35
35
 
36
36
  `--bypassSharedLock`
37
37
  : Remove the file even if it is locked for shared use.
@@ -75,10 +75,10 @@ Remove a file by site-relative URL.
75
75
  m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --url "/Shared Documents/Test.docx"
76
76
  ```
77
77
 
78
- Remove a file by server-relative URL to the recycle bin.
78
+ Permanently remove a file by server-relative URL.
79
79
 
80
80
  ```sh
81
- m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --url "/sites/project-x/Shared Documents/Test.docx" --recycle
81
+ m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --url "/sites/project-x/Shared Documents/Test.docx" --permanent
82
82
  ```
83
83
 
84
84
  Remove a file that is locked
@@ -22,7 +22,7 @@ m365 spo file retentionlabel ensure [options]
22
22
  : The site- or server-relative decoded URL of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--name <name>`
28
28
  : Name of the retention label to apply to the file.
@@ -22,7 +22,7 @@ m365 spo file retentionlabel remove [options]
22
22
  : The server- or site-relative decoded URL of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirming removing the retention label from a file.
@@ -22,7 +22,7 @@ m365 spo file roleassignment add [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--principalId [principalId]`
28
28
  : The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either `upn`, `groupName`, or `principalId` but not multiple.
@@ -22,7 +22,7 @@ m365 spo file roleassignment remove [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--principalId [principalId]`
28
28
  : The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, `entraGroupId`, `entraGroupName`, or `principalId` but not multiple.
@@ -22,7 +22,7 @@ m365 spo file roleinheritance break [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-c, --clearExistingPermissions`
28
28
  : Clear all existing permissions from the file.
@@ -54,13 +54,13 @@ m365 spo file roleinheritance break [options]
54
54
 
55
55
  ## Examples
56
56
 
57
- Break the inheritance of a file with a specific id (UniqueId).
57
+ Break the inheritance of a file with a specific id (unique ID).
58
58
 
59
59
  ```sh
60
60
  m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
61
61
  ```
62
62
 
63
- Break the inheritance of a file with a specific id (UniqueId) and clear all existing permissions.
63
+ Break the inheritance of a file with a specific id (unique ID) and clear all existing permissions.
64
64
 
65
65
  ```sh
66
66
  m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
@@ -22,7 +22,7 @@ m365 spo file roleinheritance reset [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -51,7 +51,7 @@ m365 spo file roleinheritance reset [options]
51
51
 
52
52
  ## Examples
53
53
 
54
- Reset inheritance of file with the specified id (UniqueId) located in the specified site.
54
+ Reset inheritance of file with the specified id (unique ID) located in the specified site.
55
55
 
56
56
  ```sh
57
57
  m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
@@ -22,7 +22,7 @@ m365 spo file sharinginfo get [options]
22
22
  : The server- or site-relative decoded URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -54,7 +54,7 @@ Get file sharing information report for the file with the specified server-relat
54
54
  m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl "/sites/M365CLI/Shared Documents/SharedFile.docx"
55
55
  ```
56
56
 
57
- Get file sharing information report for file with the specified id (UniqueId) located in the specified site.
57
+ Get file sharing information report for file with the specified id (unique ID) located in the specified site.
58
58
 
59
59
  ```sh
60
60
  m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
@@ -22,7 +22,7 @@ m365 spo file sharinglink add [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--type <type>`
28
28
  : The type of sharing link to create. Either `view` or `edit`.
@@ -36,6 +36,27 @@ m365 spo file sharinglink add [options]
36
36
 
37
37
  <Global />
38
38
 
39
+ ## Permissions
40
+
41
+ <Tabs>
42
+ <TabItem value="Delegated">
43
+
44
+ | Resource | Permissions |
45
+ |-----------------|-----------------|
46
+ | Microsoft Graph | Files.ReadWrite |
47
+ | SharePoint | AllSites.Read |
48
+
49
+ </TabItem>
50
+ <TabItem value="Application">
51
+
52
+ | Resource | Permissions |
53
+ |-----------------|---------------------|
54
+ | Microsoft Graph | Files.ReadWrite.All |
55
+ | SharePoint | Sites.Read.All |
56
+
57
+ </TabItem>
58
+ </Tabs>
59
+
39
60
  ## Examples
40
61
 
41
62
  Creates a sharing link of a specific type for a file by id.
@@ -1,4 +1,6 @@
1
1
  import Global from '../../_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo file sharinglink clear
4
6
 
@@ -20,7 +22,7 @@ m365 spo file sharinglink clear [options]
20
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
21
23
 
22
24
  `--fileId [fileId]`
23
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
24
26
 
25
27
  `-s, --scope [scope]`
26
28
  : Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
@@ -31,6 +33,27 @@ m365 spo file sharinglink clear [options]
31
33
 
32
34
  <Global />
33
35
 
36
+ ## Permissions
37
+
38
+ <Tabs>
39
+ <TabItem value="Delegated">
40
+
41
+ | Resource | Permissions |
42
+ |-----------------|-----------------|
43
+ | Microsoft Graph | Files.ReadWrite |
44
+ | SharePoint | AllSites.Read |
45
+
46
+ </TabItem>
47
+ <TabItem value="Application">
48
+
49
+ | Resource | Permissions |
50
+ |-----------------|---------------------|
51
+ | Microsoft Graph | Files.ReadWrite.All |
52
+ | SharePoint | Sites.Read.All |
53
+
54
+ </TabItem>
55
+ </Tabs>
56
+
34
57
  ## Examples
35
58
 
36
59
  Removes all sharing links from a file specified by id without prompting for confirmation.
@@ -22,7 +22,7 @@ m365 spo file sharinglink get [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-i, --id <id>`
28
28
  : The ID of the sharing link.
@@ -30,6 +30,27 @@ m365 spo file sharinglink get [options]
30
30
 
31
31
  <Global />
32
32
 
33
+ ## Permissions
34
+
35
+ <Tabs>
36
+ <TabItem value="Delegated">
37
+
38
+ | Resource | Permissions |
39
+ |-----------------|---------------|
40
+ | Microsoft Graph | Files.Read |
41
+ | SharePoint | AllSites.Read |
42
+
43
+ </TabItem>
44
+ <TabItem value="Application">
45
+
46
+ | Resource | Permissions |
47
+ |-----------------|----------------|
48
+ | Microsoft Graph | Files.Read.All |
49
+ | SharePoint | Sites.Read.All |
50
+
51
+ </TabItem>
52
+ </Tabs>
53
+
33
54
  ## Examples
34
55
 
35
56
  Gets a specific sharing link of a file by id.
@@ -22,7 +22,7 @@ m365 spo file sharinglink list [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-s, --scope [scope]`
28
28
  : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
@@ -30,6 +30,27 @@ m365 spo file sharinglink list [options]
30
30
 
31
31
  <Global />
32
32
 
33
+ ## Permissions
34
+
35
+ <Tabs>
36
+ <TabItem value="Delegated">
37
+
38
+ | Resource | Permissions |
39
+ |-----------------|---------------|
40
+ | Microsoft Graph | Files.Read |
41
+ | SharePoint | AllSites.Read |
42
+
43
+ </TabItem>
44
+ <TabItem value="Application">
45
+
46
+ | Resource | Permissions |
47
+ |-----------------|----------------|
48
+ | Microsoft Graph | Files.Read.All |
49
+ | SharePoint | Sites.Read.All |
50
+
51
+ </TabItem>
52
+ </Tabs>
53
+
33
54
  ## Examples
34
55
 
35
56
  List sharing links of a file by id.
@@ -1,4 +1,6 @@
1
1
  import Global from '../../_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo file sharinglink remove
4
6
 
@@ -20,7 +22,7 @@ m365 spo file sharinglink remove [options]
20
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
21
23
 
22
24
  `--fileId [fileId]`
23
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
24
26
 
25
27
  `-i, --id <id>`
26
28
  : The ID of the sharing link.
@@ -31,6 +33,27 @@ m365 spo file sharinglink remove [options]
31
33
 
32
34
  <Global />
33
35
 
36
+ ## Permissions
37
+
38
+ <Tabs>
39
+ <TabItem value="Delegated">
40
+
41
+ | Resource | Permissions |
42
+ |-----------------|-----------------|
43
+ | Microsoft Graph | Files.ReadWrite |
44
+ | SharePoint | AllSites.Read |
45
+
46
+ </TabItem>
47
+ <TabItem value="Application">
48
+
49
+ | Resource | Permissions |
50
+ |-----------------|---------------------|
51
+ | Microsoft Graph | Files.ReadWrite.All |
52
+ | SharePoint | Sites.Read.All |
53
+
54
+ </TabItem>
55
+ </Tabs>
56
+
34
57
  ## Examples
35
58
 
36
59
  Removes a specific sharing link from a file by id without prompting for confirmation.
@@ -22,7 +22,7 @@ m365 spo file sharinglink set [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--id <id>`
28
28
  : The ID of the sharing link.
@@ -33,6 +33,27 @@ m365 spo file sharinglink set [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 | Files.ReadWrite |
44
+ | SharePoint | AllSites.Read |
45
+
46
+ </TabItem>
47
+ <TabItem value="Application">
48
+
49
+ | Resource | Permissions |
50
+ |-----------------|---------------------|
51
+ | Microsoft Graph | Files.ReadWrite.All |
52
+ | SharePoint | Sites.Read.All |
53
+
54
+ </TabItem>
55
+ </Tabs>
56
+
36
57
  ## Examples
37
58
 
38
59
  Updates an anonymous sharing link from a file by a specified site-relative URL with the expirationDateTime parameter.
@@ -22,7 +22,7 @@ m365 spo file unarchive [options]
22
22
  : The server- or site-relative decoded URL of the file to unarchive. Specify either `url` or `id`, but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to unarchive. Specify either `url` or `id`, but not both.
25
+ : The unique ID (GUID) of the file to unarchive. Specify either `url` or `id`, but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -30,6 +30,14 @@ m365 spo file unarchive [options]
30
30
 
31
31
  <Global />
32
32
 
33
+ ## Remarks
34
+
35
+ :::warning
36
+
37
+ Reactivation could take up to 24 hours. Files that are reactivated cannot be archived again for **120 days**.
38
+
39
+ :::
40
+
33
41
  ## Permissions
34
42
 
35
43
  <Tabs>
@@ -22,7 +22,7 @@ m365 spo file version clear [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -25,7 +25,7 @@ m365 spo file version get [options]
25
25
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-i, --fileId [fileId]`
28
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
28
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
29
29
  ```
30
30
 
31
31
  <Global />
@@ -22,7 +22,7 @@ m365 spo file version keep [options]
22
22
  : The server- or site-relative decoded URL. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--label <label>`
28
28
  : Label of the version.
@@ -22,7 +22,7 @@ m365 spo file version list [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -25,7 +25,7 @@ m365 spo file version remove [options]
25
25
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-i, --fileId [fileId]`
28
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
28
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
29
29
 
30
30
  `-f, --force`
31
31
  : Don't prompt for confirmation.
@@ -25,7 +25,7 @@ m365 spo file version restore [options]
25
25
  : The server- or site-relative decoded URL of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-i, --fileId [fileId]`
28
- : The UniqueId (GUID) of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both.
28
+ : The unique ID (GUID) of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both.
29
29
 
30
30
  `-f, --force`
31
31
  : Don't prompt for confirmation.
@@ -22,7 +22,7 @@ m365 spo folder archive [options]
22
22
  : The server- or site-relative decoded URL of the folder to archive. Specify either `url` or `id`, but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the folder to archive. Specify either `url` or `id`, but not both.
25
+ : The unique ID (GUID) of the folder to archive. Specify either `url` or `id`, but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -32,6 +32,12 @@ m365 spo folder archive [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
+ :::warning
36
+
37
+ You will be able to reactivate an archived folder instantly for the first 7 days. After that, it will take up to 24 hours to reactivate.
38
+
39
+ :::
40
+
35
41
  Folder archival can take some time to complete, as the status might not be reflected immediately.
36
42
 
37
43
  ## Permissions
@@ -22,7 +22,7 @@ m365 spo folder copy [options]
22
22
  : The server-, site-relative or absolute decoded URL of the folder to copy. Specify either `sourceUrl` or `sourceId` but not both.
23
23
 
24
24
  `-i, --sourceId [sourceId]`
25
- : The UniqueId (GUID) of the folder. Specify either `sourceUrl` or `sourceId` but not both.
25
+ : The unique ID (GUID) of the folder. Specify either `sourceUrl` or `sourceId` but not both.
26
26
 
27
27
  `-t, --targetUrl <targetUrl>`
28
28
  : Server-relative or absolute decoded URL where to copy the folder.