Export (0) Print
Expand All
Expand Minimize
0 out of 2 rated this helpful - Rate this topic

Register-SPAppPrincipal

SharePoint 2013

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.

noteNote:

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.

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.