microsoft / microsoft/aspire.dev
[What's New Analysis] Document external service modeling
Open
@maddymontaquila is already working on this.
Since Feb 9, 2026.
external feedback
- Dominant language
- MDX
- Stars
- 193
- Forks
- 87
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 73
Description
Summary
Aspire 9.4 introduced AddExternalService() for modeling third-party APIs and existing infrastructure not managed by Aspire. This is only in what's-new.
What's Missing
Core API
var builder = DistributedApplication.CreateBuilder(args);
// Reference an external service by URL
var externalApi = builder.AddExternalService("external-api", "https://api.company.com");
// Or use a parameter for dynamic configuration
var apiUrl = builder.AddParameter("api-url");
var externalDb = builder.AddExternalService("external-db", apiUrl)
.WithHttpHealthCheck("/health");
var myService = builder.AddProject<Projects.MyService>("my-service")
.WithReference(externalApi)
.WithReference(externalDb);
Features
- External services appear in the Aspire dashboard with health status
- Can be referenced like any other resource
- Support same configuration patterns as internal resources
- Health checks via
WithHttpHealthCheck()
Suggested Content
- When to use external services - third-party APIs, legacy systems, shared infrastructure
- API reference - AddExternalService overloads
- Health checks - WithHttpHealthCheck configuration
- Dashboard integration - how external services appear
- Examples - external database, payment API, auth service
Why It Matters
Most real-world apps integrate with external services. Users need to model these dependencies for accurate architecture visualization.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.