Skip to content

Latest commit

 

History

History
168 lines (122 loc) · 3.52 KB

Get-SPOSiteRenameState.md

File metadata and controls

168 lines (122 loc) · 3.52 KB
Raw
external help file Module Name online version applicable title schema author ms.author ms.reviewer
sharepointonline.xml
Microsoft.Online.SharePoint.PowerShell
SharePoint Online
Get-SPOSiteRenameState
2.0.0
techwriter40
pamgreen

Get-SPOSiteRenameState

SYNOPSIS

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

SYNTAX

SourceSiteUrl

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

-Identity

The urls of the site to be renamed.

Type: SpoSitePipeBind
Parameter Sets: SourceSiteUrl
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ParentOperationId

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

Type: guid
Parameter Sets: ParentId
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-State

The state of the rename job, possible values are

  • Queued

  • InProgress

  • Success

  • Failed

  • Suspended

Type: RenameState
Parameter Sets: RenameReport, ParentId
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases: wi
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

NOTES