DotNetCore.Azure.Configuration.KvSecrets 6.0.0

Azure Key Vault Secrets configuration provider for Microsoft.Extensions.Configuration

The AspNetCore.Azure.Configuration.KvSecrets based on [Azure.Extensions.AspNetCore.Configuration.Secrets][source] which package allows storing configuration values using Azure Key Vault Secrets.

Improvements

• Allows to load secrets by list and map them into new names.
• Allows to load secrets into the configuration section.

Getting started

Install the package

Install the package with DotNetCore.Azure.Configuration.KvSecrets:

Version 6.x.x : supports only Microsoft.AspNetCore.App 6.0-*

Version 5.x.x : supports only Microsoft.AspNetCore.App 5.0-*

Version 3.1.x : supports only Microsoft.AspNetCore.App 3.1.0-*

    dotnet add package DotNetCore.Azure.Configuration.KvSecrets

Prerequisites

You need an [Azure subscription][azure_sub] and [Azure Key Vault][keyvault_doc] to use this package.

To create a new Key Vault, you can use the [Azure Portal][keyvault_create_portal], [Azure PowerShell][keyvault_create_ps], or the [Azure CLI][keyvault_create_cli]. Here's an example using the Azure CLI:

az keyvault create --name MyVault --resource-group MyResourceGroup --location westus
az keyvault secret set --vault-name MyVault --name MySecret --value "hVFkk965BuUv"

Examples

To load initialize configuration from Azure Key Vault secrets call the AddAzureKeyVault on ConfigurationBuilder:

Program.cs

    public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.ConfigureAppConfiguration(Startup.AddKvConfigurations);
                    webBuilder.UseStartup<Startup>();
                });

Startup.cs

        public static void AddKvConfigurations(WebHostBuilderContext hostingContext, IConfigurationBuilder configurationBuilder)
        {
            var configBuilder = new ConfigurationBuilder().AddInMemoryCollection();
            IHostEnvironment env = hostingContext.HostingEnvironment;
            configBuilder.AddJsonFile("appsettings.json", optional: true, reloadOnChange: false)
                  .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: false);
            configBuilder.AddEnvironmentVariables();

            var config = configBuilder.Build();

            string KeyVaultUrl = config[nameof(KeyVaultUrl)];
            List<string> VaultSecrets = config.GetSection(nameof(UploadKeyList)).Get<List<string>>();
            string ConfigurationSectionPrefix = config[nameof(ConfigurationSectionPrefix)];

            var credential = new AzureCliCredential();
            //var credential = new DefaultAzureCredential();
            var client = new SecretClient(vaultUri: new Uri(KeyVaultUrl), credential);
            var options = new AzureKvConfigurationOptions()
            {
                ConfigurationSectionPrefix = ConfigurationSectionPrefix,
                UploadKeyList = UploadKeyList
            };

            configurationBuilder.AddAzureKeyVault(client, options);
        }

appsettings.json

  "ConfigurationSectionPrefix": "secret",
  "KeyVaultUrl": "https://secrets128654s235.vault.azure.net/",
  "VaultSecrets": [ "FuseEval--Demo8", "LoadInMess", "RealSecretForVault" ]