Get-SPOSiteRenameState
Returns the current rename job state of a SharePoint Online Site.
Syntax
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>]
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
Applicable: SharePoint Online
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
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 |
-Identity
Applicable: SharePoint Online
The urls of the site to be renamed.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SourceSiteUrl
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ParentOperationId
Applicable: SharePoint Online
The parent operation id that initiated the site to be renamed. For example, the tenant rename job id.
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParentId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-State
Applicable: SharePoint Online
The state of the rename job, possible values are
- Queued
- InProgress
- Success
- Failed
- Suspended
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.RenameState |
| Default value: | None |
| Accepted values: | Queued, InProgress, Success, Failed, Suspended, Canceling, Canceled |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParentId
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
RenameReport
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Online
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
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.