@pnp/cli-microsoft365 6.1.0-beta.c68d208 → 6.1.0-beta.d3a109a
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/dist/m365/aad/commands/group/group-get.js +79 -0
- package/dist/m365/aad/commands.js +1 -0
- package/dist/m365/context/commands/context-remove.js +103 -0
- package/dist/m365/context/commands.js +2 -1
- package/dist/m365/pp/commands/environment/environment-get.js +5 -13
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +142 -0
- package/dist/m365/purview/commands.js +2 -1
- package/dist/m365/search/commands/externalconnection/externalconnection-schema-add.js +86 -0
- package/dist/m365/search/commands.js +2 -1
- package/dist/m365/spo/commands/group/group-member-add.js +68 -30
- package/dist/m365/spo/commands/group/group-member-remove.js +50 -7
- package/dist/m365/spo/commands/list/{list-retentionlabel-set.js → list-retentionlabel-ensure.js} +21 -15
- package/dist/m365/spo/commands/listitem/listitem-remove.js +1 -1
- package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +143 -0
- package/dist/m365/spo/commands/page/page-add.js +60 -63
- package/dist/m365/spo/commands/page/page-set.js +59 -70
- package/dist/m365/spo/commands/site/site-appcatalog-list.js +43 -0
- package/dist/m365/spo/commands.js +3 -1
- package/dist/request.js +2 -1
- package/docs/docs/cmd/aad/group/group-get.md +127 -0
- package/docs/docs/cmd/context/context-remove.md +34 -0
- package/docs/docs/cmd/pp/environment/environment-get.md +9 -3
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +63 -0
- package/docs/docs/cmd/search/externalconnection/externalconnection-schema-add.md +31 -0
- package/docs/docs/cmd/spo/group/group-member-add.md +58 -6
- package/docs/docs/cmd/spo/group/group-member-remove.md +24 -8
- package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +65 -0
- package/docs/docs/cmd/spo/listitem/listitem-remove.md +6 -6
- package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.md +55 -0
- package/docs/docs/cmd/spo/site/site-appcatalog-list.md +55 -0
- package/package.json +1 -1
- package/docs/docs/cmd/spo/list/list-retentionlabel-set.md +0 -65
|
@@ -11,29 +11,45 @@ m365 spo group member remove [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`-u, --webUrl <webUrl>`
|
|
14
|
-
: URL of the site where the SharePoint group is available
|
|
14
|
+
: URL of the site where the SharePoint group is available.
|
|
15
15
|
|
|
16
16
|
`--groupId [groupId]`
|
|
17
|
-
: Id of the SharePoint group from which the user has to be removed. Specify either `groupName` or `groupId`, but not both
|
|
17
|
+
: Id of the SharePoint group from which the user has to be removed. Specify either `groupName` or `groupId`, but not both.
|
|
18
18
|
|
|
19
19
|
`--groupName [groupName]`
|
|
20
|
-
: Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both
|
|
20
|
+
: Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both.
|
|
21
21
|
|
|
22
|
-
`--userName
|
|
23
|
-
: The UPN of the user that needs to be removed
|
|
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.
|
|
24
|
+
|
|
25
|
+
`--email [email]`
|
|
26
|
+
: The email of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
|
|
27
|
+
|
|
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.
|
|
24
30
|
|
|
25
31
|
--8<-- "docs/cmd/_global.md"
|
|
26
32
|
|
|
27
33
|
## Examples
|
|
28
34
|
|
|
29
|
-
Remove a user from SharePoint group
|
|
35
|
+
Remove a user from a SharePoint group by userName.
|
|
30
36
|
|
|
31
37
|
```sh
|
|
32
38
|
m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
|
|
33
39
|
```
|
|
34
40
|
|
|
35
|
-
Remove a user from SharePoint group
|
|
41
|
+
Remove a user from a SharePoint group by email.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --email "Alex.Wilber@contoso.com"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Remove a user from a SharePoint group by id.
|
|
36
48
|
|
|
37
49
|
```sh
|
|
38
|
-
m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --
|
|
50
|
+
m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userId 14
|
|
39
51
|
```
|
|
52
|
+
|
|
53
|
+
## Response
|
|
54
|
+
|
|
55
|
+
The command won't return a response on success.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# spo list retentionlabel ensure
|
|
2
|
+
|
|
3
|
+
Sets a default retention label on the specified list or library.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo list retentionlabel ensure [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Alias
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
m365 spo list label set [options]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Options
|
|
18
|
+
|
|
19
|
+
`-u, --webUrl <webUrl>`
|
|
20
|
+
: The URL of the site where the list is located.
|
|
21
|
+
|
|
22
|
+
`--label <label>`
|
|
23
|
+
: The label to set on the list.
|
|
24
|
+
|
|
25
|
+
`-t, --listTitle [listTitle]`
|
|
26
|
+
: The title of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
|
|
27
|
+
|
|
28
|
+
`-l, --listId [listId]`
|
|
29
|
+
: The ID of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
|
|
30
|
+
|
|
31
|
+
`--listUrl [listUrl]`
|
|
32
|
+
: Server- or web-relative URL of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
|
|
33
|
+
|
|
34
|
+
`--syncToItems`
|
|
35
|
+
: Specify, to set the label on all existing items in the list.
|
|
36
|
+
|
|
37
|
+
`--blockDelete`
|
|
38
|
+
: (deprecated) Specify, to disallow deleting items in the list.
|
|
39
|
+
|
|
40
|
+
`--blockEdit`
|
|
41
|
+
: (deprecated) Specify, to disallow editing items in the list.
|
|
42
|
+
|
|
43
|
+
--8<-- "docs/cmd/_global.md"
|
|
44
|
+
|
|
45
|
+
## Remarks
|
|
46
|
+
|
|
47
|
+
A list retention label is a default label that will be applied to all new items in the list. If you specify `syncToItems`, it is also synced to existing items.
|
|
48
|
+
|
|
49
|
+
## Examples
|
|
50
|
+
|
|
51
|
+
Sets retention label on the list with specified site-relative URL located in the specified site.
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
|
|
55
|
+
```
|
|
56
|
+
|
|
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.
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Response
|
|
64
|
+
|
|
65
|
+
The command won't return a response on success.
|
|
@@ -11,16 +11,16 @@ m365 spo listitem remove [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`-u, --webUrl <webUrl>`
|
|
14
|
-
: URL of the site where the list to remove is located
|
|
14
|
+
: URL of the site where the list item to remove is located
|
|
15
15
|
|
|
16
16
|
`-i, --id <id>`
|
|
17
17
|
: The ID of the list item to remove.
|
|
18
18
|
|
|
19
19
|
`-l, --listId [listId]`
|
|
20
|
-
: ID of the list where the item should be
|
|
20
|
+
: ID of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
21
|
|
|
22
22
|
`-t, --listTitle [listTitle]`
|
|
23
|
-
: Title of the list where the item should be
|
|
23
|
+
: Title of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
24
|
|
|
25
25
|
`--listUrl [listUrl]`
|
|
26
26
|
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
@@ -35,19 +35,19 @@ m365 spo listitem remove [options]
|
|
|
35
35
|
|
|
36
36
|
## Examples
|
|
37
37
|
|
|
38
|
-
Remove the list item
|
|
38
|
+
Remove the list item located in a given site based on the list id
|
|
39
39
|
|
|
40
40
|
```sh
|
|
41
41
|
m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id 1
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Remove the list item
|
|
44
|
+
Remove the list item located in a given site based on the list title
|
|
45
45
|
|
|
46
46
|
```sh
|
|
47
47
|
m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --id 1
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Remove the list item
|
|
50
|
+
Remove the list item located in a given site based on the server-relative list url
|
|
51
51
|
|
|
52
52
|
```sh
|
|
53
53
|
m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --id 1
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# spo listitem retentionlabel remove
|
|
2
|
+
|
|
3
|
+
Clears the retention label from a list item
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo listitem retentionlabel remove [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the retentionlabel from a listitem to remove is located
|
|
15
|
+
|
|
16
|
+
`-i, --listItemId <listItemId>`
|
|
17
|
+
: The ID of the list item for which the retention label should be removed.
|
|
18
|
+
|
|
19
|
+
`-l, --listId [listId]`
|
|
20
|
+
: ID of the list where the retention label should be removed. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`-t, --listTitle [listTitle]`
|
|
23
|
+
: Title of the list where the retention label should be removed. 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
|
+
`--confirm`
|
|
29
|
+
: Don't prompt for confirming removing the retention label from a list item
|
|
30
|
+
|
|
31
|
+
--8<-- "docs/cmd/_global.md"
|
|
32
|
+
|
|
33
|
+
## Examples
|
|
34
|
+
|
|
35
|
+
Removes the retention label from a list item in a given site based on the list id
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Removes the retention label from a list item in a given site based on the list title
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Removes the retention label from a list item in a given site based on the server relative list url
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Response
|
|
54
|
+
|
|
55
|
+
The command won't return a response on success.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# spo site appcatalog list
|
|
2
|
+
|
|
3
|
+
List all site collection app catalogs within the tenant
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo site appcatalog list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
--8<-- "docs/cmd/_global.md"
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
!!! important
|
|
18
|
+
To use this command you need to have at least read permissions on the SharePoint root site.
|
|
19
|
+
|
|
20
|
+
## Examples
|
|
21
|
+
|
|
22
|
+
List all site collection app catalogs within the tenant
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
m365 spo site appcatalog list
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Response
|
|
29
|
+
|
|
30
|
+
=== "JSON"
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
[
|
|
34
|
+
{
|
|
35
|
+
"AbsoluteUrl": "https://contoso.sharepoint.com/sites/site1",
|
|
36
|
+
"ErrorMessage": "Success",
|
|
37
|
+
"SiteID": "9798e615-b586-455e-8486-84913f492c49"
|
|
38
|
+
}
|
|
39
|
+
]
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
=== "Text"
|
|
43
|
+
|
|
44
|
+
```text
|
|
45
|
+
AbsoluteUrl SiteID
|
|
46
|
+
--------------------------------------------------- ------------------------------------
|
|
47
|
+
https://contoso.sharepoint.com/sites/site1 9798e615-b586-455e-8486-84913f492c49
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
=== "CSV"
|
|
51
|
+
|
|
52
|
+
```csv
|
|
53
|
+
AbsoluteUrl,SiteID
|
|
54
|
+
https://contoso.sharepoint.com/sites/site1,9798e615-b586-455e-8486-84913f492c49
|
|
55
|
+
```
|
package/package.json
CHANGED
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
# spo list retentionlabel set
|
|
2
|
-
|
|
3
|
-
Sets a default retention label on the specified list or library.
|
|
4
|
-
|
|
5
|
-
## Usage
|
|
6
|
-
|
|
7
|
-
```sh
|
|
8
|
-
m365 spo list retentionlabel set [options]
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Alias
|
|
12
|
-
|
|
13
|
-
```sh
|
|
14
|
-
m365 spo list label set [options]
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Options
|
|
18
|
-
|
|
19
|
-
`-u, --webUrl <webUrl>`
|
|
20
|
-
: The URL of the site where the list is located
|
|
21
|
-
|
|
22
|
-
`--label <label>`
|
|
23
|
-
: The label to set on the list
|
|
24
|
-
|
|
25
|
-
`-t, --listTitle [listTitle]`
|
|
26
|
-
: The title of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
|
|
27
|
-
|
|
28
|
-
`-l, --listId [listId]`
|
|
29
|
-
: The ID of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
|
|
30
|
-
|
|
31
|
-
`--listUrl [listUrl]`
|
|
32
|
-
: Server- or web-relative URL of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
|
|
33
|
-
|
|
34
|
-
`--syncToItems`
|
|
35
|
-
: Specify, to set the label on all existing items in the list
|
|
36
|
-
|
|
37
|
-
`--blockDelete`
|
|
38
|
-
: Specify, to disallow deleting items in the list
|
|
39
|
-
|
|
40
|
-
`--blockEdit`
|
|
41
|
-
: Specify, to disallow editing items in the list
|
|
42
|
-
|
|
43
|
-
--8<-- "docs/cmd/_global.md"
|
|
44
|
-
|
|
45
|
-
## Remarks
|
|
46
|
-
|
|
47
|
-
A list retention label is a default label that will be applied to all new items in the list. If you specify `syncToItems`, it is also synced to existing items.
|
|
48
|
-
|
|
49
|
-
## Examples
|
|
50
|
-
|
|
51
|
-
Sets retention label "Some label" on the list _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
52
|
-
|
|
53
|
-
```sh
|
|
54
|
-
m365 spo list retentionlabel set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Sets retention label "Some label" and disables editing and deleting items on the list and all existing items for list for list _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
58
|
-
|
|
59
|
-
```sh
|
|
60
|
-
m365 spo list retentionlabel set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Response
|
|
64
|
-
|
|
65
|
-
The command won't return a response on success.
|