.png)
Upgrade-SPOSite
Published: July 16, 2012
Applies to: Office 365 | SharePoint Online
Starts the upgrade process on a site collection.
Upgrade-SPOSite [-Identity] <SPOSitePipeBind> [-V2VUpgrade] [-NoEmail] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>] [-WhatIf] [-Confirm]
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.Online.PowerShell.SPOSitePipeBind | Specifies the SharePoint Online site collection to upgrade. |
| V2VUpgrade | Optional | System.Management.Automation.SwitchParameter | 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. |
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters. |
| NoEmail | Optional | System.Management.Automation.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. |
| Verbose | Optional | System.Management.Automation.SwitchParameter | 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. |
| Debug | Optional | System.Management.Automation.SwitchParameter | Boolean. Generates programmer-level detail about the operation. This parameter is effective only in cmdlets that generate debug data. |
| ErrorAction | Optional | System.Management.Automation.SwitchParameter | Enum. Determines how the cmdlet responds when an error occurs. Values are: Continue [default], Stop, SilentlyContinue, Inquire. |
| WarningAction | Optional | System.Management.Automation.SwitchParameter | 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. |
| ErrorVariable | Optional | System.String | String. Specifies a variable that stores errors from the command during processing. This variable is populated in addition to $error. |
| WarningVariable | Optional | System.String | 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. |
| OutVariable | Optional | System.String | String. Specifies a variable that stores output from the command during processing. |
| OutBuffer | Optional | System.Int32 | Int32. Determines the number of objects to buffer before calling the next cmdlet in the pipeline. |
| QueueOnly | Optional | System.Management.Automation.SwitchParameter | Adds the site collection to the upgrade queue. The upgrade does not occur immediately. |
| WhatIf | Optional | System.Management.Automation.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. |
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.
Input Types
Return Types
-------------EXAMPLE 1----------
Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing
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.
-------------EXAMPLE 2----------
Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing -V2VUpgrade
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.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
