Convert-SPWebApplication

Converts the authentication mode of a web application.

Syntax

Convert-SPWebApplication
       -Identity <SPWebApplicationPipeBind>
       -To <String>
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Force]
       [-RetainPermissions]
       [-Database <SPContentDatabase>]
       -From <String>
       [-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.

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

Examples

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

C:\PS>Convert-SPWebApplication -Identity "https://<webappurl>" -To Claims -RetainPermissions [-Force]

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

Required Parameters

-From

{{Fill From Description}}

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Identity

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

Type:SPWebApplicationPipeBind
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-To

Specifies the string Claims that dictates that the application needs to be converted to claims authentication mode.

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

Optional 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Database

{{Fill Database Description}}

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

Forces the conversion of the web application.

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

{{Fill LoggingDirectory Description}}

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2016
-MapList

{{Fill MapList Description}}

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-SiteSubsriptionId

{{Fill SiteSubsriptionId Description}}

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

{{Fill SkipPolicies Description}}

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

{{Fill SkipSites Description}}

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

{{Fill SourceSkipList Description}}

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

{{Fill TrustedProvider Description}}

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