Add --include-hidden support to aspire describe

[Copilot]

Description

aspire describe only returned visible resources, so hidden resources such as the dashboard could not be listed from the CLI. This change adds an opt-in path that mirrors the dashboard’s “Show hidden resources” behavior.

• CLI surface

  • Adds --include-hidden to aspire describe
  • Keeps the default output unchanged; hidden resources remain excluded unless explicitly requested

• Backchannel contract

  • Extends the existing v2 resource request objects with an optional IncludeHidden flag
  • Routes describe through the request-object-based v2 resource APIs instead of adding new positional backchannel methods

• Server-side filtering

  • Applies hidden-resource filtering in the AppHost backchannel for both snapshot and watch flows
  • Preserves legacy v1 behavior for callers that do not use the new v2 request property

• Coverage

  • Adds focused CLI tests for:
    • default exclusion of hidden resources
    • inclusion when --include-hidden is specified

Example:

# Existing behavior
aspire describe

# Include hidden resources such as the dashboard
aspire describe --include-hidden

Checklist

• Is this feature complete?
  • Yes. Ready to ship.
  • No. Follow-up changes expected.
• Are you including unit tests for the changes and scenario tests if relevant?
  • Yes
  • No
• Did you add public API?
  • Yes
    • If yes, did you have an API Review for it?
      • Yes
      • No
    • Did you add <remarks /> and <code /> elements on your triple slash comments?
      • Yes
      • No
  • No
• Does the change make any security assumptions or guarantees?
  • Yes
    • If yes, have you done a threat model and had a security review?
      • Yes
      • No
  • No
• Does the change require an update in our Aspire docs?
  • Yes
    • Link to aspire.dev issue:
      • New issue
  • No

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

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

• centralus-2.in.applicationinsights.azure.com
  • Triggering command: /home/REDACTED/work/aspire/aspire/artifacts/bin/Aspire.Cli/Debug/net10.0/aspire /home/REDACTED/work/aspire/aspire/artifacts/bin/Aspire.Cli/Debug/net10.0/aspire new aspire-empty -n HiddenDescribeApp -o /tmp/aspire-include-hidden-verify --non-interactive --nologo (dns block)
  • Triggering command: /home/REDACTED/work/aspire/aspire/artifacts/bin/Aspire.Cli/Debug/net10.0/aspire /home/REDACTED/work/aspire/aspire/artifacts/bin/Aspire.Cli/Debug/net10.0/aspire run --non-interactive --apphost /tmp/aspire-include-hidden-verify/apphost.cs --log-file /home/REDACTED/.aspire/logs/cli_20260410T082119438_detach-child_1e19f98a5d0649f4b2ffad8dccb60aff.log ep/bin/linux-x64/rg (dns block)
  • Triggering command: /home/REDACTED/work/aspire/aspire/artifacts/bin/Aspire.Cli/Debug/net10.0/aspire /home/REDACTED/work/aspire/aspire/artifacts/bin/Aspire.Cli/Debug/net10.0/aspire start --apphost /tmp/aspire-include-hidden-verify/apphost.cs --format json --non-interactive --nologo (dns block)
• dnceng.pkgs.visualstudio.com
  • Triggering command: /usr/share/dotnet/dotnet dotnet test tests/Aspire.Cli.Tests/Aspire.Cli.Tests.csproj -- --filter-method *.DescribeCommand_* --filter-not-trait quarantined=true --filter-not-trait outerloop=true (dns block)
  • Triggering command: /home/REDACTED/work/aspire/aspire/.dotnet/dotnet /home/REDACTED/work/aspire/aspire/.dotnet/dotnet exec /home/REDACTED/work/aspire/aspire/.dotnet/sdk/10.0.201/NuGet.CommandLine.XPlat.dll package search Aspire.Cli --take:1000 --skip:0 --prerelease --format:json (dns block)
  • Triggering command: /home/REDACTED/work/aspire/aspire/.dotnet/dotnet /home/REDACTED/work/aspire/aspire/.dotnet/dotnet exec /home/REDACTED/work/aspire/aspire/.dotnet/sdk/10.0.201/NuGet.CommandLine.XPlat.dll package search Aspire.ProjectTemplates --take:1000 --skip:0 --format:json (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 the custom allowlist in this repository's Copilot coding agent settings (admins only)

[davidfowl]

why?