Skip to content

Surface query failure explicitly in GetAgentInstancesForBlueprintAsync #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gwharris7 merged 2 commits into from
Mar 3, 2026
+59 −49
Merged

Surface query failure explicitly in GetAgentInstancesForBlueprintAsync #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca3b2ff
Initial plan
Copilot Mar 3, 2026
eeedde2
Surface query failure explicitly in GetAgentInstancesForBlueprintAsync
Copilot Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 43 additions & 49 deletions src/Microsoft.Agents.A365.DevTools.Cli/Services/AgentBlueprintService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,74 +164,68 @@ public virtual async Task<bool> DeleteAgentIdentityAsync(

/// <summary>
/// Queries Entra ID for all agent identity service principals linked to the given blueprint.
/// Returns an empty list if the query fails or no instances are found.
/// Returns an empty list when no instances are found.
/// Throws if the query fails so callers can distinguish a true "no instances" result from a query error.
/// </summary>
/// <param name="tenantId">The tenant ID for authentication.</param>
/// <param name="blueprintId">The blueprint application ID or object ID.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>List of agent instances linked to the blueprint.</returns>
/// <exception cref="Exception">Thrown when the Graph query fails.</exception>
public virtual async Task<IReadOnlyList<AgentInstanceInfo>> GetAgentInstancesForBlueprintAsync(
string tenantId,
string blueprintId,
CancellationToken cancellationToken = default)
{
try
{
var requiredScopes = new[] { "AgentIdentityBlueprint.ReadWrite.All" };
var encodedId = Uri.EscapeDataString(blueprintId);
var requiredScopes = new[] { "AgentIdentityBlueprint.ReadWrite.All" };
var encodedId = Uri.EscapeDataString(blueprintId);

// Fetch agent identity SPs and agent users for this blueprint sequentially to avoid races on shared HTTP headers
var spItems = await FetchAllPagesAsync(
tenantId,
$"/beta/servicePrincipals/microsoft.graph.agentIdentity?$filter=agentIdentityBlueprintId eq '{encodedId}'&$select=id,displayName",
requiredScopes,
cancellationToken);
// Fetch agent identity SPs and agent users for this blueprint sequentially to avoid races on shared HTTP headers
var spItems = await FetchAllPagesAsync(
tenantId,
$"/beta/servicePrincipals/microsoft.graph.agentIdentity?$filter=agentIdentityBlueprintId eq '{encodedId}'&$select=id,displayName",
requiredScopes,
cancellationToken);

var userItems = await FetchAllPagesAsync(
tenantId,
$"/beta/users/microsoft.graph.agentUser?$filter=agentIdentityBlueprintId eq '{encodedId}'&$select=id,identityParentId",
requiredScopes,
cancellationToken);
// Build lookup: identityParentId (SP object ID) -> user object ID
var userBySpId = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
foreach (var user in userItems)
var userItems = await FetchAllPagesAsync(
tenantId,
$"/beta/users/microsoft.graph.agentUser?$filter=agentIdentityBlueprintId eq '{encodedId}'&$select=id,identityParentId",
requiredScopes,
cancellationToken);
// Build lookup: identityParentId (SP object ID) -> user object ID
var userBySpId = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
foreach (var user in userItems)
{
var parentId = user.TryGetProperty("identityParentId", out var p) ? p.GetString() : null;
var userId = user.TryGetProperty("id", out var uid) ? uid.GetString() : null;
if (!string.IsNullOrWhiteSpace(parentId) && !string.IsNullOrWhiteSpace(userId))
{
var parentId = user.TryGetProperty("identityParentId", out var p) ? p.GetString() : null;
var userId = user.TryGetProperty("id", out var uid) ? uid.GetString() : null;
if (!string.IsNullOrWhiteSpace(parentId) && !string.IsNullOrWhiteSpace(userId))
{
userBySpId[parentId] = userId;
}
userBySpId[parentId] = userId;
}
}

// Correlate SPs with their agent users
var results = new List<AgentInstanceInfo>();
foreach (var item in spItems)
// Correlate SPs with their agent users
var results = new List<AgentInstanceInfo>();
foreach (var item in spItems)
{
var spId = item.TryGetProperty("id", out var id) ? id.GetString() : null;
if (string.IsNullOrWhiteSpace(spId))
{
var spId = item.TryGetProperty("id", out var id) ? id.GetString() : null;
if (string.IsNullOrWhiteSpace(spId))
{
continue;
}

var displayName = item.TryGetProperty("displayName", out var dn) ? dn.GetString() : null;
userBySpId.TryGetValue(spId, out var agentUserId);

results.Add(new AgentInstanceInfo
{
IdentitySpId = spId,
DisplayName = displayName,
AgentUserId = string.IsNullOrWhiteSpace(agentUserId) ? null : agentUserId
});
continue;
}

return results;
}
catch (Exception ex)
{
_logger.LogError(ex, "Exception querying agent instances for blueprint {BlueprintId}", blueprintId);
return Array.Empty<AgentInstanceInfo>();
var displayName = item.TryGetProperty("displayName", out var dn) ? dn.GetString() : null;
userBySpId.TryGetValue(spId, out var agentUserId);

results.Add(new AgentInstanceInfo
{
IdentitySpId = spId,
DisplayName = displayName,
AgentUserId = string.IsNullOrWhiteSpace(agentUserId) ? null : agentUserId
});
}

return results;
}

/// <summary>
Expand Down
16 changes: 16 additions & 0 deletions src/Tests/Microsoft.Agents.A365.DevTools.Cli.Tests/Services/AgentBlueprintServiceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,22 @@ public async Task GetAgentInstancesForBlueprintAsync_ReturnsEmpty_WhenNoneFound(
}
}

[Fact]
public async Task GetAgentInstancesForBlueprintAsync_Throws_WhenGraphQueryFails()
{
// Arrange
var (service, _) = CreateServiceWithFakeHandler();

// Override token provider to throw so the Graph call fails
_mockTokenProvider.GetMgGraphAccessTokenAsync(
Arg.Any<string>(), Arg.Any<IEnumerable<string>>(), Arg.Any<bool>(), Arg.Any<string?>(), Arg.Any<CancellationToken>())
.Returns(Task.FromException<string?>(new HttpRequestException("Connection timeout")));

// Act & Assert - exception must propagate so callers can abort rather than proceeding with 0 instances
await service.Invoking(s => s.GetAgentInstancesForBlueprintAsync("tenant-id", "blueprint-id"))
.Should().ThrowAsync<HttpRequestException>();
}

[Fact]
public async Task DeleteAgentUserAsync_ReturnsTrue_OnSuccess()
{
Expand Down
Loading