Commands › SharePoint Online

Get-SPOSiteRenameState

SharePoint Online Microsoft.Online.SharePoint.PowerShell Get-*

Returns the current rename job state of a SharePoint Online Site.

Quick start script

# Get-SPOSiteRenameState — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-SPOService -Url https://$org-admin.sharepoint.com

# 2. Run and inspect
Get-SPOSiteRenameState -Identity <SpoSitePipeBind> -ParentOperationId <Guid> | Format-List

# 3. Export for evidence / drift tracking
Get-SPOSiteRenameState | Export-Clixml .\SPOSiteRenameState-$(Get-Date -Format yyyyMMdd).xml

Syntax — 3 parameter sets

SourceSiteUrl (Default)

Get-SPOSiteRenameState -Identity <SpoSitePipeBind> [-WhatIf] [-Confirm] [<CommonParameters>]

ParentId

Get-SPOSiteRenameState -ParentOperationId <Guid> [-State <RenameState>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

RenameReport

Get-SPOSiteRenameState [-State <RenameState>] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters (5)

Parameter	Type	Required	What it controls
-Identity	SpoSitePipeBind	yes	The urls of the site to be renamed.
-ParentOperationId	Guid	yes	The parent operation id that initiated the site to be renamed. For example, the tenant rename job id.
-State	RenameState		The state of the rename job, possible values are
-Confirm	SwitchParameter		Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`
-WhatIf	SwitchParameter		Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters`

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.