.png)
New-SPClaimProvider
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Registers a new claim provider in the farm.
New-SPClaimProvider -AssemblyName <String> -Description <String> -DisplayName <String> -Type <String> [-AssignmentCollection <SPAssignmentCollection>] [-Default <SwitchParameter>] [-Enabled <SwitchParameter>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| AssemblyName | Required | System.String | The type must be a valid name of an assembly; for example, ClaimAssembly1. Specifies the name of the assembly with the claim provider. | ||
| Description | Required | System.String | Specifies the description of the claim provider. The type must be a valid name of an assembly; for example, ClaimAssembly1. | ||
| DisplayName | Required | System.String | Specifies the display name of the new claim provider. The type must be a valid name of a claim provider; for example, ClaimProvider1. | ||
| Type | Required | System.String | Specifies the type of the claim. The type must be a valid name of a claim type; for example MyClaimProvider.Providers.CustomProvider. | ||
| 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.
| ||
| Default | Optional | System.Management.Automation.SwitchParameter | Specifies that the claim provider applies to all Web applications and zones. | ||
| Enabled | Optional | System.Management.Automation.SwitchParameter | Turns on the claim provider. |
Note: Detailed Description
The New-SPClaimProvider cmdlet registers a new claim provider in the farm.
Input Types
Return Types
------------------EXAMPLE 1------------------
New–SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -AllWebApplications
This example registers a claim provider in the farm.
------------------EXAMPLE 2------------------
New–SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -Scope (Get-SPWebApplication http://test)
This example registers a claim provider scoped to a given Web application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
