.png)
Register-SPAppPrincipal
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Lets an on-premise or SharePoint Online administrator register an app principal.
Register-SPAppPrincipal -DisplayName <String> -NameIdentifier <String> -Site <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| DisplayName | Required | System.String | Specifies the friendly name to use for the app principal that is being registered. | ||
| NameIdentifier | Required | System.String | Specifies the app principal’s name identifier that needs to be added to the app management service. | ||
| Site | Required | Microsoft.SharePoint.PowerShell.SPWebPipeBind | |||
| 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: Detailed Description
Use the Register-SPAppPrincipal cmdlet to let an on-premise farm or SharePoint Online administrator to register an app principal management service.
Input Types
Return Types
------------EXAMPLE--------
$site = Get-SPSite "https://<urlofsite>"
Register-SPAppPrincipal -site $site.root -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" -DisplayName "Contoso SharePoint Online"
This example registers the app principal named Contoso SharePoint Online.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
