I am having trouble in using User Secrets with Azure SDK WebJobs in a console application using Net Core 3.1

Question

I'm trying to use user secrets because I want to save my key AzureWebJobsStorage in secrets.json for local development.

So the problem is:

I created my user secrets, installed the necessary packages, but my webjob is still trying to use the keys in my appsettings.json.

What I accomplished so far:

I can read my secrets.json but I don't know where to go from here.

What have I tried

I have search through google but can't manage to find an answer. I saw similar questions here in StackOverflow but they refer to NetCore 2.0 or to something else not useful to me.

My files:

Program.cs

public class Program
{
    static async Task Main()
    {
        var builder = new HostBuilder();
        builder
        .UseEnvironment("Development")
        .ConfigureAppConfiguration((context, b) =>
        {
            if(context.HostingEnvironment.IsDevelopment())
                b.AddUserSecrets();
        })
        .ConfigureWebJobs(b =>
        {
            b.AddAzureStorageCoreServices();
            b.AddAzureStorage();
        })
        .ConfigureLogging((context, b) =>
        {
            b.AddConsole();
        })
        .ConfigureServices((context, b) =>
        {
            Infrastructure.IoC.DependencyResolver.RegisterServices(b, context.Configuration);
        });

        var host = builder.Build();
        using (host)
        {
            await host.RunAsync();
        }
    }
}

Functions.cs

public class Functions
{
    private readonly ITransactionService _transactionService;

    public Functions(ITransactionService transactionService)
    {
        _transactionService = transactionService;
    }

    public void ProcessQueueMessage([QueueTrigger("my_queue")] string message, ILogger logger)
    {
        try
        {
            Validate.IsTrue(long.TryParse(message, out long transactionId), "Invalid transaction from queue");
            _transactionService.CategorizeAllOtherTransactions(transactionId).Wait();
        }
        catch (System.Exception)
        {
            logger.LogInformation(message);
        }
    }
}

.csproj file:


  
    Exe
    netcoreapp3.1
    7f046fd1-a48c-4aa6-95db-009313bcb42b
  

  
    
    
    
    
  

  
    
  

  
    
      PreserveNewest

user_336378 · Answer

As we discussed on GitHub, user secrets can be used to resolve the AzureWebJobsStorage value.

Key elements:

Program.cs

            builder.ConfigureAppConfiguration((context, configurationBuilder) =>
            {
                configurationBuilder
                    .AddJsonFile($"appsettings.{context.HostingEnvironment.EnvironmentName}.json", optional: false)
                    .AddEnvironmentVariables();

                if (context.HostingEnvironment.IsDevelopment())
                {
                    configurationBuilder
                        .AddUserSecrets();
                }
            });

secrets.json:

{
  "ConnectionStrings": {
    "AzureWebJobsStorage": "..."
  }
}

launch.json:

{
  "profiles": {
    "WebJob-netcore-sample": {
      "commandName": "Project",
      "environmentVariables": {
        "DOTNET_ENVIRONMENT": "Development"
      }
    }
  }
}

user_8557999 · Answer

You could refer to the following code to get secrets value with Configuration["MyOptions:Secret1"].

public static IConfigurationRoot Configuration { get; set; }

static void Main(string[] args)
{
    var builder = new ConfigurationBuilder()
        .SetBasePath(Directory.GetCurrentDirectory())
        .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
        .AddEnvironmentVariables();
            
    builder.AddUserSecrets();
    Configuration = builder.Build();
    var a = Configuration["MyOptions:Secret1"];
}

public class MyOptions
{
    public string Secret1 { get; set; }
    public string Secret2 { get; set; }
}

The secrets.json is like below:

{
  "MyOptions": {
    "Secret1": "123",
    "Secret2": "456"
  }
}

Also, you could use following code in Main to get secrets value.

var services = new ServiceCollection()
    .Configure(Configuration.GetSection(nameof(MyOptions)))
    .BuildServiceProvider();
var options = services.GetRequiredService>();
var b = options.Value.Secret1;

I am having trouble in using User Secrets with Azure SDK WebJobs in a console application using Net Core 3.1

2 Answers