Request-SPUpgradeEvaluationSite

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Requests an upgrade evaluation site for a specified site.

Syntax

Request-SPUpgradeEvaluationSite
       [-Identity] <SPSitePipeBind>
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-Email]
       [-NoUpgrade]
       [-WhatIf]
       [<CommonParameters>]

Description

Use the Request-SPUpgradeEvaluationSite cmdlet to initiate a request to create temporary copy of a site collection at an auto-generated URL and upgrade the site collection to a newer experience. Users can view the site to see how their site will work in the new experience.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

----------------------EXAMPLE-----------------------

$site=Get-SPSite https://contoso.com/sites/TeamSite1
Request-SPUpgradeEvaluationSite $site -NoUpgrade -Email

This example requests an upgrade evaluation site the specified contoso.com team site.

Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Email

Specifies not to send the requester and site collection administrators a notification email when the upgrade evaluation site is ready. The default value is not to send an email message.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Specifies the SPSite object for the new upgrade evaluation site collection.

Type:	SPSitePipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-NoUpgrade

Specifies not to perform an upgrade as part of the process that creates the upgrade evaluation site.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-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
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition