Table of Contents

Get-PnPEntraIDServicePrincipal

SYNOPSIS

Required Permissions

  • Microsoft Graph API: Any of Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

Gets service principal/application registrations in Entra ID.

SYNTAX

All

Get-PnPEntraIDServicePrincipal [-Filter <string>] [-Connection <PnPConnection>]

By App Id

Get-PnPEntraIDServicePrincipal -AppId <Guid> [-Connection <PnPConnection>]

By Object Id

Get-PnPEntraIDServicePrincipal -ObjectId <Guid> [-Connection <PnPConnection>]

By App Name

Get-PnPEntraIDServicePrincipal -AppName <String> [-Connection <PnPConnection>]

By built in type

Get-PnPEntraIDServicePrincipal -BuiltInType <ServicePrincipalBuiltInType> [-Connection <PnPConnection>]

DESCRIPTION

Allows retrieval of all service principals/app registrations in Entra ID or a specific service principal/app registration based on the AppId, ObjectId or AppName. This will include both application registrations as well as enterprise applications in Entra ID.

EXAMPLES

EXAMPLE 1

Get-PnPEntraIDServicePrincipal

Retrieves all application registrations and enterprise applications from Entra ID.

EXAMPLE 2

Get-PnPEntraIDServicePrincipal -AppId b8c2a8aa-33a0-43f4-a9d3-fe2851c5293e

Retrieves the application registration with AppId/ClientId b8c2a8aa-33a0-43f4-a9d3-fe2851c5293e from Entra ID.

EXAMPLE 3

Get-PnPEntraIDServicePrincipal -ObjectId 06ca9985-367a-41ba-9c44-b2ed88c19aec

Retrieves the application registration with ObjectId 06ca9985-367a-41ba-9c44-b2ed88c19aec from Entra ID.

EXAMPLE 4

Get-PnPEntraIDServicePrincipal -AppName "My application"

Retrieves the application registration with the name "My application" from Entra ID.

EXAMPLE 5

Get-PnPEntraIDServicePrincipal -Filter "startswith(description, 'contoso')"

Retrieves the application registration with the description starting with "contoso" from Entra ID. This example demonstrates using Advanced Query capabilities (see: https://learn.microsoft.com/graph/aad-advanced-queries?tabs=http#group-properties).

PARAMETERS

-AppId

The guid of the application registration its App Id/Client Id to retrieve.

Type: Guid
Parameter Sets: By App Id

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ObjectId

The guid of the application registration its object Id to retrieve.

Type: Guid
Parameter Sets: By Object Id

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppName

The name of the application registration to retrieve.

Type: String
Parameter Sets: By App Name

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Specify the query to pass to Graph API in $filter.

Type: String
Parameter Sets: Filter

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Microsoft 365 Patterns and Practices Microsoft Graph documentation

Edit this page