Add WithDashboard() method to allow opting out of Aspire dashboard in Azure Container App environments #9600

Copilot · 2025-05-30T23:47:46Z

This PR adds the ability for users to disable the Aspire dashboard in Azure Container App environments through a new WithDashboard(bool enable = true) extension method.

Problem

Previously, the Aspire dashboard was always added to Azure Container App environments with no way to opt out. This created unnecessary resources for users who didn't want the dashboard functionality.

Solution

Added a new WithDashboard(bool enable = true) extension method that allows users to control dashboard inclusion:

// Default behavior (dashboard enabled) - unchanged for backward compatibility
builder.AddAzureContainerAppEnvironment("env");

// Explicitly enable dashboard
builder.AddAzureContainerAppEnvironment("env").WithDashboard(true);

// Disable dashboard (new functionality)
builder.AddAzureContainerAppEnvironment("env").WithDashboard(false);

Implementation Details

Added EnableDashboard property to AzureContainerAppEnvironmentResource (defaults to true)
Added WithDashboard(bool enable = true) extension method for fluent configuration
Modified infrastructure creation logic to conditionally add the dashboard resource based on the EnableDashboard property
Updated API surface to include the new extension method
Added tests to verify both enabled and disabled scenarios

The dashboard resource creation is now wrapped in a conditional check:

if (appEnvResource.EnableDashboard)
{
    var dashboard = new ContainerAppEnvironmentDotnetComponentResource("aspireDashboard", "2024-10-02-preview")
    {
        Name = "aspire-dashboard",
        ComponentType = "AspireDashboard",
        Parent = containerAppEnvironment
    };
    infra.Add(dashboard);
}

Backward Compatibility

The default behavior remains unchanged - the dashboard is enabled by default, ensuring existing code continues to work without modification.

Fixes #9599.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

0t3vsblobprodcus362.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
7devsblobprodcus323.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
7k6vsblobprodcus337.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
dlbvsblobprodcus316.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
h6tvsblobprodcus346.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
i1qvsblobprodcus353.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
imzvsblobprodcus368.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
jd4vsblobprodcus366.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
kh4vsblobprodcus325.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
l49vsblobprodcus358.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
ofvvsblobprodcus315.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
p2ovsblobprodcus312.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
pe4vsblobprodcus351.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)
x3yvsblobprodcus370.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AddContainerAppEnvironmentAddsEnvironmentResource --verbosity minimal (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

💡 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.

…vironments Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

src/Aspire.Hosting.Azure.AppContainers/api/Aspire.Hosting.Azure.AppContainers.cs

Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

Copilot · 2025-05-31T00:24:06Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

0t3vsblobprodcus362.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
7devsblobprodcus323.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
7k6vsblobprodcus337.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
- Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)
dlbvsblobprodcus316.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
h6tvsblobprodcus346.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
i1qvsblobprodcus353.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
imzvsblobprodcus368.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
jd4vsblobprodcus366.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
kh4vsblobprodcus325.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
l49vsblobprodcus358.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
ofvvsblobprodcus315.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
p2ovsblobprodcus312.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
pe4vsblobprodcus351.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)
x3yvsblobprodcus370.vsblob.vsassets.io
- Triggering command: ./.dotnet/dotnet test tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --filter AzureContainerApp --verbosity minimal (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

…nments

davidfowl · 2025-05-31T01:24:24Z

FYI @vhvb1989 this might require changes to azd to handle the no dashboard case.

Initial plan for issue

7b7afd8

Copilot AI assigned Copilot and davidfowl May 30, 2025

Copilot started work on behalf of davidfowl May 30, 2025 23:47 View session

Implement WithDashboard() extension method for Azure Container App en…

8f99e3e

…vironments Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Make it possible to opt-out of the aspire dashboard in container app environment resource~~ Add WithDashboard() method to allow opting out of Aspire dashboard in Azure Container App environments May 31, 2025

Copilot AI requested a review from davidfowl May 31, 2025 00:05

Copilot finished work on behalf of davidfowl May 31, 2025 00:05

davidfowl reviewed May 31, 2025

View reviewed changes

src/Aspire.Hosting.Azure.AppContainers/api/Aspire.Hosting.Azure.AppContainers.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of davidfowl May 31, 2025 00:12 View session

Remove API surface changes as it's auto-generated

65a9811

Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

Copilot finished work on behalf of davidfowl May 31, 2025 00:24

Add verified Bicep and JSON snapshots for Azure Container Apps enviro…

90bbcb5

…nments

davidfowl marked this pull request as ready for review May 31, 2025 00:48

davidfowl requested review from captainsafia, eerhardt and mitchdenny May 31, 2025 00:49

mitchdenny approved these changes May 31, 2025

View reviewed changes

davidfowl enabled auto-merge (squash) May 31, 2025 01:23

davidfowl disabled auto-merge May 31, 2025 01:23

davidfowl requested a review from vhvb1989 May 31, 2025 01:24

davidfowl enabled auto-merge (squash) May 31, 2025 01:24

davidfowl disabled auto-merge May 31, 2025 03:06

davidfowl merged commit e8869a1 into main May 31, 2025
1236 of 1246 checks passed

davidfowl deleted the copilot/fix-9599 branch May 31, 2025 03:06

github-actions bot locked and limited conversation to collaborators Jun 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add WithDashboard() method to allow opting out of Aspire dashboard in Azure Container App environments #9600

Add WithDashboard() method to allow opting out of Aspire dashboard in Azure Container App environments #9600

Uh oh!

Copilot AI commented May 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI commented May 31, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

davidfowl commented May 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add WithDashboard() method to allow opting out of Aspire dashboard in Azure Container App environments #9600

Add WithDashboard() method to allow opting out of Aspire dashboard in Azure Container App environments #9600

Uh oh!

Conversation

Copilot AI commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Implementation Details

Backward Compatibility

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Copilot AI commented May 31, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

davidfowl commented May 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented May 30, 2025 •

edited

Loading