@pnp/cli-microsoft365 6.1.0 → 6.2.0-beta.02615ee
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.
- package/.eslintrc.js +6 -0
- package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +3 -0
- package/dist/m365/onenote/commands/page/page-list.js +137 -0
- package/dist/m365/onenote/commands.js +2 -1
- package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +110 -0
- package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +68 -0
- package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +130 -0
- package/dist/m365/pp/commands.js +3 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +70 -0
- package/dist/m365/purview/commands.js +2 -0
- package/dist/m365/spo/commands/file/GraphFileDetails.js +3 -0
- package/dist/m365/spo/commands/file/file-sharinginfo-get.js +12 -12
- package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
- package/dist/m365/spo/commands/file/file-sharinglink-list.js +133 -0
- package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
- package/dist/m365/spo/commands/group/group-member-add.js +33 -6
- package/dist/m365/spo/commands/group/group-member-remove.js +78 -33
- package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +10 -2
- package/dist/m365/spo/commands/listitem/ListItemRetentionLabel.js +3 -0
- package/dist/m365/spo/commands/listitem/SiteRetentionLabel.js +3 -0
- package/dist/m365/spo/commands/listitem/listitem-list.js +1 -1
- package/dist/m365/spo/commands/listitem/listitem-record-lock.js +129 -0
- package/dist/m365/spo/commands/listitem/listitem-record-unlock.js +129 -0
- package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +161 -0
- package/dist/m365/spo/commands/term/term-list.js +99 -29
- package/dist/m365/spo/commands.js +6 -0
- package/dist/m365/teams/commands/chat/chat-list.js +29 -7
- package/dist/request.js +2 -2
- package/docs/docs/cmd/onenote/page/page-list.md +140 -0
- package/docs/docs/cmd/planner/bucket/bucket-add.md +17 -0
- package/docs/docs/cmd/planner/bucket/bucket-get.md +17 -0
- package/docs/docs/cmd/planner/bucket/bucket-list.md +17 -0
- package/docs/docs/cmd/planner/plan/plan-add.md +40 -0
- package/docs/docs/cmd/planner/plan/plan-get.md +21 -0
- package/docs/docs/cmd/planner/plan/plan-list.md +19 -0
- package/docs/docs/cmd/planner/plan/plan-set.md +20 -0
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +99 -0
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +95 -0
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md +53 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +95 -0
- package/docs/docs/cmd/spo/cdn/cdn-get.md +1 -1
- package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +1 -1
- package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +1 -1
- package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +1 -1
- package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +1 -1
- package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +1 -1
- package/docs/docs/cmd/spo/cdn/cdn-set.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-list.md +106 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
- package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
- package/docs/docs/cmd/spo/group/group-member-remove.md +24 -6
- package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +8 -5
- package/docs/docs/cmd/spo/listitem/listitem-list.md +5 -5
- package/docs/docs/cmd/spo/listitem/listitem-record-lock.md +52 -0
- package/docs/docs/cmd/spo/listitem/listitem-record-unlock.md +52 -0
- package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +58 -0
- package/docs/docs/cmd/spo/term/term-list.md +138 -0
- package/docs/docs/cmd/teams/chat/chat-list.md +16 -4
- package/npm-shrinkwrap.json +184 -204
- package/package.json +13 -12
|
@@ -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)
|
|
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)
|
|
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
|
|
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
|
|
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`,
|
|
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`,
|
|
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`,
|
|
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
|
|
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
|
|
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
|
|
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.
|
|
@@ -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
|
|
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' --
|
|
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
|
|
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' --
|
|
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
|
|
@@ -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
|
|
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
|
|
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.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# spo listitem record lock
|
|
2
|
+
|
|
3
|
+
Locks the list item record
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo listitem record lock [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The url of the web
|
|
15
|
+
|
|
16
|
+
`--listItemId <listItemId>`
|
|
17
|
+
: ID of the list item that should be locked
|
|
18
|
+
|
|
19
|
+
`--listId [listId]`
|
|
20
|
+
: ID of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listTitle [listTitle]`
|
|
23
|
+
: Title of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
27
|
+
|
|
28
|
+
--8<-- "docs/cmd/_global.md"
|
|
29
|
+
|
|
30
|
+
## Examples
|
|
31
|
+
|
|
32
|
+
Locks the list item record in a given site based on the list id
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 spo listitem record lock --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Locks the list item record in a given site based on the list title
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 spo listitem record lock --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Locks the list item record in a given site based on the server relative list url
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo listitem record lock --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Response
|
|
51
|
+
|
|
52
|
+
The command won't return a response on success.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# spo listitem record unlock
|
|
2
|
+
|
|
3
|
+
Unlocks the list item record
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo listitem record unlock [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The url of the web
|
|
15
|
+
|
|
16
|
+
`--listItemId <listItemId>`
|
|
17
|
+
: ID of the list item that should be unlocked
|
|
18
|
+
|
|
19
|
+
`--listId [listId]`
|
|
20
|
+
: ID of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listTitle [listTitle]`
|
|
23
|
+
: Title of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
27
|
+
|
|
28
|
+
--8<-- "docs/cmd/_global.md"
|
|
29
|
+
|
|
30
|
+
## Examples
|
|
31
|
+
|
|
32
|
+
Unlocks the list item record in a given site based on the list id
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 spo listitem record unlock --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Unlocks the list item record in a given site based on the list title
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 spo listitem record unlock --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Unlocks the list item record in a given site based on the server relative list url
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo listitem record unlock --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Response
|
|
51
|
+
|
|
52
|
+
The command won't return a response on success.
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# spo listitem retentionlabel ensure
|
|
2
|
+
|
|
3
|
+
Apply a retention label to a list item
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo listitem retentionlabel ensure [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the retentionlabel from a listitem to apply is located
|
|
15
|
+
|
|
16
|
+
`--listItemId <listItemId>`
|
|
17
|
+
: The ID of the list item for which the retention label should be applied.
|
|
18
|
+
|
|
19
|
+
`--listId [listId]`
|
|
20
|
+
: ID of the list where the retention label should be applied. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listTitle [listTitle]`
|
|
23
|
+
: Title of the list where the retention label should be applied. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
27
|
+
|
|
28
|
+
`-n, --name [name]`
|
|
29
|
+
: The name of the retention label. Specify either `name` or `id`.
|
|
30
|
+
|
|
31
|
+
`-i, --id [id]`
|
|
32
|
+
: The id of the retention label. Specify either `name` or `id`.
|
|
33
|
+
|
|
34
|
+
--8<-- "docs/cmd/_global.md"
|
|
35
|
+
|
|
36
|
+
## Examples
|
|
37
|
+
|
|
38
|
+
Applies the retention label _Some label_ to a list item in a given site based on the list id and label name
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1 --name 'Some label'
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Applies a retention label to a list item in a given site based on the list title and label id
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1 --id '7a621a91-063b-461b-aff6-d713d5fb23eb'
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Applies the retention label _Some label_ to a list item in a given site based on the server relative list url
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1 --name 'Some label'
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Response
|
|
57
|
+
|
|
58
|
+
The command won't return a response on success.
|
|
@@ -22,6 +22,9 @@ m365 spo term list [options]
|
|
|
22
22
|
`--termSetName [termSetName]`
|
|
23
23
|
: Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
|
|
24
24
|
|
|
25
|
+
`--includeChildTerms`
|
|
26
|
+
: If specified, child terms are loaded as well.
|
|
27
|
+
|
|
25
28
|
--8<-- "docs/cmd/_global.md"
|
|
26
29
|
|
|
27
30
|
!!! important
|
|
@@ -40,3 +43,138 @@ List taxonomy terms from the term group and term set with the given ID
|
|
|
40
43
|
```sh
|
|
41
44
|
m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec
|
|
42
45
|
```
|
|
46
|
+
|
|
47
|
+
List taxonomy terms from the term group and term set with the given ID including child terms if any are found
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Response
|
|
54
|
+
|
|
55
|
+
### Standard response
|
|
56
|
+
|
|
57
|
+
=== "JSON"
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
[
|
|
61
|
+
{
|
|
62
|
+
"_ObjectType_": "SP.Taxonomy.Term",
|
|
63
|
+
"_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
|
|
64
|
+
"CreatedDate": "2021-10-12T09:42:44.880Z",
|
|
65
|
+
"Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
|
|
66
|
+
"LastModifiedDate": "2021-10-12T09:42:45.237Z",
|
|
67
|
+
"Name": "Departments",
|
|
68
|
+
"CustomProperties": {},
|
|
69
|
+
"CustomSortOrder": null,
|
|
70
|
+
"IsAvailableForTagging": true,
|
|
71
|
+
"Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
|
|
72
|
+
"Description": "",
|
|
73
|
+
"IsDeprecated": false,
|
|
74
|
+
"IsKeyword": false,
|
|
75
|
+
"IsPinned": false,
|
|
76
|
+
"IsPinnedRoot": false,
|
|
77
|
+
"IsReused": false,
|
|
78
|
+
"IsRoot": true,
|
|
79
|
+
"IsSourceTerm": true,
|
|
80
|
+
"LocalCustomProperties": {
|
|
81
|
+
"Id": "termDepartments"
|
|
82
|
+
},
|
|
83
|
+
"MergedTermIds": [],
|
|
84
|
+
"PathOfTerm": "Departments",
|
|
85
|
+
"TermsCount": 1
|
|
86
|
+
}
|
|
87
|
+
]
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
=== "Text"
|
|
91
|
+
|
|
92
|
+
```text
|
|
93
|
+
Id Name
|
|
94
|
+
------------------------------------ ---------
|
|
95
|
+
c387e91c-b553-4b92-886b-9af717cd73b0 Financing
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
=== "CSV"
|
|
99
|
+
|
|
100
|
+
```csv
|
|
101
|
+
Id,Name
|
|
102
|
+
c387e91c-b553-4b92-886b-9af717cd73b0,Financing
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### `includeChildTerms` response
|
|
106
|
+
|
|
107
|
+
When we make use of the option `includeChildTerms` the response will differ.
|
|
108
|
+
|
|
109
|
+
=== "JSON"
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
[
|
|
113
|
+
{
|
|
114
|
+
"_ObjectType_": "SP.Taxonomy.Term",
|
|
115
|
+
"_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
|
|
116
|
+
"CreatedDate": "2021-10-12T09:42:44.880Z",
|
|
117
|
+
"Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
|
|
118
|
+
"LastModifiedDate": "2021-10-12T09:42:45.237Z",
|
|
119
|
+
"Name": "Departments",
|
|
120
|
+
"CustomProperties": {},
|
|
121
|
+
"CustomSortOrder": null,
|
|
122
|
+
"IsAvailableForTagging": true,
|
|
123
|
+
"Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
|
|
124
|
+
"Description": "",
|
|
125
|
+
"IsDeprecated": false,
|
|
126
|
+
"IsKeyword": false,
|
|
127
|
+
"IsPinned": false,
|
|
128
|
+
"IsPinnedRoot": false,
|
|
129
|
+
"IsReused": false,
|
|
130
|
+
"IsRoot": true,
|
|
131
|
+
"IsSourceTerm": true,
|
|
132
|
+
"LocalCustomProperties": {
|
|
133
|
+
"Id": "termDepartments"
|
|
134
|
+
},
|
|
135
|
+
"MergedTermIds": [],
|
|
136
|
+
"PathOfTerm": "Departments",
|
|
137
|
+
"TermsCount": 1,
|
|
138
|
+
"Children": [{
|
|
139
|
+
"_ObjectType_": "SP.Taxonomy.Term",
|
|
140
|
+
"_ObjectIdentity_": "d10486a0-4067-5000-de97-bf1ab5bff53c|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNf5ybB0mfG0Kx6YO5CODZ1A==",
|
|
141
|
+
"CreatedDate": "2022-12-25T23:59:15.200Z",
|
|
142
|
+
"Id": "079b9c7f-9f49-421b-b1e9-83b908e0d9d4",
|
|
143
|
+
"LastModifiedDate": "2022-12-25T23:59:15.200Z",
|
|
144
|
+
"Name": "Financing",
|
|
145
|
+
"CustomProperties": {},
|
|
146
|
+
"CustomSortOrder": null,
|
|
147
|
+
"IsAvailableForTagging": true,
|
|
148
|
+
"Owner": "i:0#.f|membership|admin@mathijsdev2.onmicrosoft.com",
|
|
149
|
+
"Description": "",
|
|
150
|
+
"IsDeprecated": false,
|
|
151
|
+
"IsKeyword": false,
|
|
152
|
+
"IsPinned": false,
|
|
153
|
+
"IsPinnedRoot": false,
|
|
154
|
+
"IsReused": false,
|
|
155
|
+
"IsRoot": false,
|
|
156
|
+
"IsSourceTerm": true,
|
|
157
|
+
"LocalCustomProperties": {},
|
|
158
|
+
"MergedTermIds": [],
|
|
159
|
+
"PathOfTerm": "Departments;Financing",
|
|
160
|
+
"TermsCount": 0
|
|
161
|
+
}]
|
|
162
|
+
}
|
|
163
|
+
]
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
=== "Text"
|
|
167
|
+
|
|
168
|
+
```text
|
|
169
|
+
Id Name ParentTermId
|
|
170
|
+
------------------------------------ --------- ------------------------------------
|
|
171
|
+
c387e91c-b553-4b92-886b-9af717cd73b0 Financing 079b9c7f-9f49-421b-b1e9-83b908e0d9d4
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
=== "CSV"
|
|
175
|
+
|
|
176
|
+
```csv
|
|
177
|
+
Id,Name,ParentTermId
|
|
178
|
+
c387e91c-b553-4b92-886b-9af717cd73b0,Financing,079b9c7f-9f49-421b-b1e9-83b908e0d9d4
|
|
179
|
+
```
|
|
180
|
+
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# teams chat list
|
|
2
2
|
|
|
3
|
-
Lists all Microsoft Teams chat conversations for the current user.
|
|
3
|
+
Lists all Microsoft Teams chat conversations for the current or a specific user.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
@@ -10,9 +10,15 @@ m365 teams chat list [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-t, --type [
|
|
13
|
+
`-t, --type [type]`
|
|
14
14
|
: The chat type to optionally filter chat conversations by type. The value can be `oneOnOne`, `group` or `meeting`.
|
|
15
15
|
|
|
16
|
+
`--userId [userId]`
|
|
17
|
+
: ID of the user. Has to be specified when using application permissions. Specify either `userId` or `userName`, but not both.
|
|
18
|
+
|
|
19
|
+
`--userName [userName]`
|
|
20
|
+
: UPN of the user. Has to be specified when using application permissions. Specify either `userId` or `userName`, but not both.
|
|
21
|
+
|
|
16
22
|
--8<-- "docs/cmd/_global.md"
|
|
17
23
|
|
|
18
24
|
## Examples
|
|
@@ -23,10 +29,16 @@ List all the Microsoft Teams chat conversations of the current user.
|
|
|
23
29
|
m365 teams chat list
|
|
24
30
|
```
|
|
25
31
|
|
|
26
|
-
List only the one on one Microsoft Teams chat conversations.
|
|
32
|
+
List only the one on one Microsoft Teams chat conversations of a specific user retrieved by id.
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 teams chat list --userId e6296ed0-4b7d-4ace-aed4-f6b7371ce060 --type oneOnOne
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
List only the group Microsoft Teams chat conversations of a specific user retrieved by mail
|
|
27
39
|
|
|
28
40
|
```sh
|
|
29
|
-
m365 teams chat list --type
|
|
41
|
+
m365 teams chat list --userName 'john@contoso.com' --type group
|
|
30
42
|
```
|
|
31
43
|
|
|
32
44
|
## Response
|