Start-SPOSiteRename
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
Default (Default)
Start-SPOSiteRename
-Identity <SpoSitePipeBind>
-NewSiteUrl <String>
[-NewSiteTitle <String>]
[-SuppressMarketplaceAppCheck]
[-SuppressWorkflow2013Check]
[-SuppressAllWarnings]
[-SuppressBcsCheck]
[-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
$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
$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
$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
Applicable: SharePoint Online Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Online
Specifies the original URL of the site collection.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NewSiteTitle
Applicable: SharePoint Online
Specifies the new Title of the site.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NewSiteUrl
Applicable: SharePoint Online
Specifies the new desired URL.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Reserved
Applicable: SharePoint Online
Reserved for Microsoft internal use.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SuppressAllWarnings
{{ Fill SuppressAllWarnings Description }}
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SuppressBcsCheck
{{ Fill SuppressBcsCheck Description }}
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SuppressMarketplaceAppCheck
Applicable: SharePoint Online
Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SuppressWorkflow2013Check
Applicable: SharePoint Online
Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ValidationOnly
Applicable: SharePoint Online
Verifies that the site address can be changed.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.