Get-EntraAgentIdentityBlueprint

Module:

Microsoft.Entra.Applications Module v1.3

Gets an Agent Identity Blueprint by its ID.

Get-EntraAgentIdentityBlueprint

 [-BlueprintId <String>]
 [<CommonParameters>]

The Get-EntraAgentIdentityBlueprint cmdlet retrieves an Agent Identity Blueprint from Microsoft Graph using the v1.0 API and the provided Blueprint ID. If no ID is provided, it uses the stored blueprint ID from the current session or prompts for one. Returns the blueprint object if found, or throws an error if not found.

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

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

Connect-Entra -Scopes 'AgentIdentityBlueprint.Create'
New-EntraAgentIdentityBlueprint -DisplayName "My Blueprint" -SponsorUserIds @("admin@contoso.com")
$blueprint = Get-EntraAgentIdentityBlueprint
Write-Host "Blueprint: $($blueprint.displayName)"

This example retrieves the Agent Identity Blueprint that was created in the current session using the stored blueprint ID.

Connect-Entra -Scopes 'Application.Read.All'
try {
 $blueprint = Get-EntraAgentIdentityBlueprint -BlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
 Write-Host "Blueprint found: $($blueprint.displayName)"
} catch {
 Write-Host "Blueprint not found or error occurred: $_"
}

This example demonstrates how to retrieve an Agent Identity Blueprint with error handling to catch cases where the blueprint 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 object with properties including id, appId, displayName, createdDateTime, and requiredResourceAccess.

If the Agent Identity Blueprint 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/applications/microsoft.graph.agentIdentityBlueprint).

This cmdlet requires the following Microsoft Graph permissions:

• Application.Read.All