@pnp/cli-microsoft365 6.2.0-beta.725ebd5 → 6.2.0-beta.97d58e0

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 (79) hide show
  1. package/dist/m365/context/commands/option/option-remove.js +105 -0
  2. package/dist/m365/context/commands/option/option-set.js +84 -0
  3. package/dist/m365/context/commands.js +2 -0
  4. package/dist/m365/onenote/commands/page/page-list.js +137 -0
  5. package/dist/m365/onenote/commands.js +2 -1
  6. package/dist/m365/planner/commands/bucket/bucket-add.js +0 -6
  7. package/dist/m365/planner/commands/bucket/bucket-get.js +0 -6
  8. package/dist/m365/planner/commands/bucket/bucket-list.js +0 -6
  9. package/dist/m365/planner/commands/bucket/bucket-remove.js +0 -6
  10. package/dist/m365/planner/commands/bucket/bucket-set.js +0 -6
  11. package/dist/m365/planner/commands/plan/plan-add.js +0 -6
  12. package/dist/m365/planner/commands/plan/plan-get.js +0 -6
  13. package/dist/m365/planner/commands/plan/plan-list.js +0 -6
  14. package/dist/m365/planner/commands/plan/plan-remove.js +0 -6
  15. package/dist/m365/planner/commands/plan/plan-set.js +0 -6
  16. package/dist/m365/planner/commands/task/task-add.js +0 -6
  17. package/dist/m365/planner/commands/task/task-checklistitem-add.js +0 -6
  18. package/dist/m365/planner/commands/task/task-checklistitem-list.js +0 -6
  19. package/dist/m365/planner/commands/task/task-get.js +0 -6
  20. package/dist/m365/planner/commands/task/task-list.js +0 -6
  21. package/dist/m365/planner/commands/task/task-reference-list.js +0 -6
  22. package/dist/m365/planner/commands/task/task-set.js +0 -6
  23. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +110 -0
  24. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +130 -0
  25. package/dist/m365/pp/commands/solution/solution-publish.js +156 -0
  26. package/dist/m365/pp/commands.js +3 -0
  27. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
  28. package/dist/m365/purview/commands.js +1 -0
  29. package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +121 -0
  30. package/dist/m365/spo/commands/file/file-retentionlabel-remove.js +141 -0
  31. package/dist/m365/spo/commands/file/file-sharinglink-add.js +141 -0
  32. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  33. package/dist/m365/spo/commands/file/file-sharinglink-list.js +19 -6
  34. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  35. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +138 -0
  36. package/dist/m365/spo/commands/folder/folder-retentionlabel-remove.js +157 -0
  37. package/dist/m365/spo/commands/group/group-member-add.js +33 -6
  38. package/dist/m365/spo/commands/list/list-add.js +3 -0
  39. package/dist/m365/spo/commands/list/list-retentionlabel-remove.js +146 -0
  40. package/dist/m365/spo/commands/list/list-set.js +3 -0
  41. package/dist/m365/spo/commands/listitem/listitem-list.js +1 -1
  42. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +2 -2
  43. package/dist/m365/spo/commands/term/term-list.js +99 -29
  44. package/dist/m365/spo/commands.js +8 -0
  45. package/dist/m365/teams/commands/message/message-send.js +81 -0
  46. package/dist/m365/teams/commands.js +1 -0
  47. package/dist/utils/formatting.js +22 -0
  48. package/docs/docs/cmd/aad/app/app-remove.md +11 -7
  49. package/docs/docs/cmd/context/option/option-remove.md +37 -0
  50. package/docs/docs/cmd/context/option/option-set.md +31 -0
  51. package/docs/docs/cmd/onenote/page/page-list.md +140 -0
  52. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +99 -0
  53. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md +53 -0
  54. package/docs/docs/cmd/pp/solution/solution-publish.md +52 -0
  55. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
  56. package/docs/docs/cmd/spo/cdn/cdn-get.md +1 -1
  57. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +1 -1
  58. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +1 -1
  59. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +1 -1
  60. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +1 -1
  61. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +1 -1
  62. package/docs/docs/cmd/spo/cdn/cdn-set.md +1 -1
  63. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +47 -0
  64. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.md +43 -0
  65. package/docs/docs/cmd/spo/file/file-sharinglink-add.md +89 -0
  66. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  67. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +16 -7
  68. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  69. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.md +47 -0
  70. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.md +43 -0
  71. package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
  72. package/docs/docs/cmd/spo/list/list-add.md +3 -9
  73. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +52 -0
  74. package/docs/docs/cmd/spo/list/list-set.md +3 -3
  75. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -12
  76. package/docs/docs/cmd/spo/listitem/listitem-list.md +5 -5
  77. package/docs/docs/cmd/spo/term/term-list.md +138 -0
  78. package/docs/docs/cmd/teams/message/message-send.md +119 -0
  79. package/package.json +1 -1
@@ -0,0 +1,89 @@
1
+ # spo file sharinglink add
2
+
3
+ Creates a new sharing link for a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink add [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
+ `--type <type>`
23
+ : The type of sharing link to create. Either `view` or `edit`.
24
+
25
+ `--expirationDateTime [expirationDateTime]`
26
+ : The date and time to set the expiration. This should be defined as a valid ISO 8601 string.
27
+
28
+ `--scope [scope]`
29
+ : The scope of link to create. Either `anonymous` or `organization`. If not specified, the default of the organization will be used.
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Examples
34
+
35
+ Creates a sharing link of a specific type for a file by id
36
+
37
+ ```sh
38
+ m365 spo file sharinglink add --webUrl https://contoso.sharepoint.com --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --type view
39
+ ```
40
+
41
+ Creates a sharing link of a specific type for a file by url
42
+
43
+ ```sh
44
+ m365 spo file sharinglink add --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Test1.docx" --type edit
45
+ ```
46
+
47
+ Creates a sharing link of a file by url with type, scope and expirationDateTime parameter
48
+
49
+ ```sh
50
+ m365 spo file sharinglink add --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Test1.docx" --type edit --scope anonymous --expirationDateTime "2023-01-09T16:20:00Z"
51
+ ```
52
+
53
+ ## Response
54
+
55
+ === "JSON"
56
+
57
+ ```json
58
+ {
59
+ "id": "1e581e93-609e-4077-8152-c43865db684c",
60
+ "roles": [
61
+ "read"
62
+ ],
63
+ "expirationDateTime": "2023-10-01T07:00:00Z",
64
+ "hasPassword": false,
65
+ "link": {
66
+ "scope": "anonymous",
67
+ "type": "view",
68
+ "webUrl": "https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBSyMcgRPtyAxqqNAeiEp1kg",
69
+ "preventsDownload": false
70
+ }
71
+ }
72
+ ```
73
+
74
+ === "Text"
75
+
76
+ ```text
77
+ hasPassword : false
78
+ expirationDateTime: 2023-10-01T07:00:00Z
79
+ id : 1e581e93-609e-4077-8152-c43865db684c
80
+ link : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBSyMcgRPtyAxqqNAeiEp1kg","preventsDownload":false}
81
+ roles : ["read"]
82
+ ```
83
+
84
+ === "CSV"
85
+
86
+ ```csv
87
+ id,expirationDateTime,roles,hasPassword,link
88
+ 1e581e93-609e-4077-8152-c43865db684c,2023-10-01T07:00:00Z,"[""read""]",,"{""scope"":""anonymous"",""type"":""view"",""webUrl"":""https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBSyMcgRPtyAxqqNAeiEp1kg"",""preventsDownload"":false}"
89
+ ```
@@ -0,0 +1,107 @@
1
+ # spo file sharinglink get
2
+
3
+ Gets details about a specific sharing link of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink get [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
+ `-i, --id <id>`
23
+ : The ID of the sharing link.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Gets a specific sharing link of a file by id.
30
+
31
+ ```sh
32
+ m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 1ba739c5-e693-4c16-9dfa-042e4ec62972
33
+ ```
34
+
35
+ Gets a specific sharing link of a file by a specified site-relative URL.
36
+
37
+ ```sh
38
+ m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileUrl 'Shared Documents/document.docx' --id 1ba739c5-e693-4c16-9dfa-042e4ec62972
39
+ ```
40
+
41
+ Gets a specific sharing link of a file by a specified server-relative URL.
42
+
43
+ ```sh
44
+ m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileUrl '/sites/demo/Shared Documents/document.docx' --id 1ba739c5-e693-4c16-9dfa-042e4ec62972
45
+ ```
46
+
47
+ ## Response
48
+
49
+ === "JSON"
50
+
51
+ ```json
52
+ {
53
+ "id": "1ba739c5-e693-4c16-9dfa-042e4ec62972",
54
+ "roles": [
55
+ "write"
56
+ ],
57
+ "hasPassword": false,
58
+ "grantedToIdentitiesV2": [
59
+ {
60
+ "user": {
61
+ "displayName": "John Doe",
62
+ "email": "john@contoso.onmicrosoft.com",
63
+ "id": "04355ecd-2124-4097-bc2b-c2295a71d7a3"
64
+ },
65
+ "siteUser": {
66
+ "displayName": "John Doe",
67
+ "email": "john@contoso.onmicrosoft.com",
68
+ "id": "11",
69
+ "loginName": "i:0#.f|membership|john@contoso.onmicrosoft.com"
70
+ }
71
+ }
72
+ ],
73
+ "grantedToIdentities": [
74
+ {
75
+ "user": {
76
+ "displayName": "John Doe",
77
+ "email": "john@contoso.onmicrosoft.com",
78
+ "id": "04355ecd-2124-4097-bc2b-c2295a71d7a3"
79
+ }
80
+ }
81
+ ],
82
+ "link": {
83
+ "scope": "organization",
84
+ "type": "edit",
85
+ "webUrl": "https://contoso.sharepoint.com/:w:/s/demo/EecoJa3lri9Hu9NWp-W0aBQB8ZqmGqA5tdIiaab4o-6BZw",
86
+ "preventsDownload": false
87
+ }
88
+ }
89
+ ```
90
+
91
+ === "Text"
92
+
93
+ ```text
94
+ grantedToIdentities : [{"user":{"displayName":"John Doe","email":"john@contoso.onmicrosoft.com","id":"04355ecd-2124-4097-bc2b-c2295a71d7a3"}}]
95
+ grantedToIdentitiesV2: [{"user":{"displayName":"John Doe","email":"john@contoso.onmicrosoft.com","id":"04355ecd-2124-4097-bc2b-c2295a71d7a3"},"siteUser":{"displayName":"John Doe","email":"john@contoso.onmicrosoft.com","id":"11","loginName":"i:0#.f|membership|john@contoso.onmicrosoft.com"}}]
96
+ hasPassword : false
97
+ id : 1ba739c5-e693-4c16-9dfa-042e4ec62972
98
+ link : {"scope":"organization","type":"edit","webUrl":"https://contoso.sharepoint.com/:w:/s/demo/EecoJa3lri9Hu9NWp-W0aBQB8ZqmGqA5tdIiaab4o-6BZw","preventsDownload":false}
99
+ roles : ["write"]
100
+ ```
101
+
102
+ === "CSV"
103
+
104
+ ```csv
105
+ id,roles,hasPassword,grantedToIdentitiesV2,grantedToIdentities,link
106
+ 1ba739c5-e693-4c16-9dfa-042e4ec62972,"[""write""]",,"[{""user"":{""displayName"":""John Doe"",""email"":""john@contoso.onmicrosoft.com"",""id"":""04355ecd-2124-4097-bc2b-c2295a71d7a3""},""siteUser"":{""displayName"":""John Doe"",""email"":""john@contoso.onmicrosoft.com"",""id"":""11"",""loginName"":""i:0#.f|membership|john@contoso.onmicrosoft.com""}}]","[{""user"":{""displayName"":""John Doe"",""email"":""john@contoso.onmicrosoft.com"",""id"":""04355ecd-2124-4097-bc2b-c2295a71d7a3""}}]","{""scope"":""organization"",""type"":""edit"",""webUrl"":""https://contoso.sharepoint.com/:w:/s/demo/EecoJa3lri9Hu9NWp-W0aBQB8ZqmGqA5tdIiaab4o-6BZw"",""preventsDownload"":false}"
107
+ ```
@@ -13,12 +13,15 @@ m365 spo file sharinglink list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : The URL of the site where the file is located.
15
15
 
16
- `-f, --fileUrl [fileUrl]`
16
+ `--fileUrl [fileUrl]`
17
17
  : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
18
 
19
- `-i, --fileId [fileId]`
19
+ `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
+ `--scope [scope]`
23
+ : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
24
+
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
@@ -35,6 +38,12 @@ List sharing links of a file by url
35
38
  m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx"
36
39
  ```
37
40
 
41
+ List anonymous sharing links of a file by url
42
+
43
+ ```sh
44
+ m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx" --scope anonymous
45
+ ```
46
+
38
47
  ## Response
39
48
 
40
49
  === "JSON"
@@ -84,14 +93,14 @@ m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/dem
84
93
  === "Text"
85
94
 
86
95
  ```text
87
- id roles link
88
- ------------------------------------ ----- -----------------------------------------------------------------------------------------------------------
89
- 2a021f54-90a2-4016-b3b3-5f34d2e7d932 read https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
96
+ id scope roles link
97
+ ------------------------------------ ------------ ----- ----------------------------------------------------------------------------------------
98
+ 2a021f54-90a2-4016-b3b3-5f34d2e7d932 organization read https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
90
99
  ```
91
100
 
92
101
  === "CSV"
93
102
 
94
103
  ```csv
95
- id,roles,link
96
- 2a021f54-90a2-4016-b3b3-5f34d2e7d932,read,https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
104
+ id,scope,roles,link
105
+ 2a021f54-90a2-4016-b3b3-5f34d2e7d932,organization,read,https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
97
106
  ```
@@ -0,0 +1,52 @@
1
+ # spo file sharinglink remove
2
+
3
+ Removes a specific sharing link of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink remove [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
+ `-i, --id <id>`
23
+ : The ID of the sharing link.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes a specific sharing link from a file by id without prompting for confirmation.
33
+
34
+ ```sh
35
+ m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id c391b57d-5783-4c53-9236-cefb5c6ef323 --confirm
36
+ ```
37
+
38
+ Removes a specific sharing link from a file by a specified site-relative URL.
39
+
40
+ ```sh
41
+ m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl 'Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
42
+ ```
43
+
44
+ Removes a specific sharing link from a file by a specified server-relative URL.
45
+
46
+ ```sh
47
+ m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
48
+ ```
49
+
50
+ ## Response
51
+
52
+ The command won't return a response on success.
@@ -0,0 +1,47 @@
1
+ # spo folder retentionlabel ensure
2
+
3
+ Apply a retention label to a folder
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo folder retentionlabel ensure [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the retentionlabel from a file to apply is located
15
+
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.
18
+
19
+ `i, --folderId [folderId]`
20
+ : The UniqueId (GUID) of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
21
+
22
+ `--name <name>`
23
+ : Name of the retention label to apply to the folder.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retentionlabel from a listitem.
30
+
31
+ ## Examples
32
+
33
+ Applies a retention label to a folder based on the label name and the folderUrl
34
+
35
+ ```sh
36
+ m365 spo folder retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl '/Shared Documents' --name 'Some label'
37
+ ```
38
+
39
+ Applies a retention label to a folder based on the label name and the folderId
40
+
41
+ ```sh
42
+ m365 spo folder retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --folderId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
43
+ ```
44
+
45
+ ## Response
46
+
47
+ The command won't return a response on success.
@@ -0,0 +1,43 @@
1
+ # spo folder retentionlabel remove
2
+
3
+ Clears the retention label from a folder
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo folder retentionlabel remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The url of the web.
15
+
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.
18
+
19
+ `-i, --folderId [folderId]`
20
+ : The UniqueId (GUID) of the folder of which the label should be removed. Specify either `folderUrl` or `folderId` but not both.
21
+
22
+ `--confirm`
23
+ : Don't prompt for confirming to remove the label.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Removes the retention label from a folder in a given site based on the folder id
30
+
31
+ ```sh
32
+ m365 spo folder retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderId 0cd891ef-afce-4e55-b836-fce03286cccf
33
+ ```
34
+
35
+ Removes the retention label from a folder in a given site based on the folder url
36
+
37
+ ```sh
38
+ m365 spo folder retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl /sites/project-x/Shared Documents/Folder --id 1
39
+ ```
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.
@@ -20,19 +20,25 @@ m365 spo group member add [options]
20
20
  : Name of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`
21
21
 
22
22
  `--userName [userName]`
23
- : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
23
+ : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
24
24
 
25
25
  `--email [email]`
26
- : User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
26
+ : User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
27
27
 
28
28
  `--userId [userId]`
29
- : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Id's have to be comma separated. Specify either `userName`, `email` or `userId`
29
+ : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
30
+
31
+ `--aadGroupId [aadGroupId]`
32
+ : The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
33
+
34
+ `--aadGroupName [aadGroupName]`
35
+ : The name of the Azure AD group to add as a member. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
30
36
 
31
37
  --8<-- "docs/cmd/_global.md"
32
38
 
33
39
  ## Remarks
34
40
 
35
- For the `--userName` or `--email` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list invalid values.
41
+ For the `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list of invalid values.
36
42
 
37
43
  ## Examples
38
44
 
@@ -72,6 +78,18 @@ Add multiple users with the userId parameter to a SharePoint group with the grou
72
78
  m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId "5,12"
73
79
  ```
74
80
 
81
+ Add multiple users with the aadUserId parameter to a SharePoint group with the groupId parameter
82
+
83
+ ```sh
84
+ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserId "56ca9023-3449-4e98-a96a-69e81a6f4983,a96c1755-8aec-4f4d-955f-08504510dc56"
85
+ ```
86
+
87
+ Add multiple users with the aadUserName parameter to a SharePoint group with the groupId parameter
88
+
89
+ ```sh
90
+ m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserName "Azure group one, Azure group two"
91
+ ```
92
+
75
93
  ## Response
76
94
 
77
95
  === "JSON"
@@ -25,9 +25,6 @@ m365 spo list add [options]
25
25
  `--templateFeatureId [templateFeatureId]`
26
26
  : The globally unique identifier (GUID) of a template feature that is associated with the list
27
27
 
28
- `--schemaXml [schemaXml]`
29
- : The schema in Collaborative Application Markup Language (CAML) schemas that defines the list
30
-
31
28
  `--allowDeletion [allowDeletion]`
32
29
  : Boolean value specifying whether the list can be deleted. Valid values are `true,false`
33
30
 
@@ -199,6 +196,9 @@ m365 spo list add [options]
199
196
  `--writeSecurity [writeSecurity]`
200
197
  : Gets or sets the Write security setting for the list. Valid values are 1 (All users can modify all items)|2 (Users can modify only items that they create)|4 (Users cannot modify any list item)
201
198
 
199
+ `--schemaXml [schemaXml]`
200
+ : (deprecated) The schema in Collaborative Application Markup Language (CAML) schemas that defines the list
201
+
202
202
  --8<-- "docs/cmd/_global.md"
203
203
 
204
204
  ## Examples
@@ -209,12 +209,6 @@ Add a list with title _Announcements_ and baseTemplate _Announcements_ in site _
209
209
  m365 spo list add --title Announcements --baseTemplate Announcements --webUrl https://contoso.sharepoint.com/sites/project-x
210
210
  ```
211
211
 
212
- Add a list with title _Announcements_, baseTemplate _Announcements_ in site _https://contoso.sharepoint.com/sites/project-x_ using a custom XML schema
213
-
214
- ```sh
215
- m365 spo list add --title Announcements --baseTemplate Announcements --webUrl https://contoso.sharepoint.com/sites/project-x --schemaXml '<List xmlns:ows="Microsoft SharePoint" Title="List1" FolderCreation="FALSE" Direction="$Resources:Direction;" Url="Lists/List1" BaseType="0" xmlns="http://schemas.microsoft.com/sharepoint/"><MetaData><ContentTypes><ContentTypeRef ID="0x01"><Folder TargetName="Item" /></ContentTypeRef><ContentTypeRef ID="0x0120" /></ContentTypes><Fields><Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="$Resources:core,Title;" Required="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" MaxLength="255" /></Fields><Views><View BaseViewID="0" Type="HTML" MobileView="TRUE" TabularView="FALSE"><Toolbar Type="Standard" /><XslLink Default="TRUE">main.xsl</XslLink><RowLimit Paged="TRUE">30</RowLimit><ViewFields><FieldRef Name="LinkTitleNoMenu"></FieldRef></ViewFields><Query><OrderBy><FieldRef Name="Modified" Ascending="FALSE"></FieldRef></OrderBy></Query><ParameterBindings><ParameterBinding Name="AddNewAnnouncement" Location="Resource(wss,addnewitem)" /><ParameterBinding Name="NoAnnouncements" Location="Resource(wss,noXinviewofY_LIST)" /><ParameterBinding Name="NoAnnouncementsHowTo" Location="Resource(wss,noXinviewofY_ONET_HOME)" /></ParameterBindings></View><View BaseViewID="1" Type="HTML" WebPartZoneID="Main" DisplayName="$Resources:core,objectiv_schema_mwsidcamlidC24;" DefaultView="TRUE" MobileView="TRUE" MobileDefaultView="TRUE" SetupPath="pages\viewpage.aspx" ImageUrl="/_layouts/15/images/generic.png?rev=23" Url="AllItems.aspx"><Toolbar Type="Standard" /><XslLink Default="TRUE">main.xsl</XslLink><JSLink>clienttemplates.js</JSLink><RowLimit Paged="TRUE">30</RowLimit><ViewFields><FieldRef Name="LinkTitle"></FieldRef></ViewFields><Query><OrderBy><FieldRef Name="ID"></FieldRef></OrderBy></Query><ParameterBindings><ParameterBinding Name="NoAnnouncements" Location="Resource(wss,noXinviewofY_LIST)" /><ParameterBinding Name="NoAnnouncementsHowTo" Location="Resource(wss,noXinviewofY_DEFAULT)" /></ParameterBindings></View></Views><Forms><Form Type="DisplayForm" Url="DispForm.aspx" SetupPath="pages\form.aspx" WebPartZoneID="Main" /><Form Type="EditForm" Url="EditForm.aspx" SetupPath="pages\form.aspx" WebPartZoneID="Main" /><Form Type="NewForm" Url="NewForm.aspx" SetupPath="pages\form.aspx" WebPartZoneID="Main" /></Forms></MetaData></List>'
216
- ```
217
-
218
212
  Add a list with title _Announcements_, baseTemplate _Announcements_ in site _https://contoso.sharepoint.com/sites/project-x_ with content types and versioning enabled and major version limit set to _50_
219
213
 
220
214
  ```sh
@@ -0,0 +1,52 @@
1
+ # spo list retentionlabel remove
2
+
3
+ Clears the retention label on the specified list or library.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo list retentionlabel remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the list is located.
15
+
16
+ `-t, --listTitle [listTitle]`
17
+ : The title of the list on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
18
+
19
+ `-i, --listId [listId]`
20
+ : The ID of the list on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
21
+
22
+ `-l, --listUrl [listUrl]`
23
+ : Server- or web-relative URL of the list on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Clears the retention label on a given list by URL
33
+
34
+ ```sh
35
+ m365 spo list retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents'
36
+ ```
37
+
38
+ Clears the retention label on a given list by title
39
+
40
+ ```sh
41
+ m365 spo list retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents'
42
+ ```
43
+
44
+ Clears the retention label on a given list by ID without confirmation
45
+
46
+ ```sh
47
+ m365 spo list retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 'Documents' --confirm
48
+ ```
49
+
50
+ ## Response
51
+
52
+ The command won't return a response on success.
@@ -178,9 +178,6 @@ m365 spo list set [options]
178
178
  `--restrictUserUpdates [restrictUserUpdates]`
179
179
  : A boolean value that indicates whether the this list is a restricted one or not The value can't be changed if there are existing items in the list
180
180
 
181
- `--schemaXml [schemaXml]`
182
- : The schema in Collaborative Application Markup Language (CAML) schemas that defines the list
183
-
184
181
  `--sendToLocationName [sendToLocationName]`
185
182
  : Gets or sets a file name to use when copying an item in the list to another document library.
186
183
 
@@ -205,6 +202,9 @@ m365 spo list set [options]
205
202
  `--writeSecurity [writeSecurity]`
206
203
  : Gets or sets the Write security setting for the list. Valid values are 1 (All users can modify all items)|2 (Users can modify only items that they create)|4 (Users cannot modify any list item)
207
204
 
205
+ `--schemaXml [schemaXml]`
206
+ : (deprecated) The schema in Collaborative Application Markup Language (CAML) schemas that defines the list
207
+
208
208
  --8<-- "docs/cmd/_global.md"
209
209
 
210
210
  ## Examples
@@ -11,25 +11,25 @@ m365 spo listitem get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site from which the item should be retrieved
14
+ : URL of the site where the item is located.
15
15
 
16
16
  `-i, --id <id>`
17
17
  : ID of the item to retrieve.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
20
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
23
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
24
24
 
25
25
  `--listUrl [listUrl]`
26
- : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
27
27
 
28
28
  `-p, --properties [properties]`
29
- : Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested
29
+ : Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested.
30
30
 
31
31
  `--withPermissions`
32
- : Set if you want to return associated roles and permissions
32
+ : Set if you want to return associated roles and permissions.
33
33
 
34
34
  --8<-- "docs/cmd/_global.md"
35
35
 
@@ -39,37 +39,36 @@ If you want to specify a lookup type in the `properties` option, define which co
39
39
 
40
40
  ## Examples
41
41
 
42
- Get an item with the ID parameter from a given list in a given site
42
+ Get an item with the ID parameter from a given list in a given site.
43
43
 
44
44
  ```sh
45
45
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
46
46
  ```
47
47
 
48
- Get an item columns with the ID parameter from a given list in a given site
48
+ Get an item columns with the ID parameter from a given list in a given site.
49
49
 
50
50
  ```sh
51
51
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created"
52
52
  ```
53
53
 
54
- Get an item columns and lookup column with the ID parameter from a given list in a given site
54
+ Get an item columns and lookup column with the ID parameter from a given list in a given site.
55
55
 
56
56
  ```sh
57
57
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
58
58
  ```
59
59
 
60
- Get an item with specific properties from a given list based on the server-relative URL in a specific site
60
+ Get an item with specific properties from a given list based on the server-relative URL in a specific site.
61
61
 
62
62
  ```sh
63
63
  m365 spo listitem get --listUrl /sites/project-x/documents --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
64
64
  ```
65
65
 
66
- Get an item with ID parameter from a given list based on the server-relative URL in a specific site with permissions
66
+ Get an item with ID parameter from a given list based on the server-relative URL in a specific site with permissions.
67
67
 
68
68
  ```sh
69
69
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --withPermissions
70
70
  ```
71
71
 
72
-
73
72
  ## Response
74
73
 
75
74
  === "JSON"
@@ -13,14 +13,14 @@ m365 spo listitem list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site from which the item should be retrieved.
15
15
 
16
- `-i, --listId [listId]`
17
- : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both.
18
-
19
16
  `-l, --listId [listId]`
20
- : ID of the list where the item should be added. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
17
+ : ID of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
21
18
 
22
19
  `-t, --listTitle [listTitle]`
23
- : Title of the list where the item should be added. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
20
+ : Title of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
24
24
 
25
25
  `-q, --camlQuery [camlQuery]`
26
26
  : CAML query to use to query the list of items with.