DotNetCore.Azure.Configuration.KvSecrets 5.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package DotNetCore.Azure.Configuration.KvSecrets --version 5.0.0
NuGet\Install-Package DotNetCore.Azure.Configuration.KvSecrets -Version 5.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DotNetCore.Azure.Configuration.KvSecrets" Version="5.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetCore.Azure.Configuration.KvSecrets --version 5.0.0
#r "nuget: DotNetCore.Azure.Configuration.KvSecrets, 5.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DotNetCore.Azure.Configuration.KvSecrets as a Cake Addin
#addin nuget:?package=DotNetCore.Azure.Configuration.KvSecrets&version=5.0.0

// Install DotNetCore.Azure.Configuration.KvSecrets as a Cake Tool
#tool nuget:?package=DotNetCore.Azure.Configuration.KvSecrets&version=5.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:

    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(VaultSecrets )).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,
                VaultSecrets = VaultSecrets 
            };

            configurationBuilder.AddAzureKeyVault(client, options);
        }

appsettings.json


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

The [Azure Identity library][identity] provides easy Azure Active Directory support for authentication.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.0 198 11/29/2023
7.0.0 332 11/12/2022
6.0.2 300 12/4/2021
6.0.0 321 11/16/2021
5.0.0 363 2/7/2021
3.1.0 532 3/11/2021

Only supports the .net 5.0.