Rename-PnPTenantSite
SYNOPSIS
Starts a rename of a site on a SharePoint Online site.
SYNTAX
Rename-PnPTenantSite [[-Identity] <SPOSitePipeBind>] [[-NewSiteUrl] <String>] [[-NewSiteTitle] <string>]
[[-SuppressMarketplaceAppCheck] [<SwitchParameter>]] [[-SuppressWorkflow2013Check] [<SwitchParameter>]] [[-SuppressBcsCheck] [<SwitchParameter>]] [-Connection <PnPConnection>]
DESCRIPTION
This cmdlet 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.
This will not work between Multi-geo environments.
EXAMPLES
EXAMPLE 1
$currentSiteUrl = "https://<tenant>.sharepoint.com/site/samplesite"
$updatedSiteUrl = "https://<tenant>.sharepoint.com/site/renamed"
Rename-PnPTenantSite -Identity $currentSiteUrl -NewSiteUrl $updatedSiteUrl
Starts the rename of the SharePoint Online site with name "samplesite" to "renamed" without modifying the title.
PARAMETERS
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
Specifies the full URL of the SharePoint Online site collection that needs to be renamed.
Type: SPOSitePipeBind
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: True
Accept wildcard characters: False
-NewSiteUrl
Specifies the full URL of the SharePoint Online site collection to which it needs to be renamed.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewSiteTitle
Specifies the new title of the SharePoint Site.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
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)
Required: False
Position: Named
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)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SuppressBcsCheck
Suppress checking compatibility of BCS connections deployed to the associated site.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: True
Accept wildcard characters: False
-Wait
Wait till the renaming of the new site collection is successful. If not specified, a job will be created which you can use to check for its status.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False