@pnp/cli-microsoft365 6.8.0-beta.2463cfa → 6.8.0-beta.a10f6e4

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 (67) hide show
  1. package/.mocharc.json +1 -0
  2. package/dist/m365/spo/commands/file/file-checkin.js +8 -3
  3. package/dist/m365/spo/commands/file/file-checkout.js +8 -3
  4. package/dist/m365/spo/commands/file/file-copy.js +4 -4
  5. package/dist/m365/spo/commands/file/file-get.js +3 -1
  6. package/dist/m365/spo/commands/file/file-list.js +2 -2
  7. package/dist/m365/spo/commands/file/file-move.js +6 -7
  8. package/dist/m365/spo/commands/file/file-remove.js +3 -12
  9. package/dist/m365/spo/commands/file/file-rename.js +3 -3
  10. package/dist/m365/spo/commands/file/file-roleassignment-add.js +2 -1
  11. package/dist/m365/spo/commands/file/file-roleassignment-remove.js +3 -3
  12. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +2 -1
  13. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +2 -1
  14. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +4 -2
  15. package/dist/m365/spo/commands/file/file-version-clear.js +3 -1
  16. package/dist/m365/spo/commands/file/file-version-get.js +3 -1
  17. package/dist/m365/spo/commands/file/file-version-remove.js +3 -1
  18. package/dist/m365/spo/commands/file/file-version-restore.js +3 -1
  19. package/dist/m365/spo/commands/folder/folder-copy.js +4 -4
  20. package/dist/m365/spo/commands/folder/folder-get.js +5 -2
  21. package/dist/m365/spo/commands/folder/folder-move.js +3 -2
  22. package/dist/m365/spo/commands/folder/folder-rename.js +5 -2
  23. package/dist/m365/spo/commands/serviceprincipal/serviceprincipal-permissionrequest-list.js +46 -1
  24. package/dist/m365/spo/commands/site/site-recyclebinitem-move.js +119 -0
  25. package/dist/m365/spo/commands/site/site-recyclebinitem-remove.js +106 -0
  26. package/dist/m365/spo/commands.js +2 -0
  27. package/dist/utils/spo.js +1 -1
  28. package/docs/docs/cmd/spo/file/file-add.md +1 -1
  29. package/docs/docs/cmd/spo/file/file-checkin.md +1 -1
  30. package/docs/docs/cmd/spo/file/file-checkout.md +1 -1
  31. package/docs/docs/cmd/spo/file/file-copy.md +1 -1
  32. package/docs/docs/cmd/spo/file/file-get.md +1 -1
  33. package/docs/docs/cmd/spo/file/file-move.md +3 -3
  34. package/docs/docs/cmd/spo/file/file-rename.md +1 -1
  35. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +3 -3
  36. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.md +2 -2
  37. package/docs/docs/cmd/spo/file/file-roleassignment-add.md +1 -1
  38. package/docs/docs/cmd/spo/file/file-roleassignment-remove.md +1 -1
  39. package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +1 -1
  40. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.md +1 -1
  41. package/docs/docs/cmd/spo/file/file-sharinginfo-get.md +1 -1
  42. package/docs/docs/cmd/spo/file/file-sharinglink-add.md +1 -1
  43. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +1 -1
  44. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +1 -1
  45. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  46. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +1 -1
  47. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +1 -1
  48. package/docs/docs/cmd/spo/file/file-version-clear.md +2 -2
  49. package/docs/docs/cmd/spo/file/file-version-get.md +1 -1
  50. package/docs/docs/cmd/spo/file/file-version-list.md +1 -1
  51. package/docs/docs/cmd/spo/file/file-version-remove.md +1 -1
  52. package/docs/docs/cmd/spo/file/file-version-restore.md +1 -1
  53. package/docs/docs/cmd/spo/folder/folder-add.md +9 -3
  54. package/docs/docs/cmd/spo/folder/folder-copy.md +1 -1
  55. package/docs/docs/cmd/spo/folder/folder-get.md +7 -7
  56. package/docs/docs/cmd/spo/folder/folder-list.md +11 -11
  57. package/docs/docs/cmd/spo/folder/folder-move.md +1 -1
  58. package/docs/docs/cmd/spo/folder/folder-remove.md +7 -7
  59. package/docs/docs/cmd/spo/folder/folder-rename.md +11 -5
  60. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.md +3 -3
  61. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.md +1 -1
  62. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +1 -1
  63. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +4 -4
  64. package/docs/docs/cmd/spo/site/site-recyclebinitem-move.md +43 -0
  65. package/docs/docs/cmd/spo/site/site-recyclebinitem-remove.md +45 -0
  66. package/npm-shrinkwrap.json +267 -334
  67. package/package.json +12 -12
@@ -11,10 +11,10 @@ m365 spo folder list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site where the folders to list are located
14
+ : The URL of the site where the folders to list are located.
15
15
 
16
16
  `-p, --parentFolderUrl <parentFolderUrl>`
17
- : Site-relative URL of the parent folder
17
+ : The server- or site-relative URL of the parent folder.
18
18
 
19
19
  `-f, --fields [fields]`
20
20
  : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested.
@@ -23,13 +23,13 @@ m365 spo folder list [options]
23
23
  : OData filter to use to query the list of folders with.
24
24
 
25
25
  `-r, --recursive`
26
- : Set to retrieve nested folders
26
+ : Set to retrieve nested folders.
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
30
  ## Examples
31
31
 
32
- Gets list of folders under a parent folder
32
+ Gets list of folders under a parent folder with site-relative URL
33
33
 
34
34
  ```sh
35
35
  m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
@@ -38,7 +38,7 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
38
38
  Gets recursive list of folders under a specific folder on a specific site
39
39
 
40
40
  ```sh
41
- m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --recursive
41
+ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents' --recursive
42
42
  ```
43
43
 
44
44
  Return a filtered list of folders and only return the list item ID
@@ -59,7 +59,7 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
59
59
  "ItemCount": 9,
60
60
  "Name": "Folder A",
61
61
  "ProgID": null,
62
- "ServerRelativeUrl": "/Shared Documents/Folder A",
62
+ "ServerRelativeUrl": "/sites/project-x/Shared Documents/Folder A",
63
63
  "TimeCreated": "2022-04-26T12:30:56Z",
64
64
  "TimeLastModified": "2022-04-26T12:50:14Z",
65
65
  "UniqueId": "20523746-971b-4488-aa6d-b45d645f61c5",
@@ -71,16 +71,16 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
71
71
  === "Text"
72
72
 
73
73
  ```text
74
- Name ServerRelativeUrl
75
- ------- -------------------------
76
- Folder A /Shared Documents/Folder A
74
+ Name ServerRelativeUrl
75
+ -------- ------------------------------------------
76
+ Folder A /sites/project-x/Shared Documents/Folder A
77
77
  ```
78
78
 
79
79
  === "CSV"
80
80
 
81
81
  ```csv
82
82
  Name,ServerRelativeUrl
83
- Folder A,/Shared Documents/Folder A
83
+ Folder A,/sites/project-x/Shared Documents/Folder A
84
84
  ```
85
85
 
86
86
  === "Markdown"
@@ -99,7 +99,7 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
99
99
  ItemCount | 9
100
100
  Name | Folder A
101
101
  ProgID | null
102
- ServerRelativeUrl | /Shared Documents/Folder A
102
+ ServerRelativeUrl | /sites/project-x/Shared Documents/Folder A
103
103
  TimeCreated | 2022-04-26T12:30:56Z
104
104
  TimeLastModified | 2022-04-26T12:50:14Z
105
105
  UniqueId | 20523746-971b-4488-aa6d-b45d645f61c5
@@ -14,7 +14,7 @@ m365 spo folder move [options]
14
14
  : The URL of the site where the folder is located
15
15
 
16
16
  `-s, --sourceUrl <sourceUrl>`
17
- : Site-relative URL of the folder to move
17
+ : The server- or site-relative URL of the folder to move
18
18
 
19
19
  `-t, --targetUrl <targetUrl>`
20
20
  : Server-relative URL where to move the folder
@@ -11,16 +11,16 @@ m365 spo folder remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site where the folder to be deleted is located
14
+ : The URL of the site where the folder to be deleted is located.
15
15
 
16
16
  `-f, --url <url>`
17
- : Site-relative URL of the folder to delete
17
+ : The server- or site-relative URL of the folder to delete.
18
18
 
19
19
  `--recycle`
20
- : Recycles the folder instead of actually deleting it
20
+ : Recycles the folder instead of actually deleting it.
21
21
 
22
22
  `--confirm`
23
- : Don't prompt for confirming deleting the folder
23
+ : Don't prompt for confirming deleting the folder.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -30,14 +30,14 @@ The `spo folder remove` command will remove folder only if it is empty. If the f
30
30
 
31
31
  ## Examples
32
32
 
33
- Removes a folder with site-relative URL _/Shared Documents/My Folder_ located in site _https://contoso.sharepoint.com/sites/project-x_
33
+ Remove a folder with a specific site-relative URL
34
34
 
35
35
  ```sh
36
36
  m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder'
37
37
  ```
38
38
 
39
- Moves a folder with site-relative URL _/Shared Documents/My Folder_ located in site _https://contoso.sharepoint.com/sites/project-x_ to the site recycle bin
39
+ Remove a folder with a specific server relative URL to the site recycle bin
40
40
 
41
41
  ```sh
42
- m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder' --recycle
42
+ m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/Shared Documents/My Folder' --recycle
43
43
  ```
@@ -11,20 +11,26 @@ m365 spo folder rename [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site where the folder to be renamed is located
14
+ : The URL of the site where the folder to be renamed is located.
15
15
 
16
16
  `-f, --url <url>`
17
- : Site-relative URL of the folder (including the folder)
17
+ : The server- or site-relative URL of the folder (including the folder).
18
18
 
19
- `-n, --name`
20
- : New name for the target folder
19
+ `-n, --name <name>`
20
+ : New name for the target folder.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
24
  ## Examples
25
25
 
26
- Renames a folder with site-relative URL _/Shared Documents/My Folder 1_ located in site _https://contoso.sharepoint.com/sites/project-x_
26
+ Renames a folder with a specific site-relative URL
27
27
 
28
28
  ```sh
29
29
  m365 spo folder rename --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder 1' --name 'My Folder 2'
30
30
  ```
31
+
32
+ Renames a folder with a specific server-relative URL
33
+
34
+ ```sh
35
+ m365 spo folder rename --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/Shared Documents/My Folder 1' --name 'My Folder 2'
36
+ ```
@@ -11,10 +11,10 @@ m365 spo folder retentionlabel ensure [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the retentionlabel from a file to apply is located
14
+ : URL of the site where the retention label from a file to apply is located
15
15
 
16
16
  `--folderUrl [folderUrl]`
17
- : The site- or server relative URL of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
17
+ : The server- or site-relative URL of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
18
18
 
19
19
  `i, --folderId [folderId]`
20
20
  : The UniqueId (GUID) of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
@@ -26,7 +26,7 @@ m365 spo folder retentionlabel ensure [options]
26
26
 
27
27
  ## Remarks
28
28
 
29
- You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retentionlabel from a listitem.
29
+ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retention label from a listitem.
30
30
 
31
31
  ## Examples
32
32
 
@@ -14,7 +14,7 @@ m365 spo folder retentionlabel remove [options]
14
14
  : The url of the web.
15
15
 
16
16
  `--folderUrl [folderUrl]`
17
- : The site- or server relative URL of the folder of which the label should be removed. Specify either `folderUrl` or `folderId` but not both.
17
+ : The server- or site-relative URL of the folder of which the label should be removed. Specify either `folderUrl` or `folderId` but not both.
18
18
 
19
19
  `-i, --folderId [folderId]`
20
20
  : The UniqueId (GUID) of the folder of which the label should be removed. Specify either `folderUrl` or `folderId` but not both.
@@ -14,7 +14,7 @@ m365 spo folder roleinheritance break [options]
14
14
  : URL of the site where the folder is located.
15
15
 
16
16
  `-f, --folderUrl <folderUrl>`
17
- : The site-relative URL or server-relative URL of the folder.
17
+ : The server- or site-relative URL of the folder.
18
18
 
19
19
  `-c, --clearExistingPermissions`
20
20
  : Clear all existing permissions from the folder.
@@ -14,7 +14,7 @@ m365 spo folder roleinheritance reset [options]
14
14
  : URL of the site where the folder is located.
15
15
 
16
16
  `-f, --folderUrl <folderUrl>`
17
- : The site-relative URL of the folder.
17
+ : The server- or site-relative URL of the folder.
18
18
 
19
19
  `--confirm`
20
20
  : Don't prompt for confirmation to reset role inheritance of the folder.
@@ -23,19 +23,19 @@ m365 spo folder roleinheritance reset [options]
23
23
 
24
24
  ## Examples
25
25
 
26
- Reset inheritance of folder with site-relative url _Shared Documents/TestFolder_ located in site _https://contoso.sharepoint.com/sites/project-x_.
26
+ Reset inheritance of folder with a specific site-relative URL
27
27
 
28
28
  ```sh
29
29
  m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
30
30
  ```
31
31
 
32
- Reset inheritance of folder with server-relative url _/sites/project-x/Shared Documents/TestFolder_ located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
32
+ Reset inheritance of folder with a specific server-relative URL. It will **not** prompt for confirmation before resetting.
33
33
 
34
34
  ```sh
35
35
  m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
36
36
  ```
37
37
 
38
- Reset inheritance of the specified root folder for the library with the server-relative url _/sites/project-x/Shared Documents located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
38
+ Reset inheritance of the specified root folder for the library with a specific server-relative URL. It will **not** prompt for confirmation before resetting.
39
39
 
40
40
  ```sh
41
41
  m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --confirm
@@ -0,0 +1,43 @@
1
+ # spo site recyclebinitem move
2
+
3
+ Moves items from the first-stage recycle bin to the second-stage recycle bin
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo site recyclebinitem move [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --siteUrl <siteUrl>`
14
+ : URL of the site where the recycle bin is located.
15
+
16
+ `-i, --ids [ids]`
17
+ : Comma separated list of item IDs. Specify either `ids` or `all` but not both.
18
+
19
+ `--all`
20
+ : Move all first-stage recycle bin items to the second-stage recycle bin. Specify either `ids` or `all` but not both.
21
+
22
+ `--confirm`
23
+ : Don't prompt for confirmation.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Move 2 specific items from the first-stage recycle bin to the second-stage
30
+
31
+ ```sh
32
+ m365 spo site recyclebinitem move --siteUrl https://contoso.sharepoint.com/sites/sales --ids "06ca4fe4-3048-4b76-bd41-296fed4c9881,d679c17b-d7b8-429a-9307-34e1d9e631e7"
33
+ ```
34
+
35
+ Move all first-stage recycle bin items to the second-stage
36
+
37
+ ```sh
38
+ m365 spo site recyclebinitem move --siteUrl https://contoso.sharepoint.com/sites/sales --all
39
+ ```
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.
@@ -0,0 +1,45 @@
1
+ # spo site recyclebinitem remove
2
+
3
+ Permanently deletes specific items from the site recycle bin
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo site recyclebinitem remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --siteUrl <siteUrl>`
14
+ : URL of the site where the recycle bin is located.
15
+
16
+ `-i, --ids <ids>`
17
+ : Comma separated list of item IDs.
18
+
19
+ `--confirm`
20
+ : Don't prompt for confirmation.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! warning
27
+ Items in the recycle bin will be permanently removed without the ability to restore them.
28
+
29
+ ## Examples
30
+
31
+ Permanently remove 2 specific items from the recycle bin
32
+
33
+ ```sh
34
+ m365 spo site recyclebinitem remove --siteUrl https://contoso.sharepoint.com/sites/sales --ids "06ca4fe4-3048-4b76-bd41-296fed4c9881,d679c17b-d7b8-429a-9307-34e1d9e631e7"
35
+ ```
36
+
37
+ Permanently remove 2 specific items from the recycle bin and skip the confirmation prompt
38
+
39
+ ```sh
40
+ m365 spo site recyclebinitem remove --siteUrl https://contoso.sharepoint.com/sites/sales --ids "06ca4fe4-3048-4b76-bd41-296fed4c9881,d679c17b-d7b8-429a-9307-34e1d9e631e7" --confirm
41
+ ```
42
+
43
+ ## Response
44
+
45
+ The command won't return a response on success.