GCP.Extensions.Configuration.SecretManager 3.1.3

.NET Core 3.1
Install-Package GCP.Extensions.Configuration.SecretManager -Version 3.1.3
dotnet add package GCP.Extensions.Configuration.SecretManager --version 3.1.3
<PackageReference Include="GCP.Extensions.Configuration.SecretManager" Version="3.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GCP.Extensions.Configuration.SecretManager --version 3.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: GCP.Extensions.Configuration.SecretManager, 3.1.3"
#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 GCP.Extensions.Configuration.SecretManager as a Cake Addin
#addin nuget:?package=GCP.Extensions.Configuration.SecretManager&version=3.1.3

// Install GCP.Extensions.Configuration.SecretManager as a Cake Tool
#tool nuget:?package=GCP.Extensions.Configuration.SecretManager&version=3.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

GCP.Extensions.Configuration.SecretManager

Configuration provider for Microsoft.Extensions.Configuration framework.

See https://cloud.google.com/secret-manager/docs/reference/libraries on how to create application credential file.

When running outside cloud:

  • Set Environment variable GOOGLE_APPLICATION_CREDENTIALS to enable GoogleCredential.GetApplicationDefault().
  • Build GoogleCredential in code with GoogleCredential.GetApplicationDefault(), from file, or from JSON.

Set ProjectId value to over-ride value from GoogleCredential, inside or outside of cloud.

Multi-level Key support. Double underscore characters [__] in secret name will be replaced by configuration key path separator (colon [:])

Release Notes (v3.1.3)

  1. Fixed "value can not be Null or empty" error in KeyValue provider Load() method when prefix is Null.

Release Notes (v3.1.2)

  1. Added tags for JSON and KeyValue
  2. Fixed NULL reference error when GoogleCredential.UnderlyingCredential is not ServiceAccountCredential
  3. For KeyValue type secrets, made "strip prefix from key" optional (default is true for backwards compatability).
  4. Added Action type extension method over-rides.

Update (v3.1.1) ProjectId, when not specified, is auto-populated from:

  1. ServiceAccountCredential
  2. The GCP API ( Google.Api.Gax.Platform.Instance().ProjectId )
  3. Environment variables ( "GOOGLE_CLOUD_PROJECT", "GCLOUD_PROJECT" ).

Important! Only the most recently created, ENABLED version of any secret will be used.


// typical usage:
//   GoogleCredential will be created as GoogleCredential.GetApplicationDefault()
//   ProjectId will be derived from GoogleCredential if ServiceAccountCredential
//   or environment otherwise.
public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((hostContext, builder) => {

        // filter rules: https://cloud.google.com/secret-manager/docs/filtering
            builder.AddGcpJsonSecrets("name:servicename_appsettings_");

        // prefix will filter list, then be stripped from key names.
            builder.AddGcpKeyValueSecrets("servicename_keys_");
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });


// build credential from existing configuration settings:
//   ProjectId will be derived from GoogleCredential if ServiceAccountCredential
//   or environment otherwise.
public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((hostContext, builder) => {

        var tempConfig = builder.Build();
        var googleCredential = getGoogleCredentialFromConfig(tempConfig);

        // filter rules: https://cloud.google.com/secret-manager/docs/filtering
            builder.AddGcpJsonSecrets("name:servicename_appsettings_", googleCredential);

        // prefix will filter list, then be stripped from key names.
            builder.AddGcpKeyValueSecrets("servicename_keys_", googleCredential);
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });


        // use your own SecretManagerServiceClient
        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration((hostContext, builder) =>
                {
                   var config = builder.Build();
                   SecretManagerServiceClient client = BuildServiceClient(config);
                   builder.AddGcpJsonSecrets(options => {
                       options.ListFilter = "name:servicename_appsettings_";
                       options.SecretMangerClient = client;
                   });
                   builder.AddGcpKeyValueSecrets(options => {
                       options.SecretNamePrefix = "keyname";
                       options.StripPrefixFromKey = false;
                       options.SecretMangerClient = client;
                   });
                })
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp3.1
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
3.1.3 352 12/22/2021
3.1.2 87 12/12/2021
3.1.1 93 12/10/2021
3.1.0 89 11/27/2021

1. Fixed "value can not be Null or empty" error in KeyValue provider Load() method when prefix is Null.