Skip to content

docs: expand Connection Property Suffix migration guidance for Aspire 13.2#1167

Open
IEvangelist with Copilot wants to merge 2 commits into
mainfrom
copilot/add-migration-guidance-connection-suffix
Open

docs: expand Connection Property Suffix migration guidance for Aspire 13.2#1167
IEvangelist with Copilot wants to merge 2 commits into
mainfrom
copilot/add-migration-guidance-connection-suffix

Conversation

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

The ### Connection property suffix breaking-change entry in whats-new/aspire-13-2.mdx was a single placeholder sentence with no actionable guidance for users upgrading from 13.1.

Changes

  • Expanded the breaking-change section in whats-new/aspire-13-2.mdx to cover microsoft/aspire#13471:
    • Explains why the suffix was added (disambiguates name strings from data objects)
    • Full rename table across all affected resource types:
      • DatabaseDatabaseName — PostgreSQL, SQL Server, MySQL, MongoDB, Oracle, Milvus, Azure Cosmos DB, Azure PostgreSQL Flexible Server, Azure SQL, Azure Data Explorer
      • ModelModelName — Azure AI Foundry, Azure OpenAI, OpenAI, GitHub Models
      • ConsumerGroupConsumerGroupName — Azure Event Hubs consumer groups
    • Before/after environment variable examples showing the concrete variable name change
    • Numbered migration steps (<Steps>) covering: grep search pattern, updating env var reads in consuming apps, and updating GetConnectionProperty() calls in AppHost code

Before/after snapshot:

# Before (Aspire ≤13.1)
MYDB_DATABASE=customers
CHAT_MODEL=gpt-4o-mini

# After (Aspire 13.2)
MYDB_DATABASENAME=customers
CHAT_MODELNAME=gpt-4o-mini
// AppHost — before
worker.WithEnvironment("DB_NAME", mydb.Resource.GetConnectionProperty("Database"));

// AppHost — after
worker.WithEnvironment("DB_NAME", mydb.Resource.GetConnectionProperty("DatabaseName"));

… 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
Copilot AI requested a review from IEvangelist June 2, 2026 03:06
@IEvangelist IEvangelist marked this pull request as ready for review June 30, 2026 08:38
Copilot AI review requested due to automatic review settings June 30, 2026 08:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 DatabaseDatabaseName, ModelModelName, and ConsumerGroupConsumerGroupName across 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[13.2 Docs] Add migration guidance for Connection Property Suffix breaking change

3 participants