| external help file | Microsoft.Online.SharePoint.PowerShell.dll-Help.xml |
|---|---|
| Module Name | Microsoft.Online.SharePoint.PowerShell |
| online version | https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spositerenamestate |
| applicable | SharePoint Online |
| title | Get-SPOSiteRenameState |
| schema | 2.0.0 |
| author | techwriter40 |
| ms.author | pamgreen |
| ms.reviewer |
Returns the current rename job state of a SharePoint Online Site.
Get-SPOSiteRenameState -Identity <SpoSitePipeBind> [-WhatIf] [-Confirm] [<CommonParameters>]
Get-SPOSiteRenameState -ParentOperationId <Guid> [-State <RenameState>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Get-SPOSiteRenameState [-State <RenameState>] [-WhatIf] [-Confirm] [<CommonParameters>]
Use this cmdlet to return the current rename job state of a SharePoint Online Site.
Get-SPOSiteRenameState -Identity https://contoso.sharepoint.com/sites/ContosoWeb1This example returns the rename job state of ContosoWeb1 Site.
Get-SPOSiteRenameState -State InProgressThis example returns rename jobs that are in InProgress state.
$tenantRenameJobId = (Get-SPOTenantRenameStatus).RenameJobId
Get-SPOSiteRenameState -ParentOperationId $tenantRenameJobIdThis example returns rename jobs that were initiated by a tenant rename.
Applicable: SharePoint Online
The urls of the site to be renamed.
Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind
Parameter Sets: SourceSiteUrl
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
The parent operation id that initiated the site to be renamed. For example, the tenant rename job id.
Type: System.Guid
Parameter Sets: ParentId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
The state of the rename job, possible values are
- Queued
- InProgress
- Success
- Failed
- Suspended
Type: Microsoft.Online.SharePoint.PowerShell.RenameState
Parameter Sets: ParentId, RenameReport
Aliases:
Accepted values: Queued, InProgress, Success, Failed, Suspended, Canceling, Canceled
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: 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
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.