[docs] Document WithUniqueResourceNaming for Azure Container App environments - #1443
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
David Pine (IEvangelist)
left a comment
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
Validated against microsoft/aspire#18737. The collision scenario, opt-in naming behavior, migration caution, experimental diagnostic, and resolver precedence are documented accurately.
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new experimental WithUniqueResourceNaming() API on Azure Container Apps environments and its associated diagnostic (ASPIREACANAMING002), to help users avoid managed environment naming collisions during publish/deploy.
Changes:
- Added a new diagnostics reference page for
ASPIREACANAMING002, including an example and suppression options. - Added a new section to the Azure Container Apps configuration doc describing the collision scenario and how to apply
WithUniqueResourceNaming(). - Registered
ASPIREACANAMING002in the diagnostics sidebar.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/frontend/src/content/docs/integrations/cloud/azure/configure-container-apps.mdx | Documents the naming collision scenario and the WithUniqueResourceNaming() mitigation. |
| src/frontend/src/content/docs/diagnostics/aspireacanaming002.mdx | New diagnostics page describing ASPIREACANAMING002 and suppression patterns. |
| src/frontend/config/sidebar/reference.topics.ts | Adds ASPIREACANAMING002 to the diagnostics sidebar list. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779
Documents changes from microsoft/aspire#18737
@mitchdennyTargeting
release/13.5based on the source PR milestone13.5.Why
microsoft/aspire#18737 adds
WithUniqueResourceNaming(), a new experimental (ASPIREACANAMING002) extension method onAzureContainerAppEnvironmentResource. By default, the generated Azure Container Apps managed environmentnamekeeps only lowercase letters from the resource name, soAddAzureContainerAppEnvironment("cae1")andAddAzureContainerAppEnvironment("cae2")deployed to the same resource group both resolve to the same physical environment name, causing collisions (ManagedEnvironmentOperationInProgress). Publish/deploy now fail fast with guidance pointing callers atWithUniqueResourceNaming(). This new public API and diagnostic weren't covered anywhere on the docs site.What changed
src/frontend/src/content/docs/diagnostics/aspireacanaming002.mdx(modeled on the existingaspirecompute001.mdx/aspireacadomains001.mdxpattern) documenting theASPIREACANAMING002experimental-API warning, an example that triggers it, and the three standard suppression methods.src/frontend/config/sidebar/reference.topics.ts.src/frontend/src/content/docs/integrations/cloud/azure/configure-container-apps.mdx(next to the existingWithAzdResourceNamingnaming-conventions section) explaining the collision scenario, showing how to callWithUniqueResourceNaming()on each colliding environment, and calling out via<Aside type="caution">that it changes the managed environment name (so it should only be applied to already-deployed environments deliberately) and links to the new diagnostics page.Files changed
src/frontend/src/content/docs/diagnostics/aspireacanaming002.mdx(new)src/frontend/config/sidebar/reference.topics.ts(modified — added sidebar entry)src/frontend/src/content/docs/integrations/cloud/azure/configure-container-apps.mdx(modified — added new section)