Using an array in Azure web app settings

Question

In my ASP.NET 5 (RC1) code I have an appsetting.json that looks something like this:

{
    "SomeSettings": {
        "PropA": "ValueA",
        "PropB": [
            "ValueB1",
            "ValueB2"
        ]
    }
}

These value are used when a run the code on my dev machine (ie. localhost). If I want to overwrite the "SomeSettings" in Azure's Application settings for the wep app, how would I specify the "PropB" array?

The SomeSettings.cs class that I want to store the information in looks like this:

public class SomeSettings
{
    public string PropA { get; set; }
    public List<string> PropB { get; set; }
}

The problem is "PropB" - how to I specify an array or List as a string in Azure - is this even possible?

In my Startup class's constructor I have:

var builder = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .AddEnvironmentVariables();

And in my Startup class's Configure methods I have:

var someSettings = configuration.GetSection("SomeSettings").Get<SomeSettings>();

Andrew · Accepted Answer · 2022-11-26 15:52:19Z

163

Adding the settings under "App settings" like this will do the trick... Notice the ":0" and ":1" below

Format: Key -> Value

SomeSettings:PropA -> AzureValueA
SomeSettings:PropB:0 -> AzureValueB1
SomeSettings:PropB:1 -> AzureValueB2

If you aren't running on Windows, replace the colon : with double underscore __ to get your app to see the settings. So instead of e.g. SomeSettings:PropB:1, you'd use SomeSettings__PropB__1.

edited Nov 26, 2022 at 15:52

Andrew

20.4k13 gold badges110 silver badges122 bronze badges

answered Dec 3, 2015 at 10:13

Kenneth Kryger Sørensen

2,9822 gold badges23 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

Alezis Over a year ago

As of today it works great. Just want to confirm approach is still here. We use VSTS to deploy WebApp arguments via PS scripts, now we can push arrays. Thanks.

gabe Over a year ago

Do you know how you would represent SomeSettings__PropB as an empty array?

joe Over a year ago

This also works in Azure Functions' local.settings.json.

Neutrino Over a year ago

For an unnamed array of object use sectionName:0:PropA sectionName:0:PropB sectionName:1:PropA sectionName:1:PropB etc. For Linux services replace : with double underscore __

Chelsea Saffold Over a year ago

This still works in 2023 on app services, for APIs or azure functions.

|

Nurhak Kaya · Accepted Answer · 2022-11-16 11:05:01Z

2

In case the array value is an object (see that WriteTo value below) you can copy the entire WriteTo value, update the values if you need to and create an application setting for it as follows;

  "Serilog": {
    "WriteTo": [
      {
        "Name": "ApplicationInsights",
        "Args": {
          "restrictedToMinimumLevel": "Information",
          "telemetryConverter": "Serilog.Sinks.ApplicationInsights.Sinks.ApplicationInsights.TelemetryConverters.TraceTelemetryConverter, Serilog.Sinks.ApplicationInsights",
          "instrumentationKey": "YOUR-KEY"
        }
      },
      {
        "Name": "UmbracoFile",
        "Args": {
          "RestrictedToMinimumLevel": "Error"
        }
      },
      {
        "Name": "Async",
        "Args": {
          "configure": [
            {
              "Name": "Console"
            }
          ]
        }
      }

    ]
  }

edited Nov 16, 2022 at 11:05

answered Nov 14, 2022 at 21:19

Nurhak Kaya

1,8012 gold badges22 silver badges22 bronze badges

2 Comments

Michel Jansson Over a year ago

I can't seem to get this to work. I try to use if to feature management filters that has a crazy amount for properties and arrays. Is there anything special that needs to happen for this to work?

Nurhak Kaya Over a year ago

No, nothing special. It is exactly how I described it in my answer. Hope this helps.

Sergio M. · Accepted Answer · 2023-02-01 09:59:43Z

0

Following the documentation the value should be like this:

['entry1', 'entry2', 'entry3']

https://learn.microsoft.com/en-us/azure/app-service/configure-common?tabs=portal#configure-arrays-in-app-settings

answered Feb 1, 2023 at 9:59

Sergio M.

1251 silver badge9 bronze badges

3 Comments

Koja Over a year ago

It's in the official documentation, but this doesn't work for me. The array that I have in my appsettings.json is not being overridden.

Josh Sutterfield Over a year ago

Since the linked doc doesn't seem to show anything about arrays anymore, here's something else that clarifies the obscure convention: learn.microsoft.com/en-us/aspnet/core/fundamentals/… The double-underscore notation may or may not apply (obscure in its own right), but the key is that "the array index should be treated as an additional element name in this path".

Maxoizs Over a year ago

this works fine for me, not sure if the array is making any difference ( options object is defined as array not list ) but I do have the configurations as an array and I use IOptions and it's working

Xiaomin Wu · Accepted Answer · 2015-12-11 23:25:37Z

-10

Simple approach is store the JSON as string in AppSetting, and de-serialize by yourself

var serializer = new JavaScriptSerializer();
var settings = serializer.Deserialize<SomeSettings>(configuration.GetSection("SomeSettings"));

or you will have to create your own customer configuration i believe. https://msdn.microsoft.com/en-us/library/2tw134k3.aspx

answered Dec 11, 2015 at 23:25

Xiaomin Wu

3,7951 gold badge18 silver badges14 bronze badges

1 Comment

Mohammad Nikravan Over a year ago

The question is about "Azure web app settings", your answer is irrelevant.

Collectives™ on Stack Overflow

Using an array in Azure web app settings

4 Answers 4

9 Comments

2 Comments

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

9 Comments

2 Comments

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related