DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
  1. DZone
  2. Coding
  3. Languages
  4. Read Configuration in the Controller: .NET Core Quick Posts

Read Configuration in the Controller: .NET Core Quick Posts

You can find my all .Net core posts here. In this series of posts, we will see some quick tips or tricks to use some specific things in .Net Core In this pos...

Neel Bhatt user avatar by
Neel Bhatt
CORE ·
Aug. 24, 18 · Tutorial
Like (2)
Save
Tweet
Share
36.08K Views

Join the DZone community and get the full member experience.

Join For Free

In this series of posts, we will look at some quick tips or tricks to use in .NET Core.

In this post, we will see how to access configuration in the controller.

As we know, in .NET Core we have an appsettings.json file to store the configuration related data.

For example, you have an appsettings.json as shown below:

{  
   "Logging":{  
      "IncludeScopes":false,
      "LogLevel":{  
         "Default":"Warning"
      }
   },
   "myFirstKey":"myFirstValue"
}

From .NET Core 2.0 and on, you are no more required to add new IConfiguration in the Startup constructor. Its implementation will be injected by the DI system and is already available in Startup.cs class:

Image title

But if you are targeting a .NET Core version lower than 2.0 then you need to add IConfiguration in Startup.cs.

Access Configuration in Controller

We can directly inject IConfigurationService into the controller as below:

public class HomeController: Controller {
 private IConfiguration _configuration;

 public HomeController(IConfiguration Configuration) {
  _configuration = Configuration;
 }
}

That is it. You can now access the config from the HomeController.

For example, if you want to use it in a Contact action, then access it as shown below:

public IActionResult Contact() {
ViewBag.ConfigValue = _configuration["myFirstKey"];
}

As you can see below, myFirstValueis the value of the key myFirstKey in the appsettings.json file.

Complex Config Structure

You can even have some complex structure in appsettings.json as below:

{  
   "MyConfigSection":{  
      "MyFirstConfig":"Neel Bhatt",
      "MySecondConfig":{  
         "MyFirstSubConfig":27,
         "MySecondSubConfig":"Pune"
      }
   }
}

To access this, write the below code:

public IActionResult Contact() {
 // Option 1: Configuration using Key string
 ViewData["MySectionMyFirstConfig"] = _configuration["MyConfigSection:MyFirstConfig"];

 // Option 2: Configuration using GetSection method
 ViewData["MySectionMySecondConfigMyFirstSubConfig"] = _configuration.GetSection("MyConfigSection").GetSection("MySecondConfig").GetSection("MyFirstSubConfig");

 // Option 3: Mixture of Option 1 & Option 2
 ViewData["MySectionMySecondConfigMySecondSubConfig"] = _configuration.GetSection("MyConfigSection")["MySecondConfig:MySecondSubConfig"];

 return View();
}

Read the Connection String

To read the connection string, you need to call it using the GetConnectionString method as shown below:

var connectionString = Configuration.GetConnectionString("myConnectionString");

Hope this helps.

You can find my all .NET Core posts here.

.NET POST (HTTP)

Published at DZone with permission of Neel Bhatt, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Specification by Example Is Not a Test Framework
  • Strategies for Kubernetes Cluster Administrators: Understanding Pod Scheduling
  • Rust vs Go: Which Is Better?
  • Spring Cloud

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: