Edit

Share via

With authentication API creates keyvault resource in the app model

Starting in .NET Aspire 9.2, calling any of the following methods:

Will now create (or add references to) a key vault resource directly in the app model. This change allows better customization and management of connection strings and secrets.

Version introduced

.NET Aspire 9.2

Previous behavior

Previously, calling WithAccessKeyAuthentication on CosmosDB or AzureRedis, or WithPasswordAuthentication on AzurePostgres, automatically created and managed Bicep resources. These resources were invisible to the app model and could not be managed or customized in C#.

New behavior

In .NET Aspire 9.2, calling WithAccessKeyAuthentication or WithPasswordAuthentication adds an empty keyVaultName parameter as a known parameter in the Bicep file. The app model now directly creates the key vault resource or allows you to pass a reference to an existing AzureKeyVault resource where secrets will be stored. Key vault secret names for connection strings are now formatted as connectionstrings--{resourcename} to avoid conflicts with other connection strings.

Type of breaking change

This is a behavioral change.

Reason for change

This change moves resource management to the app host, making it easier to customize and manage resources. It allows sharing a key vault across multiple resources or using an existing key vault to manage connection strings and secrets.

There is currently no workaround for this change. Ensure that your app model is updated to handle the new behavior for key vault resources and connection string management.

Affected APIs