Edit

Share via

Convert-SPWebApplication

  • Reference
Module:
SharePointServer
Applies to:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Converts the authentication mode of a web application.

Syntax

Convert-SPWebApplication
       -Identity <SPWebApplicationPipeBind>
       -From <String>
       -To <String>
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Force]
       [-RetainPermissions]
       [-Database <SPContentDatabase>]
       [-MapList <String>]
       [-SiteSubsriptionId <Guid>]
       [-SkipPolicies]
       [-SkipSites]
       [-SourceSkipList <String>]
       [-TrustedProvider <SPTrustedIdentityTokenIssuerPipeBind>]
       [-LoggingDirectory <String>]
       [<CommonParameters>]

Description

Use the Convert-SPWebApplication cmdlet to convert the authentication mode of a Web application to Windows Claims authentication mode and migrate the user accounts in the content database to claims encoded values.

When retaining permissions, users within Sites are only converted if the source account is enabled and queryable by SharePoint. For example, if the Active Directory account is deleted or disabled prior to a Classic Windows to Windows Claims conversion, the account in the database will not be updated to the Claims format.

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

Examples

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

Convert-SPWebApplication -Identity "https://<webappurl>" -To Claims -RetainPermissions

This example converts a web application specified by the Identity parameter to use the claim authentication mode.

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

Convert-SPWebApplication -Identity "https://<webappurl>" -From Legacy -To Claims -RetainPermissions

This example converts a web application specified by the Identity parameter from Classic Windows authentication to Claims authentication mode while retaining permissions. The -From parameter is required after security update MS04-022 or the April 2014 Cumulative Update for SharePoint Server 2013 is applied. This is required for all versions of SharePoint Server 2016.

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 2013, SharePoint Server 2016, SharePoint Server 2019

-Database

Specifies the name of the content database to migrate.

Type:SPContentDatabase
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Force

Forces the conversion of the web application.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-From

Specifies the authentication method to convert from.

Valid values for this parameter are as follows.

Legacy, Claims-Windows, Claims-Trusted-Default

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Identity

Specifies the URL of the web application that you want to convert, for example: https://mysite/app1

Type:SPWebApplicationPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-LoggingDirectory

Specifies a directory where verbose logs about the results of the migration will be written.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2016, SharePoint Server 2019

-MapList

Specifies a file containing as list of rows in the following format: user-key, migrated-user-name, migrated-user-key.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-RetainPermissions

Specifies the account under which the cmdlet is run and retains the permission in the web application.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SiteSubsriptionId

Specifies the GUID fo the Site Subscription.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SkipPolicies

Specifies the SPWebApplication security policies will not be migrated.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SkipSites

Specifies the SPWebApplication's SPSites will not be migrated.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SourceSkipList

Specifies a file containing as list of rows in the following format: user-key.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-To

Specifies the authentication method to convert to.

Valid values for this parameter are as follows.

Claims, Claims-Windows, Claims-Trusted-Default, Claims-SharePoint-Online

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-TrustedProvider

When you migrate from a trusted login provider this is how you specify which trusted login provider.

Type:SPTrustedIdentityTokenIssuerPipeBind
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019