Skip to content

Start-SPOSiteRename.md

Latest commit

 

History

History
236 lines (173 loc) · 5.82 KB

Start-SPOSiteRename.md

File metadata and controls

236 lines (173 loc) · 5.82 KB
external help file sharepointonline.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/sharepoint-online/start-spositerename
applicable SharePoint Online
title Start-SPOSiteRename
schema 2.0.0
author trent-green
ms.author trgreen
ms.reviewer

Start-SPOSiteRename

SYNOPSIS

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

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

$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

-Identity

Specifies the original URL of the site collection.

Type: String
Parameter Sets: Default
Aliases:
Applicable: SharePoint Online

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NewSiteUrl

Specifies the new desired URL.

Type: String
Parameter Sets: Default
Applicable: SharePoint Online

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NewSiteTitle

Specifies the new Title of the site.

Type: String
Parameter Sets: Default
Aliases:
Applicable: SharePoint Online

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SuppressMarketplaceAppCheck

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SuppressWorkflow2013Check

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidationOnly

Verifies that the site address can be changed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Reserved

Reserved for Microsoft internal use.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: String
Parameter Sets: UrlAndDestinationDataLocation, UrlAndDestinationUrl
Aliases:
Applicable: SharePoint Online

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

RELATED LINKS

Getting started with SharePoint Online Management Shell

Get-SPOAppErrors

Start-SPOUserAndContentMove

Stop-SPOUserAndContentMove

Get-SPOUserAndContentMoveState