Upgrade-SPOSite.md

external help file	sharepointonline.xml
Module Name	Microsoft.Online.SharePoint.PowerShell
online version	https://learn.microsoft.com/powershell/module/sharepoint-online/upgrade-sposite
applicable	SharePoint Online
title	Upgrade-SPOSite
schema	2.0.0
author	trent-green
ms.author	trgreen
ms.reviewer

Upgrade-SPOSite

SYNOPSIS

Starts the upgrade process on a site collection.

SYNTAX

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

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 at least a SharePoint Online administrator and be 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 Intro to SharePoint Online Management Shell.

EXAMPLES

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

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.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Identity

Specifies the SharePoint Online site collection to upgrade.

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

-NoEmail

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

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

-QueueOnly

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

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

-VersionUpgrade

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.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Getting started with SharePoint Online Management Shell

Request-SPOUpgradeEvaluationSite

New-SPOSite