Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Upgrade-SPOSite

Upgrade-SPOSite

microsoft.online.sharepoint.powershell.dll, microsoft.online.sharepoint.powershell-1.dll

Synopsis

Starts the upgrade process on a site collection.

Syntax

Upgrade-SPOSite [-Identity] [-Confirm] [-NoEmail] [-QueueOnly] [-VersionUpgrade] [-WhatIf] [<CommonParameters>]

Detailed Description

The Upgrade-SPOSite cmdlet activates the upgrade process for the specified SharePoint Online site collection. This cmdlet can also be used to resume failed upgrades.

When upgrade is initiated, it can either be a build-to-build or version-to-version upgrade. The default is build-to-build upgrade. When in version-to-version upgrade, site collection health checks are first run in repair mode to ensure that the site collection can be upgraded successfully.

You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832).

Parameters

-Identity <SpoSitePipeBind>

Specifies the SharePoint Online site collection to upgrade.

Aliases

None

Required?

True

Position

1

Default value

Accept pipeline input?

True

Accept wildcard characters?

False

-V2VUpgrade <>

Specifies whether to perform a version-to-version upgrade on the site collection. When this parameter is set, it internally triggers any available build-to-build upgrade associated with the current site collection operating mode, and continues with version-to-version upgrade. When this parameter is not set, it triggers only build-to-build upgrade on the site collection.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-Confirm <SwitchParameter>

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

Aliases

None

Required?

False

Position

Named

Default value

Accept pipeline input?

False

Accept wildcard characters?

False

-NoEmail <SwitchParameter>

Specifies that the system not send the requester and site collection administrators a notification e-mail message at the end of the upgrade process.

Aliases

None

Required?

False

Position

Named

Default value

Accept pipeline input?

False

Accept wildcard characters?

False

-Verbose <>

Boolean. Generates detailed information about the operation, much like tracing or a transaction log. This parameter is effective only in cmdlets that generate verbose data.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-Debug <>

Boolean. Generates programmer-level detail about the operation. This parameter is effective only in cmdlets that generate debug data.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-ErrorAction <>

Enum. Determines how the cmdlet responds when an error occurs. Values are: Continue [default], Stop, SilentlyContinue, Inquire.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-WarningAction <>

Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message. For example, this parameter works when a command contains the Write-Warning cmdlet. For more information, type the following command: get-help about_commonparameters.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-ErrorVariable <>

String. Specifies a variable that stores errors from the command during processing. This variable is populated in addition to $error.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-WarningVariable <>

Stores warnings about the command in the specified variable. To append the warnings to the variable content, instead of replacing any warnings that might already be stored there, type a plus sign (+) before the variable name. For more information, type the following command: get-help about_commonparameters.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-OutVariable <>

String. Specifies a variable that stores output from the command during processing.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-OutBuffer <>

Int32. Determines the number of objects to buffer before calling the next cmdlet in the pipeline.

Aliases

None

Required?

Position

Default value

None

Accept pipeline input?

Accept wildcard characters?

False

-QueueOnly <SwitchParameter>

Adds the site collection to the upgrade queue. The upgrade does not occur immediately.

Aliases

None

Required?

False

Position

Named

Default value

Accept pipeline input?

False

Accept wildcard characters?

False

-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.

Aliases

None

Required?

False

Position

Named

Default value

Accept pipeline input?

False

Accept wildcard characters?

False

Input Type

Return Type

Notes

None

Examples

-------------EXAMPLE 1----------

Example 1 runs a build-to-build upgrade of the existing site collection https://contoso.sharepoint.com/sites/marketing. The CompatibilityLevel property associated with the site collection is not changed by this operation. For more information about CompatibilityLevel, see New-SPOSite.

C:\PS>Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing

-------------EXAMPLE 2----------

Example 2 runs a version-to-version upgrade of the existing site collection https://contoso.sharepoint.com/sites/marketing. The CompatibilityLevel property associated with the site collection is changed to a value of SharePoint 2013 by this operation. For more information about CompatibilityLevel, see New-SPOSite.

C:\PS>Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing -V2VUpgrade

Introduction to the SharePoint Online management shell
Set up the SharePoint Online Management Shell Windows PowerShell environment
Request-SPOUpgradeEvaluationSite
New-SPOSite