Edit

Remove-SPUserSettingsProvider

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Removes a User Settings Provider.

Syntax

Remove-SPUserSettingsProvider
      [-Identity] <SPUserSettingsProviderPipeBind>
      [-AssignmentCollection <SPAssignmentCollection>]
      [<CommonParameters>]

Description

Use the Remove-SPUserSettingsProvider cmdlet to remove a User Settings Provider from the farm.

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

Examples

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

Remove-SPUserSettingsProvider -Identity "234bf0ed-70db-4158-a332-4dfd683b4148"

This example removes a specific User Settings Provider by using the GUID, 234bf0ed-70db-4158-a332-4dfd683b4148.

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

-Identity

Specifies the GUID ID for a User Settings Provider to remove.

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