Skip to main content

spo homesite set

Sets the specified site as the Home Site

Usage

m365 spo homesite set [options]

Options

-u, --siteUrl <siteUrl>

The URL of the site to set as Home site.

--vivaConnectionsDefaultStart [vivaConnectionsDefaultStart]

When set to true, the Viva Connections landing experience is set to the SharePoint home site. If set to false, the Viva Connections home experience will be used.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Remarks

info

To use this command you must be a Global or SharePoint administrator.

Examples

Set the specified site as the Home Site.

m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms

Sets the Home site to the provided site collection url and sets the Viva Connections landing experience to the SharePoint home site

m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms --vivaConnectionsDefaultStart true

Sets the Home site to the provided site collection url and sets the Viva Connections landing experience to the default experience

m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms --vivaConnectionsDefaultStart false

Response

Standard response

"The Home site has been set to https://contoso.sharepoint.com. It may take some time for the change to apply. Check aka.ms/homesites for details."

vivaConnectionsDefaultStart response

When we make use of the option vivaConnectionsDefaultStart the response will differ.

"The Home site has been set to https://contoso.sharepoint.com and the Viva Connections default experience to True. It may take some time for the change to apply. Check aka.ms/homesites for details."

More information

CTRL + M