Get-EntraApplicationServiceEndpoint
Retrieve the service endpoint of an application.
Syntax
Default (Default)
Get-EntraApplicationServiceEndpoint
-ServicePrincipalId <String>
[-All]
[-Top <Int32>]
[-Property <String[]>]
[<CommonParameters>]
Description
The Get-EntraApplicationServiceEndpoint cmdlet retrieves the service endpoint(s) of an application.
The service endpoint entity contains service discovery information. The serviceEndpoints property of the Application entity is of type ServiceEndpoint.
Other services can use the information stored in the ServiceEndpoint entity to find this service and its addressable endpoints.
Examples
Example 1: Retrieve the application service endpoint by ID
Connect-Entra -Scopes 'Application.Read.All'
$servicePrincipal = Get-EntraServicePrincipal -Filter "DisplayName eq 'Contoso Helpdesk App'"
Get-EntraApplicationServiceEndpoint -ServicePrincipalId $servicePrincipal.Id
This example demonstrates how to retrieve service endpoint of the application that is specified through the Object ID parameter.
-ServicePrincipalId parameter specifies the ID of an application object in Microsoft Entra ID.
Example 2: Get all service endpoints
Connect-Entra -Scopes 'Application.Read.All'
$servicePrincipal = Get-EntraServicePrincipal -Filter "DisplayName eq 'Contoso Helpdesk App'"
Get-EntraApplicationServiceEndpoint -ServicePrincipalId $servicePrincipal.Id -All
This example demonstrates how to retrieve all service endpoints of a specified application.
-ServicePrincipalId parameter specifies the ID of an application object in Microsoft Entra ID.
Example 3: Get top five service endpoints
Connect-Entra -Scopes 'Application.Read.All'
$servicePrincipal = Get-EntraServicePrincipal -Filter "DisplayName eq 'Contoso Helpdesk App'"
Get-EntraApplicationServiceEndpoint -ServicePrincipalId $servicePrincipal.Id -Top 5
This example demonstrates how to retrieve five service endpoints of a specified application. You can use -Limit as an alias for -Top.
-ServicePrincipalId parameter specifies the ID of an application object in Microsoft Entra ID.
Parameters
-All
Return all service endpoints.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| 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 |
-Property
Specifies properties to be returned
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Select |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServicePrincipalId
Specifies the object ID of the application for which the service endpoint is retrieved.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ObjectId |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Top
Specifies the maximum number of results that are returned. The default is 100.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Limit |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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.
Inputs
System.String
System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]