@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.1cd2525

package/docs/docs/cmd/spo/site/site-set.mdx

@@ -0,0 +1,182 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site set
+
+Updates properties of the specified site
+
+## Usage
+
+```sh
+m365 spo site set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: The URL of the site collection to update
+
+`-t, --title [title]`
+: The new title for the site collection
+
+`-d, --description [description]`
+: The site description
+
+`--classification [classification]`
+: The new classification for the site collection
+
+`--disableFlows [disableFlows]`
+: Set to `true` to disable using Microsoft Flow in this site collection
+
+`--isPublic [isPublic]`
+: Set to `true` to make the group linked to the site public or to `false` to make it private
+
+`--owners [owners]`
+: Comma-separated list of users to add as site collection administrators
+
+`--shareByEmailEnabled [shareByEmailEnabled]`
+: Set to true to allow to share files with guests and to false to disallow it
+
+`--siteDesignId [siteDesignId]`
+: Id of the custom site design to apply to the site
+
+`--sharingCapability [sharingCapability]`
+: The sharing capability for the site. Allowed values:  `Disabled`, `ExternalUserSharingOnly`, `ExternalUserAndGuestSharing`, `ExistingExternalUserSharingOnly`.
+
+`--siteLogoUrl [siteLogoUrl]`
+: Set the logo for the site collection. This can be an absolute or relative URL to a file on the current site collection.
+
+`--resourceQuota [resourceQuota]`
+: The quota for this site collection in Sandboxed Solutions units
+
+`--resourceQuotaWarningLevel [resourceQuotaWarningLevel]`
+: The warning level for the resource quota
+
+`--storageQuota [storageQuota]`
+: The storage quota for this site collection in megabytes
+
+`--storageQuotaWarningLevel [storageQuotaWarningLevel]`
+: The warning level for the storage quota in megabytes
+
+`--allowSelfServiceUpgrade [allowSelfServiceUpgrade]`
+: Set to allow tenant administrators to upgrade the site collection
+
+`--lockState [lockState]`
+: Sets site's lock state. Allowed values `Unlock`, `NoAdditions`, `ReadOnly`, `NoAccess`
+
+`--noScriptSite [noScriptSite]`
+: Specifies if the site allows custom script or not
+
+`--wait`
+: Wait for the settings to be applied before completing the command
+```
+
+<Global />
+
+## Remarks
+
+If the specified url doesn't refer to an existing site collection, you will get a `404 - "404 FILE NOT FOUND"` error.
+
+The `isPublic` property can be set only on groupified site collections. If you try to set it on a site collection without a group, you will get an error.
+
+When setting owners, the specified owners will be added to the already configured owners. Existing owners will not be removed.
+
+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).
+
+The value of the `--resourceQuotaWarningLevel` option must not exceed the value of the `--resourceQuota` option or the current value of the _UserCodeMaximumLevel_ property.
+
+The value of the `--storageQuota` option must not exceed the company's available quota.
+
+The value of the `--storageQuotaWarningLevel` option must not exceed the the value of the `--storageQuota` option or the current value of the _StorageMaximumLevel_ property.
+
+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).
+
+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).
+
+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.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+    
+## Examples
+
+Update site collection's classification
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --classification MBI
+```
+
+Reset site collection's classification.
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --classification
+```
+
+Disable using Microsoft Flow on the site collection
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --disableFlows true
+```
+
+Update the visibility of the Microsoft 365 group behind the specified groupified site collection to public
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --isPublic true
+```
+
+Update site collection's owners
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --owners "john@contoso.onmicrosoft.com,steve@contoso.onmicrosoft.com"
+```
+
+Allow sharing files in the site collection with guests
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --shareByEmailEnabled true
+```
+
+Apply the specified site ID to the site collection
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --siteDesignId "eb2f31da-9461-4fbf-9ea1-9959b134b89e"
+```
+
+Update site collection's title
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --title "My new site"
+```
+
+Update site collection's description
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --description "my description"
+```
+
+Restrict external sharing to already available external users only
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --sharingCapability ExistingExternalUserSharingOnly
+```
+
+Set the logo on the site
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --siteLogoUrl "/sites/sales/SiteAssets/parker-ms-1200.png"
+```
+
+Unset the logo on the site
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/sales --siteLogoUrl ""
+```
+
+Lock the site preventing users from accessing it. Wait for the configuration to complete
+
+```sh
+m365 spo site set --url https://contoso.sharepoint.com/sites/team --LockState NoAccess --wait
+```

package/docs/docs/cmd/spo/sitedesign/sitedesign-add.mdx

@@ -0,0 +1,67 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign add
+
+Adds site design for creating modern sites
+
+## Usage
+
+```sh
+m365 spo sitedesign add [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --title <title>`
+: The display name of the site design
+
+`-w, --webTemplate <webTemplate>`
+: Identifies which base template to add the design to. Allowed values `TeamSite,CommunicationSite`
+
+`-s, --siteScripts <siteScripts>`
+: Comma-separated list of site script IDs. The scripts will run in the order listed
+
+`-d, --description [description]`
+: The display description of site design
+
+`-m, --previewImageUrl [previewImageUrl]`
+: The URL of a preview image. If none is specified SharePoint will use a generic image
+
+`-a, --previewImageAltText [previewImageAltText]`
+: The alt text description of the image for accessibility
+
+`--thumbnailUrl [thumbnailUrl]`
+: The new URL of a thumbnail image. If none is specified SharePoint will use a generic image
+
+`--isDefault`
+: Set if the site design is applied as the default site design
+```
+
+<Global />
+
+## Remarks
+
+Each time you execute the `spo sitedesign add` command, it will create a new site design with a unique ID. Before creating a site design, be sure that another design with the same name doesn't already exist.
+
+When specifying IDs of site scripts to use with your site design, ensure that the IDs refer to existing site scripts or provisioning sites using the design will lead to unexpected results.
+
+## Examples
+
+Create new site design for provisioning modern team sites
+
+```sh
+m365 spo sitedesign add --title "Contoso team site" --webTemplate TeamSite --siteScripts "19b0e1b2-e3d1-473f-9394-f08c198ef43e,b2307a39-e878-458b-bc90-03bc578531d6"
+```
+
+Create new default site design for provisioning modern communication sites
+
+```sh
+m365 spo sitedesign add --title "Contoso communication site" --webTemplate CommunicationSite --siteScripts "19b0e1b2-e3d1-473f-9394-f08c198ef43e" --isDefault
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)
+- Customize a default site design: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design)
+- Site design JSON schema: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-json-schema](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-json-schema)

package/docs/docs/cmd/spo/sitedesign/sitedesign-apply.mdx

@@ -0,0 +1,44 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign apply
+
+Applies a site design to an existing site collection
+
+## Usage
+
+```sh
+m365 spo sitedesign apply [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the site design to apply
+
+`-u, --webUrl <webUrl>`
+: The URL of the site to apply the site design to
+
+`--asTask`
+: Apply site design as task. Required for large site designs
+```
+
+<Global />
+
+## Examples
+
+Apply the site design with ID 9b142c22-037f-4a7f-9017-e9d8c0e34b98 to the site collection https://contoso.sharepoint.com/sites/project-x
+
+```sh
+m365 spo sitedesign apply --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+Apply large site design to the specified site
+
+```sh
+m365 spo sitedesign apply --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webUrl https://contoso.sharepoint.com/sites/project-x --asTask
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-get.mdx

@@ -0,0 +1,45 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign get
+
+Gets information about the specified site design
+
+## Usage
+
+```sh
+m365 spo sitedesign get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: Site design ID. Specify either `id` or `title` but not both.
+
+`--title [title]`
+: Site design title. Specify either `id` or `title` but not both.
+```
+
+<Global />
+
+## Remarks
+
+If the specified `id` or `title` doesn't refer to an existing site design, you will get a `File not found` error.
+
+## Examples
+
+Get information about the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_
+
+```sh
+m365 spo sitedesign get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+```
+
+Get information about the site design with title _Contoso Site Design_
+
+```sh
+m365 spo sitedesign get --title "Contoso Site Design"
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-list.mdx

@@ -0,0 +1,27 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign list
+
+Lists available site designs for creating modern sites
+
+## Usage
+
+```sh
+m365 spo sitedesign list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+List available site designs
+
+```sh
+m365 spo sitedesign list
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-remove.mdx

@@ -0,0 +1,45 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign remove
+
+Removes the specified site design
+
+## Usage
+
+```sh
+m365 spo sitedesign remove [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: Site design ID
+
+`--confirm`
+: Don't prompt for confirming removing the site design
+```
+
+<Global />
+
+## Remarks
+
+If the specified `id` doesn't refer to an existing site design, you will get a `File not found` error.
+
+## Examples
+
+Remove site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_. Will prompt for confirmation before removing the design
+
+```sh
+m365 spo sitedesign remove --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+```
+
+Remove site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ without prompting for confirmation
+
+```sh
+m365 spo sitedesign remove --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --confirm
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-grant.mdx

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign rights grant
+
+Grants access to a site design for one or more principals
+
+## Usage
+
+```sh
+m365 spo sitedesign rights grant [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --siteDesignId <siteDesignId>`
+: The ID of the site design to grant rights on
+
+`-p, --principals <principals>`
+: Comma-separated list of principals to grant view rights. Principals can be users or mail-enabled security groups in the form of `alias` or `alias@<domain name>.com`
+
+`-r, --rights <rights>`
+: Rights to grant to principals. Available values `View`
+```
+
+<Global />
+
+## Examples
+
+Grant user with alias _PattiF_ view permission to the specified site design
+
+```sh
+m365 spo sitedesign rights grant --siteDesignId 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals PattiF --rights View
+```
+
+Grant users with aliases _PattiF_ and _AdeleV_ view permission to the specified site design
+
+```sh
+m365 spo sitedesign rights grant --siteDesignId 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals "PattiF,AdeleV" --rights View
+```
+
+Grant user by email view permission to the specified site design
+
+```sh
+m365 spo sitedesign rights grant --siteDesignId 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --principals PattiF@contoso.com --rights View
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-list.mdx

@@ -0,0 +1,38 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign rights list
+
+Gets a list of principals that have access to a site design
+
+## Usage
+
+```sh
+m365 spo sitedesign rights list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --siteDesignId <siteDesignId>`
+: The ID of the site design to get rights information from
+```
+
+<Global />
+
+## Remarks
+
+If the specified `siteDesignId` doesn't refer to an existing site script, you will get a `File not found` error.
+
+If no permissions are listed, it means that the particular site design is visible to everyone.
+
+## Examples
+
+Get information about rights granted for the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_
+
+```sh
+m365 spo sitedesign rights list --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-revoke.mdx

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign rights revoke
+
+Revokes access from a site design for one or more principals
+
+## Usage
+
+```sh
+m365 spo sitedesign rights revoke [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --siteDesignId <siteDesignId>`
+: The ID of the site design to revoke rights from
+
+`-p, --principals <principals>`
+: Comma-separated list of principals to revoke view rights from. Principals can be users or mail-enabled security groups in the form of `alias` or `alias@<domain name>.com`
+
+`--confirm`
+: Don't prompt for confirming removing the site design
+```
+
+<Global />
+
+## Remarks
+
+If the specified id doesn't refer to an existing site design, you will get a `File not found` error.
+
+If all principals have rights revoked on the site design, the site design becomes viewable to everyone.
+
+If you try to revoke access for a user that doesn't have access granted to the specified site design you will get a `The specified user or domain group was not found error`.
+
+## Examples
+
+Revoke access to the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from user with alias _PattiF_. Will prompt for confirmation before revoking the access
+
+```sh
+m365 spo sitedesign rights revoke --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals PattiF
+```
+
+Revoke access to the site design with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from users with aliases _PattiF_ and _AdeleV_ without prompting for confirmation
+
+```sh
+m365 spo sitedesign rights revoke --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --principals "PattiF,AdeleV" --confirm
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-run-list.mdx

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign run list
+
+Lists information about site designs applied to the specified site
+
+## Usage
+
+```sh
+m365 spo sitedesign run list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site for which to list applied site designs
+
+`-i, --siteDesignId [siteDesignId]`
+: The ID of the site design for which to display information
+```
+
+<Global />
+
+## Examples
+
+List site designs applied to the specified site
+
+```sh
+m365 spo sitedesign run list --webUrl https://contoso.sharepoint.com/sites/team-a
+```
+
+List information about the specified site design applied to the specified site
+
+```sh
+m365 spo sitedesign run list --webUrl https://contoso.sharepoint.com/sites/team-a --siteDesignId 6ec3ca5b-d04b-4381-b169-61378556d76e
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-run-status-get.mdx

@@ -0,0 +1,39 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign run status get
+
+Gets information about the site scripts executed for the specified site design
+
+## Usage
+
+```sh
+m365 spo sitedesign run status get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site for which to get the information
+
+`-i, --runId <runId>`
+: ID of the site design applied to the site as retrieved using `spo sitedesign run list`
+```
+
+<Global />
+
+## Remarks
+
+For text output mode, displays the name of the action, site script and the outcome of the action. For JSON output mode, displays all available information.
+
+## Examples
+
+List information about site scripts executed for the specified site design
+
+```sh
+m365 spo sitedesign run status get --webUrl https://contoso.sharepoint.com/sites/team-a --runId b4411557-308b-4545-a3c4-55297d5cd8c8
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)