[Breaking change]: WithAccessKeyAuthenticaton and WithPasswordAuthentication create a keyvault resource in the app model

[davidfowl]

Description

Relevant change dotnet/aspire#8171

Resources no longer

Version

.NET Aspire 9.2

Previous behavior

Before azd would automatically create and manage bicep resources and these were invisible to the app model so they could not be managed or customized in C#.

New behavior

In 9.2 we changed calling WithKeyAccessAuthenticaton on CosmosDb and AzureRedis or WithPasswordAuthentication would add an empty keyVaultName parameter as a known parameter in the bicep. Now we directly create the key vault resource (or allow you to pass in a reference to another AzureKeyVault resource where the secret will be stored). The key vault secret names for connection strings are now named connectionstrings--{resourcename} to avoid potential conflicts with other connection strings in existing key vaults.

Type of breaking change

• Binary incompatible: Existing binaries might encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation.
• Source incompatible: When recompiled using the new SDK or component or to target the new runtime, existing source code might require source changes to compile successfully.
• Behavioral change: Existing binaries might behave differently at run time.

Reason for change

Moving resources to the app host makes it easier to customize and manage. You can now share a key vault across multiple resources or use an existing key vault to manage connection strings with secrets.

Recommended action

There is currently not work around.

Affected APIs

• https://learn.microsoft.com/en-us/dotnet/api/aspire.hosting.azureredisextensions.withaccesskeyauthentication?view=dotnet-aspire-9.1
• https://learn.microsoft.com/en-us/dotnet/api/aspire.hosting.azurecosmosextensions.withaccesskeyauthentication?view=dotnet-aspire-9.1
• https://learn.microsoft.com/en-us/dotnet/api/aspire.hosting.azurepostgresextensions.withpasswordauthentication?view=dotnet-aspire-9.1

---

Associated WorkItem - 416256