Add connection property suffix by sebastienros · Pull Request #13471 · microsoft/aspire

Sébastien Ros (sebastienros) · 2025-12-10T20:07:57Z

Description

Normalizing all connection property names for better consistency and clarity. Property names now use more explicit suffixes like Name to distinguish them from actual values.

Pattern Summary

The property name changes follow these patterns:

Database Properties: Database → DatabaseName
Authentication Properties: AuthenticationDatabase → AuthenticationDatabaseName
Model Properties: Model → ModelName
Named Entities: {Entity} → {Entity}Name (e.g., Organization → OrganizationName, ConsumerGroup → ConsumerGroupName)

It's breaking for existing resource that have connection properties after 13.0.

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 - [Breaking change]: Connection properties names dotnet/docs-aspire#5959
- No

Ankit Jain (radical) · 2025-12-10T21:14:19Z

Sébastien Ros (@sebastienros) this has conflicts

github-actions · 2025-12-10T21:20:00Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 13471

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 13471"

Copilot

Pull request overview

This PR normalizes connection property names across all Aspire hosting resources by adding explicit suffixes (primarily Name) to distinguish property names from their values. This is a breaking change for existing resources with connection properties after version 13.0.

Key Changes

Database properties: Database → DatabaseName (SQL Server, PostgreSQL, Oracle, MySQL, MongoDB, Milvus, and Azure variants)
Model properties: Model → ModelName (OpenAI, GitHub Models, Azure OpenAI, Azure AI Foundry)
Other entity properties: Organization → OrganizationName, ConsumerGroup → ConsumerGroupName, AuthenticationDatabase → AuthenticationDatabaseName

Reviewed changes

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

Show a summary per file

File	Description
`src/Aspire.Hosting.SqlServer/SqlServerDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.SqlServer/README.md`	Updated documentation to reflect new `DatabaseName` property
`src/Aspire.Hosting.PostgreSQL/PostgresDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.PostgreSQL/README.md`	Updated documentation to reflect new `DatabaseName` property
`src/Aspire.Hosting.Oracle/OracleDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.Oracle/README.md`	Updated documentation to reflect new `DatabaseName` property
`src/Aspire.Hosting.OpenAI/OpenAIModelResource.cs`	Updated connection property from `Model` to `ModelName`
`src/Aspire.Hosting.OpenAI/README.md`	Updated documentation to reflect new `ModelName` property
`src/Aspire.Hosting.MySql/MySqlDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.MySql/README.md`	Updated documentation table and URI format descriptions to use `DatabaseName`
`src/Aspire.Hosting.MongoDB/MongoDBServerResource.cs`	Updated connection property from `AuthenticationDatabase` to `AuthenticationDatabaseName`
`src/Aspire.Hosting.MongoDB/MongoDBDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.MongoDB/README.md`	Updated documentation for both `AuthenticationDatabaseName` and `DatabaseName` properties
`src/Aspire.Hosting.Milvus/MilvusDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.Milvus/README.md`	Updated documentation to reflect new `DatabaseName` property
`src/Aspire.Hosting.GitHub.Models/GitHubModelResource.cs`	Updated connection properties: `Model` → `ModelName`, `Organization` → `OrganizationName`
`src/Aspire.Hosting.GitHub.Models/README.md`	Updated documentation to reflect both new property names
`src/Aspire.Hosting.Azure.Sql/AzureSqlDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.Azure.Sql/README.md`	Updated documentation to reflect new `DatabaseName` property
`src/Aspire.Hosting.Azure.PostgreSQL/AzurePostgresFlexibleServerDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.Azure.PostgreSQL/README.md`	Updated documentation table and connection string descriptions to use `DatabaseName`
`src/Aspire.Hosting.Azure.Kusto/AzureKustoReadWriteDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.Azure.Kusto/README.md`	Updated documentation table to reflect new `DatabaseName` property
`src/Aspire.Hosting.Azure.EventHubs/AzureEventHubConsumerGroupResource.cs`	Updated connection property from `ConsumerGroup` to `ConsumerGroupName`
`src/Aspire.Hosting.Azure.EventHubs/README.md`	Updated documentation to reflect new `ConsumerGroupName` property
`src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBDatabaseResource.cs`	Updated connection property from `Database` to `DatabaseName`
`src/Aspire.Hosting.Azure.CosmosDB/README.md`	Updated documentation to reflect new `DatabaseName` property
`src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIDeploymentResource.cs`	Updated connection property from `Model` to `ModelName`
`src/Aspire.Hosting.Azure.CognitiveServices/README.md`	Updated documentation to reflect new `ModelName` property
`src/Aspire.Hosting.Azure.AIFoundry/AzureAIFoundryDeploymentResource.cs`	Updated connection property from `Model` to `ModelName`
`src/Aspire.Hosting.Azure.AIFoundry/README.md`	Updated documentation and notes to reflect new `ModelName` property
`tests/Aspire.Hosting.SqlServer.Tests/ConnectionPropertiesTests.cs`	Updated test assertion to expect `DatabaseName` instead of `Database`
`tests/Aspire.Hosting.PostgreSQL.Tests/ConnectionPropertiesTests.cs`	Updated test assertion to expect `DatabaseName` instead of `Database`
`tests/Aspire.Hosting.Oracle.Tests/ConnectionPropertiesTests.cs`	Updated test assertion to expect `DatabaseName` instead of `Database`
`tests/Aspire.Hosting.Oracle.Tests/Snapshots/ConnectionPropertiesTests.VerifyManifestWithConnectionProperties.verified.json`	Updated snapshot with new environment variable name `DB_DATABASENAME`
`tests/Aspire.Hosting.OpenAI.Tests/ConnectionPropertiesTests.cs`	Updated test assertion to expect `ModelName` instead of `Model`
`tests/Aspire.Hosting.MySql.Tests/ConnectionPropertiesTests.cs`	Updated test assertion to expect `DatabaseName` instead of `Database`
`tests/Aspire.Hosting.MySql.Tests/Snapshots/ConnectionPropertiesTests.VerifyManifestWithConnectionProperties.verified.json`	Updated snapshot with new environment variable name `DB_DATABASENAME`
`tests/Aspire.Hosting.MongoDB.Tests/ConnectionPropertiesTests.cs`	Updated test assertions for both `AuthenticationDatabaseName` and `DatabaseName`
`tests/Aspire.Hosting.MongoDB.Tests/Snapshots/ConnectionPropertiesTests.VerifyManifestWithConnectionProperties.verified.json`	Updated snapshot with new environment variable names for all database name properties
`tests/Aspire.Hosting.Milvus.Tests/ConnectionPropertiesTests.cs`	Updated test assertion to expect `DatabaseName` instead of `Database`
`tests/Aspire.Hosting.GitHub.Models.Tests/ConnectionPropertiesTests.cs`	Updated test assertions for `ModelName` and `OrganizationName`
`tests/Aspire.Hosting.Azure.Tests/AzureSqlDatabaseConnectionPropertiesTests.cs`	Updated test assertion to expect `DatabaseName` instead of `Database`
`tests/Aspire.Hosting.Azure.Tests/AzurePostgresFlexibleServerDatabaseConnectionPropertiesTests.cs`	Updated test assertions to expect `DatabaseName` in multiple test methods
`tests/Aspire.Hosting.Azure.Tests/AzureOpenAIDeploymentConnectionPropertiesTests.cs`	Updated test assertion to expect `ModelName` instead of `Model`
`tests/Aspire.Hosting.Azure.Tests/AzureEventHubConsumerGroupConnectionPropertiesTests.cs`	Updated test assertion to expect `ConsumerGroupName` instead of `ConsumerGroup`
`tests/Aspire.Hosting.Azure.Tests/AzureCosmosDBDatabaseConnectionPropertiesTests.cs`	Updated test assertions to expect `DatabaseName` in multiple test methods
`tests/Aspire.Hosting.Azure.Tests/AzureCosmosDBContainerConnectionPropertiesTests.cs`	Updated test assertions to expect `DatabaseName` in multiple test methods
`tests/Aspire.Hosting.Azure.Tests/AzureAIFoundryDeploymentConnectionPropertiesTests.cs`	Updated test assertions to expect `ModelName` in multiple test methods
`tests/Aspire.Hosting.Azure.Kusto.Tests/AzureKustoConnectionPropertiesTests.cs`	Updated test assertions to expect `DatabaseName` in multiple test methods

Copilot · 2025-12-10T21:29:56Z

-| `Database`    | The name of the database |
+| `DatabaseName`    | The name of the database |

 Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `mydb` becomes `MYDB_URI`, and the `Database` property becomes `MYDB_DATABASE`.


The documentation text still references the old property name Database instead of the new DatabaseName. This should be updated to MYDB_DATABASENAME to match the property name change made in this PR.

Suggested change

Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `mydb` becomes `MYDB_URI`, and the `Database` property becomes `MYDB_DATABASE`.

Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `mydb` becomes `MYDB_URI`, and the `DatabaseName` property becomes `MYDB_DATABASENAME`.

Copilot · 2025-12-10T21:29:56Z

@@ -48,7 +48,7 @@ The SQL Server database resource inherits all properties from its parent `SqlSer
 |---------------|-------------|
 | `Uri` | The connection URI in mssql:// format, with the format `mssql://{Username}:{Password}@{Host}:{Port}/{DatabaseName}` |
 | `JdbcConnectionString` | JDBC connection string with database name, with the format `jdbc:sqlserver://{Host}:{Port};trustServerCertificate=true;databaseName={DatabaseName}`. User and password credentials are provided as separate `Username` and `Password` properties. |


The JdbcConnectionString example embeds trustServerCertificate=true, which disables SQL Server TLS certificate validation and allows a man-in-the-middle to impersonate the database server if the network is compromised. Because this value is what consuming apps will use by default, an attacker on the same network could intercept or modify database traffic without being detected. Consider removing trustServerCertificate=true from the default connection string, or clearly documenting it as development-only and providing a secure production variant that validates server certificates (e.g., with encrypt=true and a trusted CA-signed certificate).

We already set this property for the dotnet connection string such that the docker images work locally. David Negstad (@danegsta) do we inject certs for SQL Server too now?

No certs for SQL Server yet. We needed to add support for 127.0.0.1 to the dev cert, which'll be in the 10.0.102 SDK. After that ships we can enable HTTPS for SQL Server.

Eric Erhardt (eerhardt) · 2025-12-11T20:53:30Z

-| `Model` | The model identifier for inference requests, for instance `openai/gpt-4o-mini` |
-| `Organization` | The organization attributed to the request (available when configured) |
+| `ModelName` | The model identifier for inference requests, for instance `openai/gpt-4o-mini` |
+| `OrganizationName` | The organization attributed to the request (available when configured) |


Hmm, is this one necessary to suffix with "Name"?

I was worried this could be interpreted as ID or URL or anything. Because Organization doesn't convey any logical type, like Url/Name.

It's interesting that it use "Repository name" but just has "User or organization"

Eric Erhardt (eerhardt) · 2025-12-11T20:56:41Z

        {
            yield return new("Password", ReferenceExpression.Create($"{PasswordParameter}"));
-            yield return new("AuthenticationDatabase", AuthenticationDatabaseReference);
+            yield return new("AuthenticationDatabaseName", AuthenticationDatabaseReference);


Maybe this one doesn't need to be updated since it has a qualifier.

Check again, I did before and just confirmed again --username myUser --password myPass --authenticationDatabase admin

So it's a database name, right?

AuthenticationDatabase tells MongoDB which database stores the user’s account.

I think since it has more than just "Database" it feels weird to suffix with "Name". AuthenticationDatabase feels like enough.

[skip ci] Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com>

Sébastien Ros (sebastienros) · 2025-12-11T23:37:53Z

/backport to release/13.1

github-actions · 2025-12-11T23:38:01Z

Started backporting to release/13.1: https://github.com/dotnet/aspire/actions/runs/20150980883

Sébastien Ros (sebastienros) requested a review from Eric Erhardt (eerhardt) December 10, 2025 20:08

Base automatically changed from sebros/azureproperties to main December 10, 2025 21:00

Sébastien Ros (sebastienros) requested a review from Ankit Jain (radical) as a code owner December 10, 2025 21:00

Add connection property suffix

0c8aee4

Sébastien Ros (sebastienros) force-pushed the sebros/cpnames branch from 0e1685a to 0c8aee4 Compare December 10, 2025 21:19

Copilot AI review requested due to automatic review settings December 10, 2025 21:19

Copilot started reviewing on behalf of Sébastien Ros (sebastienros) December 10, 2025 21:20 View session

Copilot AI reviewed Dec 10, 2025

View reviewed changes

Sébastien Ros (sebastienros) added 2 commits December 10, 2025 14:05

Update baselines

d5bff61

Fix test and README

e7b3c91

Sébastien Ros (sebastienros) requested a review from Mitch Denny (mitchdenny) as a code owner December 10, 2025 22:17

Ankit Jain (radical) approved these changes Dec 10, 2025

View reviewed changes

David Fowler (davidfowl) added the breaking-change Issue or PR that represents a breaking API or functional change over a prerelease. label Dec 11, 2025

Eric Erhardt (eerhardt) approved these changes Dec 11, 2025

View reviewed changes

Sébastien Ros (sebastienros) and others added 2 commits December 11, 2025 13:11

Update src/Aspire.Hosting.Azure.AIFoundry/README.md

bc3d97e

[skip ci] Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com>

Revert AuthenticationDatabase and Organization

c6bba33

Sébastien Ros (sebastienros) merged commit ff437b1 into main Dec 11, 2025
286 checks passed

Sébastien Ros (sebastienros) deleted the sebros/cpnames branch December 11, 2025 23:36

dotnet-policy-service Bot added this to the 13.2 milestone Dec 11, 2025

github-actions Bot mentioned this pull request Dec 11, 2025

[release/13.1] Add connection property suffix #13516

Merged

github-actions Bot locked and limited conversation to collaborators Jan 11, 2026

	Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `mydb` becomes `MYDB_URI`, and the `Database` property becomes `MYDB_DATABASE`.
	Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `mydb` becomes `MYDB_URI`, and the `DatabaseName` property becomes `MYDB_DATABASENAME`.

Uh oh!

Conversation

Sébastien Ros (sebastienros) commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Pattern Summary

Checklist

Uh oh!

Ankit Jain (radical) commented Dec 10, 2025

Uh oh!

github-actions Bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Sébastien Ros (sebastienros) commented Dec 11, 2025

Uh oh!

github-actions Bot commented Dec 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Sébastien Ros (sebastienros) commented Dec 10, 2025 •

edited

Loading

github-actions Bot commented Dec 10, 2025 •

edited

Loading