@pnp/cli-microsoft365 6.2.0-beta.e162995 → 6.2.0-beta.ed6bb7b

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 (81) hide show
  1. package/.eslintrc.js +6 -0
  2. package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +3 -0
  3. package/dist/m365/onenote/commands/page/page-list.js +137 -0
  4. package/dist/m365/onenote/commands.js +2 -1
  5. package/dist/m365/planner/commands/bucket/bucket-add.js +0 -6
  6. package/dist/m365/planner/commands/bucket/bucket-get.js +0 -6
  7. package/dist/m365/planner/commands/bucket/bucket-list.js +0 -6
  8. package/dist/m365/planner/commands/bucket/bucket-remove.js +0 -6
  9. package/dist/m365/planner/commands/bucket/bucket-set.js +0 -6
  10. package/dist/m365/planner/commands/plan/plan-add.js +0 -6
  11. package/dist/m365/planner/commands/plan/plan-get.js +0 -6
  12. package/dist/m365/planner/commands/plan/plan-list.js +0 -6
  13. package/dist/m365/planner/commands/plan/plan-remove.js +0 -6
  14. package/dist/m365/planner/commands/plan/plan-set.js +0 -6
  15. package/dist/m365/planner/commands/task/task-add.js +0 -6
  16. package/dist/m365/planner/commands/task/task-checklistitem-add.js +0 -6
  17. package/dist/m365/planner/commands/task/task-checklistitem-list.js +0 -6
  18. package/dist/m365/planner/commands/task/task-get.js +0 -6
  19. package/dist/m365/planner/commands/task/task-list.js +0 -6
  20. package/dist/m365/planner/commands/task/task-reference-list.js +0 -6
  21. package/dist/m365/planner/commands/task/task-set.js +0 -6
  22. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +110 -0
  23. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +68 -0
  24. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +130 -0
  25. package/dist/m365/pp/commands.js +3 -0
  26. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
  27. package/dist/m365/purview/commands.js +1 -0
  28. package/dist/m365/spo/commands/file/GraphFileDetails.js +3 -0
  29. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +12 -12
  30. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  31. package/dist/m365/spo/commands/file/file-sharinglink-list.js +133 -0
  32. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  33. package/dist/m365/spo/commands/group/group-member-add.js +33 -6
  34. package/dist/m365/spo/commands/group/group-member-remove.js +78 -33
  35. package/dist/m365/spo/commands/list/list-add.js +3 -0
  36. package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +10 -2
  37. package/dist/m365/spo/commands/list/list-set.js +3 -0
  38. package/dist/m365/spo/commands/listitem/ListItemRetentionLabel.js +3 -0
  39. package/dist/m365/spo/commands/listitem/SiteRetentionLabel.js +3 -0
  40. package/dist/m365/spo/commands/listitem/listitem-list.js +1 -1
  41. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +161 -0
  42. package/dist/m365/spo/commands/term/term-list.js +99 -29
  43. package/dist/m365/spo/commands.js +4 -0
  44. package/dist/m365/teams/commands/chat/chat-list.js +29 -7
  45. package/dist/m365/teams/commands/message/message-send.js +81 -0
  46. package/dist/m365/teams/commands.js +1 -0
  47. package/docs/docs/cmd/onenote/page/page-list.md +140 -0
  48. package/docs/docs/cmd/planner/bucket/bucket-add.md +17 -0
  49. package/docs/docs/cmd/planner/bucket/bucket-get.md +17 -0
  50. package/docs/docs/cmd/planner/bucket/bucket-list.md +17 -0
  51. package/docs/docs/cmd/planner/plan/plan-add.md +40 -0
  52. package/docs/docs/cmd/planner/plan/plan-get.md +21 -0
  53. package/docs/docs/cmd/planner/plan/plan-list.md +19 -0
  54. package/docs/docs/cmd/planner/plan/plan-set.md +20 -0
  55. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +99 -0
  56. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +95 -0
  57. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md +53 -0
  58. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
  59. package/docs/docs/cmd/spo/cdn/cdn-get.md +1 -1
  60. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +1 -1
  61. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +1 -1
  62. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +1 -1
  63. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +1 -1
  64. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +1 -1
  65. package/docs/docs/cmd/spo/cdn/cdn-set.md +1 -1
  66. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  67. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +106 -0
  68. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  69. package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
  70. package/docs/docs/cmd/spo/group/group-member-remove.md +24 -6
  71. package/docs/docs/cmd/spo/list/list-add.md +3 -9
  72. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +8 -5
  73. package/docs/docs/cmd/spo/list/list-set.md +3 -3
  74. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -12
  75. package/docs/docs/cmd/spo/listitem/listitem-list.md +5 -5
  76. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +58 -0
  77. package/docs/docs/cmd/spo/term/term-list.md +138 -0
  78. package/docs/docs/cmd/teams/chat/chat-list.md +16 -4
  79. package/docs/docs/cmd/teams/message/message-send.md +119 -0
  80. package/npm-shrinkwrap.json +182 -202
  81. package/package.json +12 -11
@@ -0,0 +1,128 @@
1
+ # purview retentionlabel add
2
+
3
+ Create a retention label
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentionlabel add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --displayName <displayName>`
14
+ : The display name of the label.
15
+
16
+ `--behaviorDuringRetentionPeriod <behaviorDuringRetentionPeriod>`
17
+ : Specifies how the behavior of a document with this label should be during the retention period. Allowed values: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`.
18
+
19
+ `--actionAfterRetentionPeriod <actionAfterRetentionPeriod>`
20
+ : Specifies the action to take on a document with this label applied after the retention period. Allowed values: `none`, `delete`, `startDispositionReview`.
21
+
22
+ `--retentionDuration <retentionDuration>`
23
+ : The number of days to retain the content.
24
+
25
+ `-t, --retentionTrigger [retentionTrigger]`
26
+ : Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. Allowed values: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`. Defaults to `dateLabeled`.
27
+
28
+ `--defaultRecordBehavior [defaultRecordBehavior]`
29
+ : Specifies the locked or unlocked state of a record label when it is created. Allowed values: `startLocked`, `startUnlocked`, Defaults to `startLocked`.
30
+
31
+ `--descriptionForUsers [descriptionForUsers]`
32
+ : The label information for the user.
33
+
34
+ `--descriptionForAdmins [descriptionForAdmins]`
35
+ : The label information for the admin.
36
+
37
+ `--labelToBeApplied [labelToBeApplied]`
38
+ : Specifies the replacement label to be applied automatically after the retention period of the current label ends.
39
+
40
+ --8<-- "docs/cmd/_global.md"
41
+
42
+ ## Examples
43
+
44
+ Create a retention label that retains documents and deletes them after one year.
45
+
46
+ ```sh
47
+ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365
48
+ ```
49
+
50
+ Create a retention label that retains documents as records and does not take any action one year after the last modification date.
51
+
52
+ ```sh
53
+ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod none --retentionDuration 365 --retentionTrigger dateModified
54
+ ```
55
+
56
+ ## Remarks
57
+
58
+ !!! attention
59
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
60
+
61
+ ## More information
62
+
63
+ - Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
64
+
65
+ ## Response
66
+
67
+ === "JSON"
68
+
69
+ ```json
70
+ {
71
+ "displayName": "some label",
72
+ "descriptionForAdmins": "Description for admins",
73
+ "descriptionForUsers": "Description for users",
74
+ "isInUse": false,
75
+ "retentionTrigger": "dateLabeled",
76
+ "behaviorDuringRetentionPeriod": "retain",
77
+ "actionAfterRetentionPeriod": "delete",
78
+ "createdDateTime": "2022-12-21T09:28:37Z",
79
+ "lastModifiedDateTime": "2022-12-21T09:28:37Z",
80
+ "labelToBeApplied": "another label",
81
+ "defaultRecordBehavior": "startLocked",
82
+ "id": "f7e05955-210b-4a8e-a5de-3c64cfa6d9be",
83
+ "retentionDuration": {
84
+ "days": 365
85
+ },
86
+ "createdBy": {
87
+ "user": {
88
+ "id": null,
89
+ "displayName": "John Doe"
90
+ }
91
+ },
92
+ "lastModifiedBy": {
93
+ "user": {
94
+ "id": null,
95
+ "displayName": "John Doe"
96
+ }
97
+ },
98
+ "dispositionReviewStages": []
99
+ }
100
+ ```
101
+
102
+ === "Text"
103
+
104
+ ```text
105
+ actionAfterRetentionPeriod : delete
106
+ behaviorDuringRetentionPeriod: retain
107
+ createdBy : {"user":{"id":null,"displayName":"John Doe"}}
108
+ createdDateTime : 2022-12-21T09:32:38Z
109
+ defaultRecordBehavior : startLocked
110
+ descriptionForAdmins : Description for admins
111
+ descriptionForUsers : Description for users
112
+ displayName : some label
113
+ dispositionReviewStages : []
114
+ id : 3b388f3c-541b-4696-ad0e-83f960695d89
115
+ isInUse : false
116
+ labelToBeApplied : another label
117
+ lastModifiedBy : {"user":{"id":null,"displayName":"John Doe"}}
118
+ lastModifiedDateTime : 2022-12-21T09:32:38Z
119
+ retentionDuration : {"days":365}
120
+ retentionTrigger : dateLabeled
121
+ ```
122
+
123
+ === "CSV"
124
+
125
+ ```csv
126
+ displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
127
+ some label,Description for admins,Description for users,,dateLabeled,retain,delete,2022-12-21T09:33:32Z,2022-12-21T09:33:32Z,another label,startLocked,cfc8b132-7aef-45f4-9fcf-3c199090ba2a,"{""days"":365}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
128
+ ```
@@ -38,4 +38,4 @@ m365 spo cdn get --type Private
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -35,4 +35,4 @@ m365 spo cdn origin add --type Public --origin */CDN
35
35
 
36
36
  ## More information
37
37
 
38
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
38
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn origin list --type Private
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn origin remove --type Public --origin */CDN
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn policy list --cdnType Private
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -38,4 +38,4 @@ m365 spo cdn policy set --cdnType Public --policy IncludeFileExtensions --value
38
38
 
39
39
  ## More information
40
40
 
41
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
41
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -66,4 +66,4 @@ m365 spo cdn set --type Both --enabled true --noDefaultOrigins
66
66
 
67
67
  ## More information
68
68
 
69
- - General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
69
+ - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)
@@ -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
+ ```
@@ -0,0 +1,106 @@
1
+ # spo file sharinglink list
2
+
3
+ Lists all the sharing links of a specific file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `-f, --fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `-i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
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
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ List sharing links of a file by id
30
+
31
+ ```sh
32
+ m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234
33
+ ```
34
+
35
+ List sharing links of a file by url
36
+
37
+ ```sh
38
+ m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx"
39
+ ```
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
+
47
+ ## Response
48
+
49
+ === "JSON"
50
+
51
+ ```json
52
+ [
53
+ {
54
+ "id": "2a021f54-90a2-4016-b3b3-5f34d2e7d932",
55
+ "roles": [
56
+ "read"
57
+ ],
58
+ "hasPassword": false,
59
+ "grantedToIdentitiesV2": [
60
+ {
61
+ "user": {
62
+ "displayName": "John Doe",
63
+ "email": "john@contoso.onmicrosoft.com",
64
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
65
+ },
66
+ "siteUser": {
67
+ "displayName": "John Doe",
68
+ "email": "john@contoso.onmicrosoft.com",
69
+ "id": "9",
70
+ "loginName": "i:0#.f|membership|john@contoso.onmicrosoft.com"
71
+ }
72
+ }
73
+ ],
74
+ "grantedToIdentities": [
75
+ {
76
+ "user": {
77
+ "displayName": "John Doe",
78
+ "email": "john@contoso.onmicrosoft.com",
79
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
80
+ }
81
+ }
82
+ ],
83
+ "link": {
84
+ "scope": "organization",
85
+ "type": "view",
86
+ "webUrl": "https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A",
87
+ "preventsDownload": false
88
+ }
89
+ }
90
+ ]
91
+ ```
92
+
93
+ === "Text"
94
+
95
+ ```text
96
+ id scope roles link
97
+ ------------------------------------ ------------ ----- ----------------------------------------------------------------------------------------
98
+ 2a021f54-90a2-4016-b3b3-5f34d2e7d932 organization read https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
99
+ ```
100
+
101
+ === "CSV"
102
+
103
+ ```csv
104
+ id,scope,roles,link
105
+ 2a021f54-90a2-4016-b3b3-5f34d2e7d932,organization,read,https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
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.
@@ -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"
@@ -20,36 +20,54 @@ m365 spo group member remove [options]
20
20
  : Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both.
21
21
 
22
22
  `--userName [userName]`
23
- : The UPN (user principal name, eg. megan.bowen@contoso.com) of the user that needs to be removed. Specify either `userName`, `email`, or `userId`, but not multiple.
23
+ : The UPN (user principal name, eg. megan.bowen@contoso.com) of the user that needs to be removed. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
24
24
 
25
25
  `--email [email]`
26
- : The email of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
26
+ : The email of the user to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
27
27
 
28
28
  `--userId [userId]`
29
- : The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
29
+ : The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
30
+
31
+ `--aadGroupId [aadGroupId]`
32
+ : The object Id of the Azure AD group to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
33
+
34
+ `--aadGroupName [aadGroupName]`
35
+ : The name of the Azure AD group to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
30
36
 
31
37
  --8<-- "docs/cmd/_global.md"
32
38
 
33
39
  ## Examples
34
40
 
35
- Remove a user from a SharePoint group by userName.
41
+ Remove a user from a SharePoint group based on the id on a given web
36
42
 
37
43
  ```sh
38
44
  m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
39
45
  ```
40
46
 
41
- Remove a user from a SharePoint group by email.
47
+ Remove a user from a SharePoint group based on the username on a given web
42
48
 
43
49
  ```sh
44
50
  m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --email "Alex.Wilber@contoso.com"
45
51
  ```
46
52
 
47
- Remove a user from a SharePoint group by id.
53
+ Remove a user from a SharePoint group by email.
48
54
 
49
55
  ```sh
50
56
  m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userId 14
51
57
  ```
52
58
 
59
+ Remove an Azure AD group from a SharePoint group based on the Azure AD group name on a given web
60
+
61
+ ```sh
62
+ m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadGroupName "Azure AD Security Group"
63
+ ```
64
+
65
+ Remove an Azure AD group from a SharePoint group based on the Azure AD group ID on a given web
66
+
67
+ ```sh
68
+ m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --aadGroupId "5786b8e8-c495-4734-b345-756733960730"
69
+ ```
70
+
53
71
  ## Response
54
72
 
55
73
  The command won't return a response on success.
@@ -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
@@ -19,8 +19,11 @@ m365 spo list label set [options]
19
19
  `-u, --webUrl <webUrl>`
20
20
  : The URL of the site where the list is located.
21
21
 
22
+ `--name <name>`
23
+ : The label name to set on the list.
24
+
22
25
  `--label <label>`
23
- : The label to set on the list.
26
+ : (deprecated. Use `name` instead) The label name to set on the list.
24
27
 
25
28
  `-t, --listTitle [listTitle]`
26
29
  : The title of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
@@ -48,16 +51,16 @@ A list retention label is a default label that will be applied to all new items
48
51
 
49
52
  ## Examples
50
53
 
51
- Sets retention label on the list with specified site-relative URL located in the specified site.
54
+ Sets a retention label by name on a given list
52
55
 
53
56
  ```sh
54
- m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
57
+ m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --name 'Some label'
55
58
  ```
56
59
 
57
- Sets retention label and disables editing and deleting items on the list and all existing items for the list with specified title located in the specified site.
60
+ Sets a retention label by name and disables editing and deleting items on the list and all existing items for a given list
58
61
 
59
62
  ```sh
60
- m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
63
+ m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --name 'Some label' --blockEdit --blockDelete --syncToItems
61
64
  ```
62
65
 
63
66
  ## Response