@pnp/cli-microsoft365 6.0.0-beta.c32757e → 6.0.0-beta.d4d33ed

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 (98) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/m365/aad/commands/app/app-remove.js +0 -4
  3. package/dist/m365/aad/commands/app/app-role-remove.js +0 -4
  4. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  5. package/dist/m365/aad/commands.js +0 -2
  6. package/dist/m365/base/PowerAppsCommand.js +10 -0
  7. package/dist/m365/pa/commands/app/app-get.js +3 -5
  8. package/dist/m365/pa/commands/app/app-list.js +10 -9
  9. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  10. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  11. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  12. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  13. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  14. package/dist/m365/planner/commands/bucket/bucket-add.js +11 -11
  15. package/dist/m365/planner/commands/bucket/bucket-get.js +13 -13
  16. package/dist/m365/planner/commands/bucket/bucket-list.js +11 -11
  17. package/dist/m365/planner/commands/bucket/bucket-remove.js +13 -13
  18. package/dist/m365/planner/commands/bucket/bucket-set.js +13 -13
  19. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  20. package/dist/m365/planner/commands/plan/plan-get.js +1 -5
  21. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  22. package/dist/m365/planner/commands/task/task-add.js +11 -11
  23. package/dist/m365/planner/commands/task/task-get.js +10 -20
  24. package/dist/m365/planner/commands/task/task-list.js +13 -13
  25. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  26. package/dist/m365/planner/commands/task/task-set.js +11 -11
  27. package/dist/m365/planner/commands.js +0 -2
  28. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  29. package/dist/m365/search/commands.js +1 -0
  30. package/dist/m365/spo/base-permissions.js +9 -0
  31. package/dist/m365/spo/commands/customaction/customaction-get.js +32 -4
  32. package/dist/m365/spo/commands/customaction/customaction-remove.js +43 -8
  33. package/dist/m365/spo/commands/field/field-get.js +14 -5
  34. package/dist/m365/spo/commands/field/field-remove.js +19 -10
  35. package/dist/m365/spo/commands/field/field-set.js +16 -9
  36. package/dist/m365/spo/commands/group/group-add.js +96 -0
  37. package/dist/m365/spo/commands/group/group-set.js +167 -0
  38. package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
  39. package/dist/m365/spo/commands/list/list-list.js +1 -10
  40. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  41. package/dist/m365/spo/commands/listitem/listitem-list.js +9 -26
  42. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  43. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  44. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  45. package/dist/m365/spo/commands/site/site-list.js +47 -16
  46. package/dist/m365/spo/commands/site/site-set.js +322 -162
  47. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +9 -6
  48. package/dist/m365/spo/commands.js +3 -3
  49. package/dist/m365/teams/commands/tab/tab-get.js +2 -2
  50. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  51. package/dist/m365/teams/commands/team/team-clone.js +33 -7
  52. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  53. package/dist/m365/teams/commands/team/team-set.js +25 -5
  54. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  55. package/dist/utils/planner.js +6 -6
  56. package/docs/docs/cmd/aad/app/app-remove.md +0 -6
  57. package/docs/docs/cmd/aad/app/app-role-remove.md +0 -6
  58. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  59. package/docs/docs/cmd/planner/bucket/bucket-add.md +7 -7
  60. package/docs/docs/cmd/planner/bucket/bucket-get.md +8 -8
  61. package/docs/docs/cmd/planner/bucket/bucket-list.md +6 -6
  62. package/docs/docs/cmd/planner/bucket/bucket-remove.md +6 -6
  63. package/docs/docs/cmd/planner/bucket/bucket-set.md +7 -7
  64. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  65. package/docs/docs/cmd/planner/plan/plan-get.md +0 -6
  66. package/docs/docs/cmd/planner/task/task-add.md +9 -9
  67. package/docs/docs/cmd/planner/task/task-get.md +15 -9
  68. package/docs/docs/cmd/planner/task/task-list.md +7 -7
  69. package/docs/docs/cmd/planner/task/task-set.md +7 -7
  70. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  71. package/docs/docs/cmd/spo/customaction/customaction-get.md +15 -2
  72. package/docs/docs/cmd/spo/customaction/customaction-remove.md +33 -2
  73. package/docs/docs/cmd/spo/field/field-get.md +6 -3
  74. package/docs/docs/cmd/spo/field/field-remove.md +9 -6
  75. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  76. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  77. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  78. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
  79. package/docs/docs/cmd/spo/list/list-list.md +0 -3
  80. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  81. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -6
  82. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  83. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  84. package/docs/docs/cmd/spo/site/site-set.md +50 -6
  85. package/docs/docs/cmd/teams/tab/tab-get.md +2 -2
  86. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  87. package/docs/docs/cmd/teams/team/team-clone.md +11 -5
  88. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  89. package/docs/docs/cmd/teams/team/team-set.md +10 -4
  90. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  91. package/npm-shrinkwrap.json +173 -158
  92. package/package.json +13 -13
  93. package/dist/m365/spo/commands/site/site-classic-add.js +0 -333
  94. package/dist/m365/spo/commands/site/site-classic-list.js +0 -98
  95. package/dist/m365/spo/commands/site/site-classic-set.js +0 -358
  96. package/docs/docs/cmd/spo/site/site-classic-add.md +0 -93
  97. package/docs/docs/cmd/spo/site/site-classic-list.md +0 -65
  98. package/docs/docs/cmd/spo/site/site-classic-set.md +0 -99
@@ -0,0 +1,51 @@
1
+ # spo group add
2
+
3
+ Creates group in the specified site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo group add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the group should be added.
15
+
16
+ `-n, --name <name>`
17
+ : Name of the group to add.
18
+
19
+ `--description [description]`
20
+ : The description for the group.
21
+
22
+ `--allowMembersEditMembership [allowMembersEditMembership]`
23
+ : Who can edit the membership of the group? When `true` members can edit membership, otherwise only owners can do this. Default `false`.
24
+
25
+ `--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
26
+ : Who can view the membership of the group? When `false` everyone can view the group membership, otherwise only group members can. Default `true`.
27
+
28
+ `--allowRequestToJoinLeave [allowRequestToJoinLeave]`
29
+ : Specify whether to allow users to request membership in this group and allow users to request to leave the group. Default `false`.
30
+
31
+ `--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
32
+ : If auto-accept is enabled, users will automatically be added or removed when they make a request. Default `false`.
33
+
34
+ `--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
35
+ : All membership requests will be sent to the email address specified.
36
+
37
+ --8<-- "docs/cmd/_global.md"
38
+
39
+ ## Examples
40
+
41
+ Create group with title and description
42
+
43
+ ```sh
44
+ m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --description "This group contains all project leaders"
45
+ ```
46
+
47
+ Create group with membership requests
48
+
49
+ ```sh
50
+ m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
51
+ ```
@@ -0,0 +1,69 @@
1
+ # spo group set
2
+
3
+ Updates a group in the specified site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo group set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the group is located.
15
+
16
+ `-i, --id [id]`
17
+ : ID of the group to update. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : Name of the group. Specify either `id` or `name` but not both.
21
+
22
+ `--newName [newName]`
23
+ : New name for the group.
24
+
25
+ `--description [description]`
26
+ : The description for the group.
27
+
28
+ `--allowMembersEditMembership [allowMembersEditMembership]`
29
+ : Who can edit the membership of the group? When `true` members can edit membership, otherwise only owners can do this.
30
+
31
+ `--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
32
+ : Who can view the membership of the group? When `true` only group members can view the membership, otherwise everyone can.
33
+
34
+ `--allowRequestToJoinLeave [allowRequestToJoinLeave]`
35
+ : Specify whether to allow users to request membership in this group and allow users to request to leave the group.
36
+
37
+ `--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
38
+ : If auto-accept is enabled, users will automatically be added or removed when they make a request.
39
+
40
+ `--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
41
+ : All membership requests will be sent to the email address specified.
42
+
43
+ `--ownerEmail [ownerEmail]`
44
+ : Set user with this email as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
45
+
46
+ `--ownerUserName [ownerUserName]`
47
+ : Set user with this login name as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
48
+
49
+ --8<-- "docs/cmd/_global.md"
50
+
51
+ ## Examples
52
+
53
+ Update group title and description
54
+
55
+ ```sh
56
+ m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --newTitle "Project leaders" --description "This group contains all project leaders"
57
+ ```
58
+
59
+ Update group with membership requests
60
+
61
+ ```sh
62
+ m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --title "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
63
+ ```
64
+
65
+ Sets a specified user as group owner
66
+
67
+ ```sh
68
+ m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --ownerEmail john.doe@contoso.com
69
+ ```
@@ -10,17 +10,19 @@ m365 spo hubsite get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --id <id>`
14
- : Hub site ID
13
+ `-i, --id [id]`
14
+ : ID of the hubsite. Specify either `id`, `title` or `url` but not multiple.
15
15
 
16
- --8<-- "docs/cmd/_global.md"
16
+ `-t, --title [title]`
17
+ : Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
17
18
 
18
- ## Remarks
19
+ `-u, --url [url]`
20
+ : URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
19
21
 
20
- !!! attention
21
- This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
22
+ `--includeAssociatedSites`
23
+ : Include the associated sites in the result (only in JSON output)
22
24
 
23
- If the specified `id` doesn't refer to an existing hub site, you will get a `ResourceNotFoundException` error.
25
+ --8<-- "docs/cmd/_global.md"
24
26
 
25
27
  ## Examples
26
28
 
@@ -30,6 +32,36 @@ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
30
32
  m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
31
33
  ```
32
34
 
35
+ Get information about the hub site with Title _My Hub Site_
36
+
37
+ ```sh
38
+ m365 spo hubsite get --title 'My Hub Site'
39
+ ```
40
+
41
+ Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
42
+
43
+ ```sh
44
+ m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
45
+ ```
46
+
47
+ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_, including its associated sites. Associated site info is only shown in JSON output.
48
+
49
+ ```sh
50
+ m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json
51
+ ```
52
+
53
+ Get information about the hub site with Title _My Hub Site_
54
+
55
+ ```sh
56
+ m365 spo hubsite get --title "My Hub Site"
57
+ ```
58
+
59
+ Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
60
+
61
+ ```sh
62
+ m365 spo hubsite get --url "https://contoso.sharepoint.com/sites/HubSite"
63
+ ```
64
+
33
65
  ## More information
34
66
 
35
67
  - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)
@@ -13,9 +13,6 @@ m365 spo list list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the lists to retrieve are located
15
15
 
16
- `--executeWithLimitedPermissions`
17
- : Use this option to execute this command with site member or visitor permissions. Not specifying this option will require site owner (or admin) permissions.
18
-
19
16
  --8<-- "docs/cmd/_global.md"
20
17
 
21
18
  ## Examples
@@ -27,6 +27,10 @@ m365 spo listitem get [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
+ ## Remarks
31
+
32
+ If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
33
+
30
34
  ## Examples
31
35
 
32
36
  Get an item with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -35,9 +39,14 @@ Get an item with ID _147_ from list with title _Demo List_ in site _https://cont
35
39
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
36
40
  ```
37
41
 
38
-
39
- Get an items Title and Created column and with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Get an items _Title_ and _Created_ column with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
40
43
 
41
44
  ```sh
42
45
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created"
43
46
  ```
47
+
48
+ Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
49
+
50
+ ```sh
51
+ m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
52
+ ```
@@ -16,15 +16,9 @@ m365 spo listitem list [options]
16
16
  `-i, --listId [listId]`
17
17
  : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
18
18
 
19
- `--id [id]`
20
- : (deprecated. Use `listId` instead) ID of the list to retrieve items from. Specify `id` or `title` but not both
21
-
22
19
  `-t, --listTitle [listTitle]`
23
20
  : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
24
21
 
25
- `--title [title]`
26
- : (deprecated. Use `listTitle` instead) Title of the list to retrieve items from. Specify `id` or `title` but not both
27
-
28
22
  `-q, --camlQuery [camlQuery]`
29
23
  : CAML query to use to query the list of items with
30
24
 
@@ -46,6 +40,8 @@ m365 spo listitem list [options]
46
40
 
47
41
  `pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
48
42
 
43
+ If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
44
+
49
45
  ## Examples
50
46
 
51
47
  Get all items from a list named Demo List
@@ -72,6 +68,12 @@ Get all items from list named _Demo List_. For each item, retrieve the value of
72
68
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
73
69
  ```
74
70
 
71
+ Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_, _Modified_ fields, and the value of lookup field _Company_
72
+
73
+ ```sh
74
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"
75
+ ```
76
+
75
77
  From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
76
78
 
77
79
  ```sh
@@ -0,0 +1,27 @@
1
+ # spo roledefinition get
2
+
3
+ Gets specified role definition from web by id
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo roledefinition get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site for which to retrieve the role definition
15
+
16
+ `-i, --id <id>`
17
+ : The Id of the role definition to retrieve.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieve the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with id _1_
24
+
25
+ ```sh
26
+ m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
27
+ ```
@@ -10,12 +10,18 @@ m365 spo site list [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `--type [type]`
14
- : type of modern sites to list. Allowed values `TeamSite,CommunicationSite`, default `TeamSite`
13
+ `-t, --type [type]`
14
+ : convenience option for type of sites to list. Allowed values are `TeamSite,CommunicationSite`.
15
+
16
+ `--webTemplate [webTemplate]`
17
+ : type of sites to list. To be used with values like `GROUP#0` and `SITEPAGEPUBLISHING#0`. Specify either `type` or `webTemplate`, but not both.
15
18
 
16
19
  `-f, --filter [filter]`
17
20
  : filter to apply when retrieving sites
18
21
 
22
+ `--includeOneDriveSites`
23
+ : use this switch to include OneDrive sites in the result when retrieving sites. Do not specify the `type` or `webTemplate` options when using this.
24
+
19
25
  `--deleted`
20
26
  : use this switch to only return deleted sites
21
27
 
@@ -28,34 +34,40 @@ m365 spo site list [options]
28
34
 
29
35
  Using the `-f, --filter` option you can specify which sites you want to retrieve. For example, to get sites with _project_ in their URL, use `Url -like 'project'` as the filter.
30
36
 
31
- When using the text output type (default), the command lists only the values of the `Title`, and `Url` properties of the site. When setting the output type to JSON, all available properties are included in the command output.
37
+ When using the text output type, the command lists only the values of the `Title`, and `Url` properties of the site. When setting the output type to JSON, all available properties are included in the command output.
32
38
 
33
39
  ## Examples
34
40
 
35
- List all modern team sites in the currently connected tenant
41
+ List all sites in the currently connected tenant
36
42
 
37
43
  ```sh
38
44
  m365 spo site list
39
45
  ```
40
46
 
41
- List all modern team sites in the currently connected tenant
47
+ List all group connected team sites in the currently connected tenant
42
48
 
43
49
  ```sh
44
50
  m365 spo site list --type TeamSite
45
51
  ```
46
52
 
47
- List all modern communication sites in the currently connected tenant
53
+ List all communication sites in the currently connected tenant
48
54
 
49
55
  ```sh
50
56
  m365 spo site list --type CommunicationSite
51
57
  ```
52
58
 
53
- List all modern team sites that contain _project_ in the URL
59
+ List all group connected team sites that contain _project_ in the URL
54
60
 
55
61
  ```sh
56
62
  m365 spo site list --type TeamSite --filter "Url -like 'project'"
57
63
  ```
58
64
 
65
+ List all sites in the currently connected tenant including OneDrive sites
66
+
67
+ ```sh
68
+ m365 spo site list --includeOneDriveSites
69
+ ```
70
+
59
71
  List all deleted sites in the tenant you're logged in to
60
72
 
61
73
  ```sh
@@ -13,6 +13,12 @@ m365 spo site set [options]
13
13
  `-u, --url <url>`
14
14
  : The URL of the site collection to update
15
15
 
16
+ `-t, --title [title]`
17
+ : The new title for the site collection
18
+
19
+ `-d, --description [description]`
20
+ : The site description
21
+
16
22
  `--classification [classification]`
17
23
  : The new classification for the site collection
18
24
 
@@ -31,18 +37,36 @@ m365 spo site set [options]
31
37
  `--siteDesignId [siteDesignId]`
32
38
  : Id of the custom site design to apply to the site
33
39
 
34
- `--title [title]`
35
- : The new title for the site collection
36
-
37
- `--description [description]`
38
- : The site description
39
-
40
40
  `--sharingCapability [sharingCapability]`
41
41
  : The sharing capability for the site. Allowed values: `Disabled`, `ExternalUserSharingOnly`, `ExternalUserAndGuestSharing`, `ExistingExternalUserSharingOnly`.
42
42
 
43
43
  `--siteLogoUrl [siteLogoUrl]`
44
44
  : Set the logo for the site collection. This can be an absolute or relative URL to a file on the current site collection.
45
45
 
46
+ `--resourceQuota [resourceQuota]`
47
+ : The quota for this site collection in Sandboxed Solutions units
48
+
49
+ `--resourceQuotaWarningLevel [resourceQuotaWarningLevel]`
50
+ : The warning level for the resource quota
51
+
52
+ `--storageQuota [storageQuota]`
53
+ : The storage quota for this site collection in megabytes
54
+
55
+ `--storageQuotaWarningLevel [storageQuotaWarningLevel]`
56
+ : The warning level for the storage quota in megabytes
57
+
58
+ `--allowSelfServiceUpgrade [allowSelfServiceUpgrade]`
59
+ : Set to allow tenant administrators to upgrade the site collection
60
+
61
+ `--lockState [lockState]`
62
+ : Sets site's lock state. Allowed values `Unlock,NoAdditions,ReadOnly,NoAccess`
63
+
64
+ `--noScriptSite [noScriptSite]`
65
+ : Specifies if the site allows custom script or not
66
+
67
+ `--wait`
68
+ : Wait for the settings to be applied before completing the command
69
+
46
70
  --8<-- "docs/cmd/_global.md"
47
71
 
48
72
  !!! important
@@ -56,6 +80,20 @@ The `isPublic` property can be set only on groupified site collections. If you t
56
80
 
57
81
  When setting owners, the specified owners will be added to the already configured owners. Existing owners will not be removed.
58
82
 
83
+ The value of the `--resourceQuota` option must not exceed the company's aggregate available Sandboxed Solutions quota. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010: [http://msdn.microsoft.com/en-us/library/gg615462.aspx](http://msdn.microsoft.com/en-us/library/gg615462.aspx).
84
+
85
+ The value of the `--resourceQuotaWarningLevel` option must not exceed the value of the `--resourceQuota` option or the current value of the _UserCodeMaximumLevel_ property.
86
+
87
+ The value of the `--storageQuota` option must not exceed the company's available quota.
88
+
89
+ The value of the `--storageQuotaWarningLevel` option must not exceed the the value of the `--storageQuota` option or the current value of the _StorageMaximumLevel_ property.
90
+
91
+ For more information on locking sites see [https://technet.microsoft.com/en-us/library/cc263238.aspx](https://technet.microsoft.com/en-us/library/cc263238.aspx).
92
+
93
+ For more information on configuring no script sites see [https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f](https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f).
94
+
95
+ Setting site properties is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully configured, you should use the `--wait` flag. When using this flag, the `spo site set` command will keep running until it received confirmation from Microsoft 365 that the site has been fully configured.
96
+
59
97
  ## Examples
60
98
 
61
99
  Update site collection's classification
@@ -129,3 +167,9 @@ Unset the logo on the site
129
167
  ```sh
130
168
  m365 spo site set --url https://estruyfdev2.sharepoint.com/sites/sales --siteLogoUrl ""
131
169
  ```
170
+
171
+ Lock the site preventing users from accessing it. Wait for the configuration to complete
172
+
173
+ ```sh
174
+ m365 spo site set --url https://contoso.sharepoint.com/sites/team --LockState NoAccess --wait
175
+ ```
@@ -22,10 +22,10 @@ m365 teams tab get [options]
22
22
  `--channelName [channelName]`
23
23
  : The display name of the Microsoft Teams channel where the tab is located. Specify either channelId or channelName but not both
24
24
 
25
- `--tabId [tabId]`
25
+ `-i, --tabId [tabId]`
26
26
  : The ID of the Microsoft Teams tab. Specify either tabId or tabName but not both
27
27
 
28
- `--tabName [tabName]`
28
+ `-n, --tabName [tabName]`
29
29
  : The display name of the Microsoft Teams tab. Specify either tabId or tabName but not both
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
@@ -10,8 +10,14 @@ m365 teams team archive [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --teamId <teamId>`
14
- : The ID of the Microsoft Teams team to archive
13
+ `-i, --id [id]`
14
+ : The ID of the Microsoft Teams team to archive. Specify either id or name but not both
15
+
16
+ `-n, --name [name]`
17
+ : The display name of the Microsoft Teams team to archive. Specify either id or name but not both
18
+
19
+ `--teamId [teamId]`
20
+ : (deprecated. Use `id` instead) The ID of the Microsoft Teams team to archive
15
21
 
16
22
  `--shouldSetSpoSiteReadOnlyForMembers`
17
23
  : Sets the permissions for team members to read-only on the SharePoint Online site associated with the team
@@ -22,18 +28,27 @@ m365 teams team archive [options]
22
28
 
23
29
  Using this command, global admins and Microsoft Teams service admins can access teams that they are not a member of.
24
30
 
31
+ If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
32
+
25
33
  When a team is archived, users can no longer send or like messages on any channel in the team, edit the team's name, description, or other settings, or in general make most changes to the team. Membership changes to the team continue to be allowed.
26
34
 
35
+
27
36
  ## Examples
28
37
 
29
- Archive the specified Microsoft Teams team
38
+ Archive the specified Microsoft Teams team with id _6f6fd3f7-9ba5-4488-bbe6-a789004d0d55_
39
+
40
+ ```sh
41
+ m365 teams team archive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
42
+ ```
43
+
44
+ Archive the specified Microsoft Teams team with name _Team Name_
30
45
 
31
46
  ```sh
32
- m365 teams team archive --teamId 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
47
+ m365 teams team archive --name "Team Name"
33
48
  ```
34
49
 
35
50
  Archive the specified Microsoft Teams team and set permissions for team members to read-only on the SharePoint Online site associated with the team
36
51
 
37
52
  ```sh
38
- m365 teams team archive --teamId 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55 --shouldSetSpoSiteReadOnlyForMembers
53
+ m365 teams team archive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55 --shouldSetSpoSiteReadOnlyForMembers
39
54
  ```
@@ -10,11 +10,17 @@ m365 teams team clone [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --teamId <teamId>`
13
+ `-i, --id [id]`
14
14
  : The ID of the Microsoft Teams team to clone
15
15
 
16
- `-n, --displayName <displayName>`
17
- : The display name for the new Microsoft Teams Team
16
+ `--teamId [teamId]`
17
+ : (deprecated. Use `id` instead) The ID of the Microsoft Teams team to clone
18
+
19
+ `-n, --name [name]`
20
+ : The display name for the new Microsoft Teams Team to clone
21
+
22
+ `--displayName [displayName]`
23
+ : (deprecated. Use `name` instead) The display name for the new Microsoft Teams Team to clone
18
24
 
19
25
  `-p, --partsToClone <partsToClone>`
20
26
  : A comma-separated list of the parts to clone. Allowed values are `apps,channels,members,settings,tabs`
@@ -41,11 +47,11 @@ When tabs are cloned, they are put into an unconfigured state. The first time yo
41
47
  Creates a clone of a Microsoft Teams team with mandatory parameters
42
48
 
43
49
  ```sh
44
- m365 teams team clone --teamId 15d7a78e-fd77-4599-97a5-dbb6372846c5 --displayName "Library Assist" --partsToClone "apps,tabs,settings,channels,members"
50
+ m365 teams team clone --id 15d7a78e-fd77-4599-97a5-dbb6372846c5 --name "Library Assist" --partsToClone "apps,tabs,settings,channels,members"
45
51
  ```
46
52
 
47
53
  Creates a clone of a Microsoft Teams team with mandatory and optional parameters
48
54
 
49
55
  ```sh
50
- m365 teams team clone --teamId 15d7a78e-fd77-4599-97a5-dbb6372846c5 --displayName "Library Assist" --partsToClone "apps,tabs,settings,channels,members" --description "Self help community for library" --classification "Library" --visibility "public"
56
+ m365 teams team clone --id 15d7a78e-fd77-4599-97a5-dbb6372846c5 --name "Library Assist" --partsToClone "apps,tabs,settings,channels,members" --description "Self help community for library" --classification "Library" --visibility "public"
51
57
  ```
@@ -10,8 +10,14 @@ m365 teams team remove [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --teamId <teamId>`
14
- : The ID of the Teams team to remove
13
+ `-i, --id [id]`
14
+ : The ID of the Microsoft Teams team to remove. Specify either id or name but not both
15
+
16
+ `-n, --name [name]`
17
+ : The display name of the Microsoft Teams team to remove. Specify either id or name but not both
18
+
19
+ `--teamId [teamId]`
20
+ : (deprecated. Use `id` instead) The ID of the Teams team to remove
15
21
 
16
22
  `--confirm`
17
23
  : Don't prompt for confirming removing the specified team
@@ -22,18 +28,26 @@ m365 teams team remove [options]
22
28
 
23
29
  When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This applies only to Microsoft 365 groups.
24
30
 
31
+ If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
32
+
25
33
  ## Examples
26
34
 
27
- Removes the specified team
35
+ Removes the specified Microsoft Teams team with id _00000000-0000-0000-0000-000000000000_
36
+
37
+ ```sh
38
+ m365 teams team remove --id 00000000-0000-0000-0000-000000000000
39
+ ```
40
+
41
+ Removes the specified Microsoft Teams team with name _Team Name_
28
42
 
29
43
  ```sh
30
- m365 teams team remove --teamId '00000000-0000-0000-0000-000000000000'
44
+ m365 teams team remove --name "Team Name"
31
45
  ```
32
46
 
33
47
  Removes the specified team without confirmation
34
48
 
35
49
  ```sh
36
- m365 teams team remove --teamId '00000000-0000-0000-0000-000000000000' --confirm
50
+ m365 teams team remove --id 00000000-0000-0000-0000-000000000000 --confirm
37
51
  ```
38
52
 
39
53
  ## More information
@@ -10,11 +10,17 @@ m365 teams team set [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --teamId <teamId>`
13
+ `-i, --id [id]`
14
14
  : The ID of the Microsoft Teams team for which to update settings
15
15
 
16
+ `--teamId [teamId]`
17
+ : (deprecated. Use `id` instead) The ID of the Microsoft Teams team for which to update settings
18
+
19
+ `-n, --name [name]`
20
+ : The display name for the Microsoft Teams team for which to update settings
21
+
16
22
  `--displayName [displayName]`
17
- : The display name for the Microsoft Teams team
23
+ : (deprecated. Use `name` instead) The display name for the Microsoft Teams team for which to update settings
18
24
 
19
25
  `--description [description]`
20
26
  : The description for the Microsoft Teams team
@@ -35,11 +41,11 @@ m365 teams team set [options]
35
41
  Set Microsoft Teams team visibility as Private
36
42
 
37
43
  ```sh
38
- m365 teams team set --teamId '00000000-0000-0000-0000-000000000000' --visibility Private
44
+ m365 teams team set --id "00000000-0000-0000-0000-000000000000" --visibility Private
39
45
  ```
40
46
 
41
47
  Set Microsoft Teams team classification as MBI
42
48
 
43
49
  ```sh
44
- m365 teams team set --teamId '00000000-0000-0000-0000-000000000000' --classification MBI
50
+ m365 teams team set --id "00000000-0000-0000-0000-000000000000" --classification MBI
45
51
  ```
@@ -10,8 +10,14 @@ m365 teams team unarchive [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-i, --teamId <teamId>`
14
- : The ID of the Microsoft Teams team to restore
13
+ `-i, --id [id]`
14
+ : The ID of the Microsoft Teams team to restore. Specify either id or name but not both
15
+
16
+ `-n, --name [name]`
17
+ : The display name of the Microsoft Teams team to restore. Specify either id or name but not both
18
+
19
+ `--teamId [teamId]`
20
+ : (deprecated. Use `id` instead) The ID of the Microsoft Teams team to restore
15
21
 
16
22
  --8<-- "docs/cmd/_global.md"
17
23
 
@@ -19,12 +25,20 @@ m365 teams team unarchive [options]
19
25
 
20
26
  This command supports admin permissions. Global admins and Microsoft Teams service admins can restore teams that they are not a member of.
21
27
 
28
+ If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
29
+
22
30
  This command restores users' ability to send messages and edit the team, abiding by tenant and team settings.
23
31
 
24
32
  ## Examples
25
33
 
26
- Restore an archived Microsoft Teams team
34
+ Restore an archived Microsoft Teams team with id _6f6fd3f7-9ba5-4488-bbe6-a789004d0d55_
35
+
36
+ ```sh
37
+ m365 teams team unarchive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
38
+ ```
39
+
40
+ Restore an archived Microsoft Teams team with name _Team Name_
27
41
 
28
42
  ```sh
29
- m365 teams team unarchive --teamId 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
43
+ m365 teams team unarchive --name "Team Name"
30
44
  ```