Commands › SharePoint Online

Start-SPOSiteRename

SharePoint Online Microsoft.Online.SharePoint.PowerShell Start-*

> [!NOTE] > This Feature is part of the Admin Center Preview. If your tenant is not part of the Admin Center Preview, you will get an error when trying to run this cmdlet. Starts a job to rename a site. You can change the URL, and optionally the site title along with changing the URL, of a site on a SharePoint Online collection.

Quick start script

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

# 2. Run and inspect
Start-SPOSiteRename -Identity <SpoSitePipeBind> -NewSiteTitle <String> -NewSiteUrl <String> | Format-List

# 3. Export for evidence / drift tracking
Start-SPOSiteRename | Export-Clixml .\SPOSiteRename-$(Get-Date -Format yyyyMMdd).xml

Syntax

Start-SPOSiteRename -Identity <SpoSitePipeBind> -NewSiteUrl <String> [-NewSiteTitle <String>]
 [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] [-SuppressBcsCheck]
 [-ValidationOnly] [-Reserved <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters (11)

Parameter	Type	Required	What it controls
-Identity	SpoSitePipeBind	yes	Specifies the original URL of the site collection.
-NewSiteTitle	String	yes	Specifies the new Title of the site.
-NewSiteUrl	String	yes	Specifies the new desired URL.
-Reserved	String		Reserved for Microsoft internal use.
-SuppressAllWarnings	SwitchParameter		Whether to suppress all warning messages.
-SuppressBcsCheck	SwitchParameter		Whether to surpress checking whether tenant is using Business Connectivity Service (BCS) feature.
-SuppressMarketplaceAppCheck	SwitchParameter		Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site.
-SuppressWorkflow2013Check	SwitchParameter		Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site.
-ValidationOnly	SwitchParameter		Verifies that the site address can be changed.
-Confirm	SwitchParameter		Prompts you for confirmation before running the cmdlet.
-WhatIf	SwitchParameter		Shows what would happen if the cmdlet runs. The cmdlet is not run.

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