Edit

Share via

Start-SPOSiteRename

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

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.

Syntax

PowerShell 
Start-SPOSiteRename
     [-Identity] <SpoSitePipeBind>
     [-NewSiteUrl] <string>
     [[-NewSiteTitle] <string>]
        [[-SuppressMarketplaceAppCheck]]
     [[-SuppressWorkflow2013Check]]
     [-ValidationOnly]
     [[-Reserved] <string>]
     [-WhatIf]
     [-Confirm]   
     [<CommonParameters>]

Description

This command starts a rename of a site on a SharePoint Online site. You can change the URL, and optionally the site title along with changing the URL. Also allows you to simulate the run using the -WhatIf parameter as well as -SuppressWorkflow2013Check and SuppressMarketplaceAppCheck switch parameters.

Examples

EXAMPLE 1

PowerShell 
$url="https://<tenant>.sharepoint.com/sites/samplesite"
$NewSiteUrl="https://<tenant>.sharepoint.com/sites/renamed"
Start-SPOSiteRename -Identity $url -NewSiteUrl $NewSiteUrl

Starts the rename of the SPO site with name "samplesite" to "renamed" without modifying the title.

EXAMPLE 2

PowerShell 
$url="https://<tenant>.sharepoint.com/sites/samplesite"
$NewSiteUrl="https://<tenant>.sharepoint.com/sites/renamed"
$newTitle="New Title"
Start-SPOSiteRename -Identity $url -NewSiteUrl $NewSiteUrl -NewSiteTitle $newTitle

Starts the rename of the SPO site with name "samplesite" to "renamed" modifying the title of the site to "New Title"

EXAMPLE 3

PowerShell 
$url="https://<tenant>.sharepoint.com/sites/samplesite"
$NewSiteUrl="https://<tenant>.sharepoint.com/sites/renamed"
$newTitle="New Title"
Start-SPOSiteRename -Identity $url -NewSiteUrl $NewSiteUrl -NewSiteTitle $newTitle -SuppressMarketplaceAppCheck -SuppressWorkflow2013Check -WhatIf

Starts the simulation rename of the SPO site with name "samplesite" to "renamed" modifying the title of the site to "New Title" without MarketPlaceAppCheck and without WorkFlow2013Check

Parameters

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-Identity

Specifies the original URL of the site collection.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-NewSiteTitle

Specifies the new Title of the site.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-NewSiteUrl

Specifies the new desired URL.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-Reserved

Reserved for Microsoft internal use.

Type:String
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-SuppressMarketplaceAppCheck

Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site.

Type:SwitchParameter
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-SuppressWorkflow2013Check

Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site.

Type:SwitchParameter
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-ValidationOnly

Verifies that the site address can be changed.

Type:SwitchParameter
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-WhatIf

Simulation of what would happen if you run the script without modifying anything.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online