Edit

Start-SPOTenantRename

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

Important

This feature is currently available to organizations that have no more than 10,000 total SharePoint sites and OneDrive accounts combined. Additionally, tenant renaming capability is not available for GCC, GCC High, and DoD.

Starts a job to change the SharePoint domain name for your organization in Microsoft 365. For example, if the name of your organization changes from "Contoso" to "Fabrikam," you can change contoso.sharepoint.com to fabrikam.sharepoint.com.

Warning

Changing your SharePoint domain name might take several hours to days depending on the number of sites and OneDrive users that you have. We strongly recommend that you make this change during a period of low usage (like a weekend) and tell users to avoid accessing SharePoint and OneDrive content during the change. In addition, any actions that create new OneDrives and sites (such as creating a new team or private channel in Microsoft Teams) will be temporarily blocked during the rename.

Syntax

Start-SPOTenantRename
     -DomainName <string>
     -ScheduledDateTime <datetime>
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

This command schedules a rename of the SharePoint domain name for your organization.

Examples

EXAMPLE 1

Start-SPOTenantRename -DomainName "fabrikam" -ScheduledDateTime "2021-12-31T10:25:00"

Starts the rename of the SharePoint domain name to Fabrikam which is scheduled for December 31, 2021, at 10:25:00 am.

Parameters

-Confirm

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

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

-DomainName

Specifies the domain name that the current SharePoint domain name will be renamed to. This is the part before "sharepoint.com" or "onmicrosoft.com".

Note

The domain name must already have been successfully added to Microsoft Entra ID as per the instructions at Step 1: Add the new domain name. If the domain name does not exist or was not successfully added, then this cmdlet will return an error.

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

-ScheduledDateTime

Specifies the date-time that the job will be started. This should be at least 24 hours in the future, but no more than 30 days.

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

-WhatIf

Not supported for this cmdlet.

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