docs: expand Connection Property Suffix migration guidance for Aspire 13.2#1167
Open
IEvangelist with Copilot wants to merge 2 commits into
Open
docs: expand Connection Property Suffix migration guidance for Aspire 13.2#1167IEvangelist with Copilot wants to merge 2 commits into
IEvangelist with Copilot wants to merge 2 commits into
Conversation
… in 13.2 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add migration guidance for connection property suffix change
docs: expand Connection Property Suffix migration guidance for Aspire 13.2
Jun 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Expands the Aspire 13.2 “Connection property suffix” breaking-change entry to give actionable migration guidance for users whose consuming apps or AppHost code reads connection properties/environment variables directly.
Changes:
- Adds a rename table covering
Database→DatabaseName,Model→ModelName, andConsumerGroup→ConsumerGroupNameacross multiple resource types. - Adds before/after environment variable examples to show the concrete injected name changes.
- Adds step-by-step migration instructions, including guidance for updating
GetConnectionProperty()calls.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Connection property suffix | ||
|
|
||
| A connection property suffix has been added which may require updates to code that accesses connection properties directly. | ||
| To make it unambiguous that connection properties like `Database` and `Model` carry *name* strings rather than data objects, Aspire 13.2 adds an explicit `Name` suffix to those properties across all built-in resource types (see [microsoft/aspire#13471](https://github.com/microsoft/aspire/pull/13471)). |
| 1. **Find all reads of the old environment variable names.** Search your consuming apps for the old pattern, for example `_DATABASE`, `_MODEL`, or `_CONSUMERGROUP`: | ||
|
|
||
| ```bash title="Bash — Finding affected reads" | ||
| grep -r "_DATABASE\|_MODEL\|_CONSUMERGROUP" ./src |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
### Connection property suffixbreaking-change entry inwhats-new/aspire-13-2.mdxwas a single placeholder sentence with no actionable guidance for users upgrading from 13.1.Changes
whats-new/aspire-13-2.mdxto cover microsoft/aspire#13471:Database→DatabaseName— PostgreSQL, SQL Server, MySQL, MongoDB, Oracle, Milvus, Azure Cosmos DB, Azure PostgreSQL Flexible Server, Azure SQL, Azure Data ExplorerModel→ModelName— Azure AI Foundry, Azure OpenAI, OpenAI, GitHub ModelsConsumerGroup→ConsumerGroupName— Azure Event Hubs consumer groups<Steps>) covering: grep search pattern, updating env var reads in consuming apps, and updatingGetConnectionProperty()calls in AppHost codeBefore/after snapshot: