Get-EntraAgentIdentityBlueprintPrincipal

Module:

Microsoft.Entra.Applications Module v1.3

Gets an Agent Identity Blueprint Service Principal by its ID.

Get-EntraAgentIdentityBlueprintPrincipal

 [-ServicePrincipalId <String>]
 [<CommonParameters>]

The Get-EntraAgentIdentityBlueprintPrincipal cmdlet retrieves an Agent Identity Blueprint Service Principal from Microsoft Graph using the provided Service Principal ID. If no ID is provided, it uses the stored service principal ID from the current session or prompts for one. Returns the service principal object if found, or throws an error if not found.

Connect-Entra -Scopes 'Application.Read.All'
Get-EntraAgentIdentityBlueprintPrincipal -ServicePrincipalId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

Name Value
---- -----
id aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
appId bbbbbbbb-1111-2222-3333-cccccccccccc
displayName My Blueprint
servicePrincipalType AgentIdentityBlueprintPrincipal
createdDateTime 2026-04-26T00:00:00Z

This example retrieves the Agent Identity Blueprint Service Principal with the specified ID.

Connect-Entra -Scopes 'AgentIdentityBlueprintPrincipal.Create'
New-EntraAgentIdentityBlueprintPrincipal
$sp = Get-EntraAgentIdentityBlueprintPrincipal
Write-Host "Service Principal: $($sp.displayName)"

This example retrieves the Agent Identity Blueprint Service Principal that was created in the current session using the stored service principal ID.

Connect-Entra -Scopes 'Application.Read.All'
try {
 $sp = Get-EntraAgentIdentityBlueprintPrincipal -ServicePrincipalId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
 Write-Host "Service Principal found: $($sp.displayName)"
} catch {
 Write-Host "Service Principal not found or error occurred: $_"
}

This example demonstrates how to retrieve an Agent Identity Blueprint Service Principal with error handling to catch cases where it doesn't exist.

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.

Returns the Agent Identity Blueprint Service Principal object with properties including id, appId, displayName, createdDateTime, and servicePrincipalType.

If the Agent Identity Blueprint Service Principal with the specified ID is not found, the cmdlet will throw an error.

This cmdlet uses the Microsoft Graph v1.0 API endpoint (/v1.0/servicePrincipals/graph.agentIdentityBlueprintPrincipal).

This cmdlet requires the following Microsoft Graph permissions:

• Application.Read.All