DotNetCore.Azure.Configuration.KvSecrets 6.0.2

.NET 6.0
Install-Package DotNetCore.Azure.Configuration.KvSecrets -Version 6.0.2
dotnet add package DotNetCore.Azure.Configuration.KvSecrets --version 6.0.2
<PackageReference Include="DotNetCore.Azure.Configuration.KvSecrets" Version="6.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetCore.Azure.Configuration.KvSecrets --version 6.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DotNetCore.Azure.Configuration.KvSecrets, 6.0.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. 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=6.0.2

// Install DotNetCore.Azure.Configuration.KvSecrets as a Cake Tool
#tool nuget:?package=DotNetCore.Azure.Configuration.KvSecrets&version=6.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

DotNetCore Azure Configuration Key Vault Secrets

The DotNetCore.Azure.Configuration.KvSecrets based on Azure.Extensions.AspNetCore.Configuration.Secrets.

Improvements

  • Allows storing configuration values using Azure Key Vault Secrets.
  • 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 and [Azure Key Vault][keyvault_doc] to use this package.

To create a new Key Vault, you can use the Azure Portal, Azure PowerShell, or the Azure 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"

.NetCore Microservice Examples

Can be used in conjunction with DotNetCore Azure Configuration KeyVault Certificates.

Add configuration provider with WebHostBuiler initialization.

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();

            var options = configuration.GetSection(nameof(AzureKvConfigurationOptions))
                               .Get<AzureKvConfigurationOptions>();

            var credential = new DefaultAzureCredential(
                new DefaultAzureCredentialOptions()
                {
                    ExcludeSharedTokenCacheCredential = true,
                    ExcludeVisualStudioCodeCredential = true,
                    ExcludeVisualStudioCredential = true,
                    ExcludeInteractiveBrowserCredential = true
                });
          
            // Adds Azure Key Valt configuration provider.
            configurationBuilder.AddAzureKeyVault(credential, options);
           
        }

appsettings.json

"AzureKvConfigurationOptions": {
  "ConfigurationSectionPrefix": "secret",
  "VaultUri": "https://secrets128654s235.vault.azure.net/",
  "VaultSecrets": [ 
    "service-bus-Developement-connection",
    "sql-Developement-password",
    "sql-Developement-user"
    "service-bus-Production-connection",
    "sql-Production-password",
    "sql-Production-user" ]
    }

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

Read more about configuration in ASP.NET Core.

Example with DotNetCore Configuration Templates

Use DotNetCore Configuration Templates to inject secrets into Microservice configuration.

Add to project nuget package DotNetCore.Configuration.Formatter.

Environment Variables set to :
DOTNET_RUNNING_IN_CONTAINER=true
ASPNETCORE_ENVIRONMENT=Development
...
host_environmet=datacenter
Microservice has the ApplicationConfiguration.cs

public class ApplicationConfiguration 
{
     public bool IsDocker {get; set;}
     public string RunLocation {get; set;}
     public string AppEnvironment {get; set;}
     public string BusConnection {get; set;}
     public string DbUser {get; set;}
     public string DbPassword {get; set;}
}
Microservice has the following appsettings.json:
{
"AzureKvConfigurationOptions": {
  "ConfigurationSectionPrefix": "secret",
  "VaultUri": "https://secrets128654s235.vault.azure.net/",
  "VaultSecrets": [ 
    "service-bus-Development-connection",
    "sql-Development-password",
    "sql-Development-user",
    "service-bus-Production-connection",
    "sql-Production-password",
    "sql-Production-user" ]
    }

  ApplicationConfiguration:{
     "IsDocker": "{DOTNET_RUNNING_IN_CONTAINER??false}",
     "RunLocation":"{host_environmet??local}",
     "AppEnvironment":"{ENVIRONMENT}",
     "BusConnection":"{secret:service-bus-{ENVIRONMENT}-connection}",
     "DbPassword":"{secret:sql-{ENVIRONMENT}-password}",
     "DbUser":"{secret:sql-{ENVIRONMENT}-user}"
  }
}
Microservice the Startup.cs

     var applicationConfig = Configuration.UseFormater()
     .GetSection(nameof(ApplicationConfiguration))
     .Get<ApplicationConfiguration>();

or with shorthand


     var applicationConfig = Configuration.GetTypeNameFormatted<ApplicationConfiguration>();

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
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
6.0.2 116 12/4/2021
6.0.0 142 11/16/2021
5.0.0 170 2/7/2021
3.1.0 332 3/11/2021

Only supports the .net 6.0.