Start-SPOTenantRename
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
Default (Default)
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
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 |
-DomainName
Applicable: SharePoint Online
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.
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 |
-ScheduledDateTime
Applicable: SharePoint Online
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.
Parameter properties
| Type: | System.DateTime |
| 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 |
-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.