@pnp/cli-microsoft365 5.5.0-beta.f0f7ad7 → 5.6.0-beta.18a47a8

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 (36) hide show
  1. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  2. package/dist/m365/spo/commands/customaction/customaction-get.js +32 -4
  3. package/dist/m365/spo/commands/customaction/customaction-remove.js +43 -8
  4. package/dist/m365/spo/commands/field/field-get.js +14 -5
  5. package/dist/m365/spo/commands/field/field-remove.js +19 -10
  6. package/dist/m365/spo/commands/field/field-set.js +16 -9
  7. package/dist/m365/spo/commands/group/group-add.js +96 -0
  8. package/dist/m365/spo/commands/group/group-set.js +167 -0
  9. package/dist/m365/spo/commands/hubsite/hubsite-get.js +38 -2
  10. package/dist/m365/spo/commands/site/site-classic-list.js +1 -0
  11. package/dist/m365/spo/commands/site/site-classic-set.js +1 -0
  12. package/dist/m365/spo/commands/site/site-list.js +59 -17
  13. package/dist/m365/spo/commands/site/site-set.js +322 -162
  14. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +9 -6
  15. package/dist/m365/spo/commands.js +2 -0
  16. package/dist/m365/teams/commands/tab/tab-get.js +2 -2
  17. package/dist/m365/teams/commands/team/team-clone.js +33 -7
  18. package/dist/m365/teams/commands/team/team-set.js +25 -5
  19. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  20. package/docs/docs/cmd/spo/customaction/customaction-get.md +15 -2
  21. package/docs/docs/cmd/spo/customaction/customaction-remove.md +33 -2
  22. package/docs/docs/cmd/spo/field/field-get.md +6 -3
  23. package/docs/docs/cmd/spo/field/field-remove.md +9 -6
  24. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  25. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  26. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  27. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +21 -0
  28. package/docs/docs/cmd/spo/site/site-classic-list.md +3 -0
  29. package/docs/docs/cmd/spo/site/site-classic-set.md +3 -0
  30. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  31. package/docs/docs/cmd/spo/site/site-set.md +50 -6
  32. package/docs/docs/cmd/teams/tab/tab-get.md +2 -2
  33. package/docs/docs/cmd/teams/team/team-clone.md +11 -5
  34. package/docs/docs/cmd/teams/team/team-set.md +10 -4
  35. package/npm-shrinkwrap.json +175 -160
  36. package/package.json +13 -13
@@ -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
+ : type of sites to list. Allowed values are `TeamSite,CommunicationSite,All`. The default value is `TeamSite`.
15
+
16
+ `--webTemplate [webTemplate]`
17
+ : types 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. Can only be used in combination with `type` All.
24
+
19
25
  `--deleted`
20
26
  : use this switch to only return deleted sites
21
27
 
@@ -32,30 +38,36 @@ When using the text output type (default), the command lists only the values of
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
- m365 spo site list
44
+ m365 spo site list --type All
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 --type All --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,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,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
  ```