Get-AzADServicePrincipal
Lists entities from service principals or get entity from service principals by key
Syntax
EmptyParameterSet (Default)
Get-AzADServicePrincipal
[-Select <String[]>]
[-Count]
[-Filter <String>]
[-Orderby <String[]>]
[-Search <String>]
[-ConsistencyLevel <String>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[-CountVariable <String>]
[<CommonParameters>]
ObjectIdParameterSet
Get-AzADServicePrincipal
-ObjectId <String>
[-Select <String[]>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
SearchStringParameterSet
Get-AzADServicePrincipal
-DisplayNameBeginsWith <String>
[-Select <String[]>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
DisplayNameParameterSet
Get-AzADServicePrincipal
-DisplayName <String>
[-Select <String[]>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
ApplicationIdParameterSet
Get-AzADServicePrincipal
-ApplicationId <Guid>
[-Select <String[]>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
ApplicationObjectParameterSet
Get-AzADServicePrincipal
-ApplicationObject <IMicrosoftGraphApplication>
[-Select <String[]>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
SPNParameterSet
Get-AzADServicePrincipal
-ServicePrincipalName <String>
[-Select <String[]>]
[-First <UInt64>]
[-Skip <UInt64>]
[-AppendSelected]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Lists entities from service principals or get entity from service principals by key
Examples
Example 1: Get service principal by display name
Get-AzADServicePrincipal -DisplayName $name
Get service principal by display name
Example 2: Search for service principal display name starts with
Get-AzADServicePrincipal -DisplayNameStartsWith $prefix
Search for service principal display name starts with
Example 3: List service principals
Get-AzADServicePrincipal -First 10 -Select Tags -AppendSelected
List first 10 service principals and append property 'Tags' after default properties: 'DisplayName', 'Id', 'DeletedDateTime', 'ServicePrincipalNames', 'AppId'
Example 4: Get service principal by application Id
Get-AzADServicePrincipal -ApplicationId $appId
Get service principal by application Id
Get-AzADApplication -DisplayName $name | Get-AzADServicePrincipal
Get service principal by pipeline input
Example 6: Get service principal with filter
Get-AzADServicePrincipal -Filter "startsWith(DisplayName,'some-name')"
Get service principal with filter
Example 7: Assign OdataCount to a variable
Get-AzADServicePrincipal -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result'
$result
Assign OdataCount to a variable
Parameters
-AppendSelected
Append properties selected with default properties when this switch is on, only works with parameter '-Select'.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ApplicationId
application id of serviceprincipal
Parameter properties
Type: Guid
Default value: None Supports wildcards: False DontShow: False Aliases: AppId
Parameter sets
ApplicationIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ApplicationObject
The service principal object, could be used as pipeline input.
Parameter properties
Parameter sets
ApplicationObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ConsistencyLevel
Indicates the requested consistency level.
Documentation URL: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
EmptyParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Count
Include count of items
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
EmptyParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CountVariable
Specifies a count of the total number of items in a collection.
By default, this variable will be set in the global scope.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
EmptyParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisplayName
serviceprincipal display name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DisplayNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisplayNameBeginsWith
serviceprincipal display name starts with
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: DisplayNameStartsWith, SearchString
Parameter sets
SearchStringParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Filter
Filter items by property values, for more detail about filter query please see: https://learn.microsoft.com/en-us/graph/filter-query-parameter
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
EmptyParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-First
Gets only the first 'n' objects.
Parameter properties
Type: UInt64
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ObjectId
key: id of servicePrincipal
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ServicePrincipalId, Id
Parameter sets
ObjectIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Orderby
Order items by property values
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
EmptyParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Search
Search items by search phrases
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
EmptyParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Select
Select properties to be returned
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServicePrincipalName
serviceprincipal name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: SPN
Parameter sets
SPNParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Skip
Ignores the first 'n' objects and then gets the remaining objects.
Parameter properties
Type: UInt64
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
