Convert-SPWebApplication
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Converts the authentication mode of a web application.
Convert-SPWebApplication -Identity <SPWebApplicationPipeBind> -To <String> [-AssignmentCollection <SPAssignmentCollection>] [-Force <SwitchParameter>] [-RetainPermissions <SwitchParameter>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind | Specifies the URL of the web application that you want to convert, for example: http://mysite/app1 | ||
| To | Required | System.String | Specifies the string Claims that dictates that the application needs to be converted to claims authentication mode. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Force | Optional | System.Management.Automation.SwitchParameter | Forces the conversion of the web application. | ||
| RetainPermissions | Optional | System.Management.Automation.SwitchParameter | Specifies the account under which the cmdlet is run and retains the permission in the web application. |
Detailed 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.
Input Types
Return Types
------------EXAMPLE-------
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.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: