Set-SPOHomeSite

Module:

Microsoft.Online.SharePoint.PowerShell

Applies to:

SharePoint Online

Sets a SharePoint Site as a Home Site.

Syntax

Set-SPOHomeSite
   -HomeSiteUrl <String>
   [-VivaConnectionsDefaultStart <SwitchParameter>]
   [<CommonParameters>]

Description

Use this cmdlet to set a SharePoint Site as a Home Site. A home site is a communication site that you create and set as the top landing page for all users in your intranet. For more information, see Set up a home site for your organization

Examples

Example 1

Set-SPOHomeSite -HomeSiteUrl "https://contoso.sharepoint.com/sites/homesite"
This example set the site collection at *<https://contoso.sharepoint.com/sites/homesite>* as SharePoint Online Home Site.

Example 2

Set-SPOHomeSite -HomeSiteUrl "https://contoso.sharepoint.com/sites/homesite" -VivaConnectionsDefaultStart:$true
Sets the home site to the provided site collection url and keeps the Viva Connections landing experience to the SharePoint home site.

Parameters

-HomeSiteUrl

Sets the URL of the site collection to be the home site.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-VivaConnectionsDefaultStart

When set to $true, the VivaConnectionsDefaultStart parameter will keep the Viva Connections landing experience to the SharePoint home site for the desktop experience. If set to $false, the Viva Connections home experience will be used. This command doesn't impact the mobile experience.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

System.Object