Commands › SharePoint Online

Set-SPOHomeSite

SharePoint Online Microsoft.Online.SharePoint.PowerShell Set-*

Sets a SharePoint Site as a Home Site.

Quick start script

# Set-SPOHomeSite — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-SPOService -Url https://$org-admin.sharepoint.com

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-SPOHomeSite
$before | Format-List

# 3. Make the change
Set-SPOHomeSite -HomeSiteUrl <String>

# 4. Verify and diff
$after = Get-SPOHomeSite
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-SPOHomeSite -HomeSiteUrl <String> [-VivaConnectionsDefaultStart <Boolean>] [-Force] [-DraftMode <Boolean>]
 [<CommonParameters>]

Parameters (4)

Parameter	Type	Required	What it controls
-DraftMode	Boolean		Whether to set the home site to draft mode.
-Force	SwitchParameter		Whether to set the home site without prompting for confirmation.
-HomeSiteUrl	String	yes	Sets the URL of the site collection to be the home site.
-VivaConnectionsDefaultStart	Boolean		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...

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.