Convert-SPWebApplication

Applies to: SharePoint Server 2016

Topic Last Modified: 2015-11-30

Converts the authentication mode of a web application.

Syntax

Convert-SPWebApplication -From <String> -Identity <SPWebApplicationPipeBind> -To <String> [-Database

<SPContentDatabase>] [-Force <SwitchParameter>] [-LoggingDirectory <String>] [-MapList <String>]
[-RetainPermissions <SwitchParameter>] [-SiteSubsriptionId <Guid>] [-SkipPolicies <SwitchParameter>]
[-SkipSites <SwitchParameter>] [-SourceSkipList <String>] [-TrustedProvider
<SPTrustedIdentityTokenIssuerPipeBind>] [-AssignmentCollection <SPAssignmentCollection>]

Example
------------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.

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.

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

Parameters

Parameter Required Type Description

From Required System.String Specifies the string

Legacy as the
authentication mode
that you want to
convert from.

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.

Note:

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.

Database Optional Microsoft.SharePoint.Administration.SPContentDatabase Specifies the name of

the content database to
migrate.

Force Optional System.Management.Automation.SwitchParameter Forces the conversion

of the web application.

LoggingDirectory Optional System.String Specifies a directory

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

MapList Optional System.String Specifies a file

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

This lets the caller

customize the migration
behavior.

RetainPermissions Optional System.Management.Automation.SwitchParameter Specifies the account

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

SiteSubsriptionId Optional System.Guid Specifies the GUID fo

the Site Subscription.

SkipPolicies Optional System.Management.Automation.SwitchParameter Specifies the

SPWebApplication
security policies will not
be migrated.

SkipSites Optional System.Management.Automation.SwitchParameter Specifies the

SPWebApplication’s
SPSites will not be
migrated.

SourceSkipList Optional System.String Specifies a file

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

This lets the caller

specify accounts that
should be skipped.

TrustedProvider Optional Microsoft.SharePoint.PowerShell.SPTrustedIdentityTokenIssuerPipeBind When you migrate from

a trusted login provider
this is how you specify
which trusted login
provider.

Input Types

Return Types

© 2017 Microsoft