Skip to content

Add descriptive display names for Azure Storage emulator endpoints #10520

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.

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 18, 2025

The Azure Storage emulator endpoints in Azure Functions projects were showing generic names ("blob", "queue", "table") in the dashboard, causing confusion when users clicked on them and received different API responses. This PR adds descriptive display names to make it clear what each endpoint represents.

Problem

When creating Azure Functions projects with Aspire orchestration, the default storage resource creates three endpoints:

  • blob endpoint on port 10000
  • queue endpoint on port 10001
  • table endpoint on port 10002

These endpoints all appeared with generic names in the dashboard, but when users clicked on them, they would get different responses:

  • Some returned XML API responses
  • Others showed "page not working" errors

This inconsistency was confusing because all endpoints appeared to be from the same "functionstorage" resource.

Solution

Added descriptive display names using the WithUrlForEndpoint method:

builder.WithHttpEndpoint(name: "blob", targetPort: 10000)
       .WithHttpEndpoint(name: "queue", targetPort: 10001)
       .WithHttpEndpoint(name: "table", targetPort: 10002)
       .WithUrlForEndpoint("blob", url => url.DisplayText = "Blob Service API")
       .WithUrlForEndpoint("queue", url => url.DisplayText = "Queue Service API") 
       .WithUrlForEndpoint("table", url => url.DisplayText = "Table Service API")

Impact

  • Users will now see clearly labeled endpoints: "Blob Service API", "Queue Service API", "Table Service API"
  • This eliminates confusion about what each endpoint does
  • The underlying functionality remains unchanged - only the display names are improved
  • No breaking changes to existing APIs or workflows

The solution follows the established pattern in Aspire where WithUrlForEndpoint is used to customize how endpoints appear in the dashboard.

Fixes #10416.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: maddymontaquila <12660687+maddymontaquila@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [AspireE2E] The endpoints for 'functionstorage' return two distinct results when creating Azure Functions with Aspire project. Add descriptive display names for Azure Storage emulator endpoints Jul 18, 2025
@Copilot Copilot AI requested a review from maddymontaquila July 18, 2025 01:10
Copilot finished work on behalf of maddymontaquila July 18, 2025 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[AspireE2E] The endpoints for 'functionstorage' return two distinct results when creating Azure Functions with Aspire project.
2 participants