Match name with ResourceCommandService

[JamesNK]

Description

ResourceCommandService.ExecuteCommandAsync(string, ...) takes a resourceId and matches to the resource with that resourceId. That includes the suffix for DCP resources, e.g. cache-sfsdfsdf. This could be confusing as people often only think about the resource name, e.g. cache.

PR improves XML docs for API. It also allows the method to match on resource name if there are no replicas.

Fixes #10224

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-docs issue (consider using one of the following templates):
      • New (or update) doc-idea template
      • New breaking-change template
      • New diagnostic template
  • No

[JamesNK]

cc @afscrome

[Copilot]

Pull Request Overview

Implements fallback matching by resource name when no replicas exist and clarifies this behavior in XML documentation, plus adds corresponding unit tests.

• Adds fallback logic in ResourceNotificationService to match resources by name if only one exists.
• Updates XML docs in both ResourceNotificationService and ResourceCommandService to explain resource ID vs. name matching.
• Introduces tests covering both failure and success scenarios for resource name matching in ResourceCommandService.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
tests/Aspire.Hosting.Tests/ResourceCommandServiceTests.cs	Adds tests for resource name matching (failure and success)
src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs	Implements name-based fallback lookup and updates XML docs
src/Aspire.Hosting/ApplicationModel/ResourceCommandService.cs	Updates XML docs to clarify resourceId vs. resourceName logic

Comments suppressed due to low confidence (2)

src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs:448

• Fix the grammar and spelling in this XML comment: change "can be also be used" to "can also be used" and correct "specifing" to "specifying".

    /// </para>

src/Aspire.Hosting/ApplicationModel/ResourceCommandService.cs:37

• Fix the grammar and spelling in this XML comment: change "can be also be used" to "can also be used" and correct "specifing" to "specifying".

    /// The resource name can be also be used to retrieve the resource state, but it must be unique. If there are multiple resources with the same name, then this method will not return a match.

[davidfowl]

Replicas?

[JamesNK]

Yes

[JamesNK]

/backport to release/9.4

[github-actions]

Started backporting to release/9.4: https://github.com/dotnet/aspire/actions/runs/16258280487