Get-SPOSiteRenameState

Reference

Module:: Microsoft.Online.SharePoint.PowerShell

Applies to:: SharePoint Online

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

Syntax

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

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

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

Description

Use this cmdlet to return the current rename job state of a SharePoint Online Site.

Examples

Example 1

Get-SPOSiteRenameState -Identity https://contoso.sharepoint.com/sites/ContosoWeb1

This example returns the rename job state of ContosoWeb1 Site.

Example 2

Get-SPOSiteRenameState -State InProgress

This example returns rename jobs that are in InProgress state.

Example 3

$tenantRenameJobId = (Get-SPOTenantRenameStatus).RenameJobId
Get-SPOSiteRenameState -ParentOperationId $tenantRenameJobId

This example returns rename jobs that were initiated by a tenant rename.

Parameters

-Confirm

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

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

-Identity

The urls of the site to be renamed.

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

-ParentOperationId

The parent operation id that initiated the site to be renamed. For example, the tenant rename job id.

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

-State

The state of the rename job, possible values are

Queued
InProgress
Success
Failed
Suspended

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

-WhatIf

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

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