| external help file | Microsoft.SharePoint.PowerShell.dll-help.xml |
|---|---|
| Module Name | Microsoft.SharePoint.Powershell |
| online version | https://learn.microsoft.com/powershell/module/microsoft.sharepoint.powershell/register-spappprincipal |
| applicable | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
| title | Register-SPAppPrincipal |
| schema | 2.0.0 |
| author | techwriter40 |
| ms.author | pamgreen |
| ms.reviewer |
Lets an on-premises administrator register an app principal.
Register-SPAppPrincipal -DisplayName <String> -NameIdentifier <String> -Site <SPWebPipeBind>
[-AssignmentCollection <SPAssignmentCollection>] [<CommonParameters>]
Use the Register-SPAppPrincipal cmdlet to let an on-premises farm administrator to register an app principal management service.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
$site = Get-SPSite "https://<urlofsite>"
Register-SPAppPrincipal -site $site.RootWeb -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" -DisplayName "Contoso"
This example registers the app principal named Contoso.
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the friendly name to use for the app principal that is being registered.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the app principal's name identifier that needs to be added to the app management service.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
{{Fill Site Description}}
Type: SPWebPipeBind
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).