Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/a-patel/azure-app-configuration-labs
Demo: Azure App Configuration + .NET 5.x
https://github.com/a-patel/azure-app-configuration-labs
app-config app-configuration appsettings asp-net-core aspnetcore azure azure-app-configuration azure-functions azure-keyvault configuration-management demo demo-app dotnet dotnet-core dotnetcore key-vault labs
Last synced: about 2 months ago
JSON representation
Demo: Azure App Configuration + .NET 5.x
- Host: GitHub
- URL: https://github.com/a-patel/azure-app-configuration-labs
- Owner: a-patel
- License: mit
- Created: 2019-12-17T18:25:27.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T20:58:41.000Z (11 months ago)
- Last Synced: 2024-06-12T08:12:50.620Z (3 months ago)
- Topics: app-config, app-configuration, appsettings, asp-net-core, aspnetcore, azure, azure-app-configuration, azure-functions, azure-keyvault, configuration-management, demo, demo-app, dotnet, dotnet-core, dotnetcore, key-vault, labs
- Language: C#
- Homepage:
- Size: 73.2 KB
- Stars: 5
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Azure App Configuration (with .NET) Labs
> Demo: Azure App Configuration + .NET 5.x
Please refer to below articles of my publication [Awesome Azure](https://medium.com/awesome-azure) and [ASPNETCore](https://medium.com/aspnetcore) on Azure App Configuration:
- [Use Azure App Configuration with .NET/ASP.NET Core Applications](https://medium.com/aspnetcore/use-azure-app-configuration-with-asp-net-core-application-6bdf0cc851e2)
- [Azure — Introduction to Azure App Configuration](https://medium.com/awesome-azure/azure-introduction-to-azure-app-configuration-f4a4c43ec5db)
---
## Usage: Web/API Application :page_facing_up:
### Step 1 : Install the package :package:
> To install NuGet, run the following command in the [Package Manager Console](http://docs.nuget.org/docs/start-here/using-the-package-manager-console)
```Powershell
PM> Install-Package Microsoft.Azure.AppConfiguration.AspNetCore
PM> Install-Package Microsoft.FeatureManagement.AspNetCore
PM> Install-Package Azure.Identity
```
### Step 2 : Configuration 🔨
> Here are samples that show you how to config.
##### 2.1 : AppSettings
```js
{
// Way-1: Connect to Azure App Configuration using the Managed Identity (for Production Scenario)
"AzureAppConfigurationEndpoint": "https://[YOUR_APP_CONFIGURATION_NAME].azconfig.io",
// Way-2: Connect to Azure App Configuration using the Connection String (for Development Scenario)
"AzureAppConfigurationConnectionString": "[YOUR_APP_CONFIGURATION_CONNECTIONSTRING]",
// Sample Settings of your application
"Settings": {
"AppName": "Azure App Configuration Labs",
"Version": 1.0,
"FontSize": 50,
"RefreshRate": 1000,
"Language": "English",
"Messages": "Hello There. Thanks for using Azure App Configuration.",
"BackgroundColor": "Black"
}
}
```
##### 2.2 : Configure Program Class
```cs
public class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.ConfigureAppConfiguration((context, config) =>
{
var settings = config.Build();
if (!context.HostingEnvironment.IsDevelopment())
{
// Way-1: Secure way (For Production scenario, works with Azure Services like App Service, VM, VMSS, Functions)
// Connect to Azure App Configuration using the Managed Identity
// Prerequisite: The application identity is granted "App Configuration Data Reader" role in the App Configuration store
var appConfigurationEndpoint = settings["AzureAppConfigurationEndpoint"];
if (!string.IsNullOrEmpty(appConfigurationEndpoint))
{
config.AddAzureAppConfiguration(options =>
{
options.Connect(new Uri(appConfigurationEndpoint), new DefaultAzureCredential());
// .Select(keyFilter: "MyApp:*")
// .Select(keyFilter: "Settings:*")
// .ConfigureRefresh((refreshOptions) =>
// {
// // Indicates that all configuration should be refreshed when the given key has changed.
// refreshOptions.Register(key: "Settings:RefreshRate", refreshAll: true);
// });
//// Not recommanded
//options.Connect(new Uri(appConfigurationEndpoint), new ManagedIdentityCredential("YtB9-l0-s0:wLoLgJN/gvBQZKPCZsgc"));
});
}
// OLD: When using version 2.1 in the following way, it works fine
//if (!string.IsNullOrEmpty(appConfigurationEndpoint))
//{
// config.AddAzureAppConfiguration(options =>
// options.ConnectWithManagedIdentity(appConfigurationEndpoint));
//}
}
else
{
// Way-2
// Connect to Azure App Configuration using the Connection String.
var appConfigurationConnectionString = settings["AzureAppConfigurationConnectionString"];
//config.AddAzureAppConfiguration(appConfigurationConnectionString);
config.AddAzureAppConfiguration(options =>
{
options.Connect(appConfigurationConnectionString).ConfigureRefresh((refreshOptions) =>
{
// indicates that all configuration should be refreshed when the given key has changed.
refreshOptions.Register(key: "Settings:Sentinel", refreshAll: true);
refreshOptions.SetCacheExpiration(TimeSpan.FromSeconds(5));
}).UseFeatureFlags();
});
//// Way-3
//// Misc: Use App Configuration values as well as Key Vault references.
//// You can now access Key Vault references just like any other App Configuration key.
//// The config provider will use the KeyVaultClient that you configured to authenticate to Key Vault and retrieve the value.
//var azureServiceTokenProvider = new AzureServiceTokenProvider();
//var keyVaultClient = new KeyVaultClient(new KeyVaultClient.AuthenticationCallback(azureServiceTokenProvider.KeyVaultTokenCallback));
//config.AddAzureAppConfiguration(options =>
// options.Connect(appConfigurationConnectionString)
// .UseAzureKeyVault(keyVaultClient)
// );
}
});
webBuilder.UseStartup();
});
}
```
### Step 3 : Use in Controller or Business layer :memo:
```cs
public class TestController : ControllerBase
{
#region Members
private readonly Settings _settings;
#endregion
#region Ctor
public TestController(IOptionsSnapshot options)
{
_settings = options.Value;
}
#endregion
#region Methods
///
/// Get Settings
///
///
[HttpGet]
[Route("get-settings")]
public IActionResult GetSettings()
{
return Ok(_settings);
}
///
/// Get Settings
///
///
[FeatureGate(FeatureFlags.Beta)]
[HttpGet]
[Route("get-beta-settings")]
public IActionResult GetBetaSettings()
{
return Ok("This is Beta feature only");
}
#endregion
}
```
---
## Usage: Azure Functions :page_facing_up:
### Step 1 : Install the package :package:
> To install NuGet, run the following command in the [Package Manager Console](http://docs.nuget.org/docs/start-here/using-the-package-manager-console)
```Powershell
PM> Install-Package Microsoft.Extensions.Configuration.AzureAppConfiguration
PM> Install-Package Microsoft.FeatureManagement
```
### Step 2 : Configuration 🔨
> Here are samples that show you how to config.
##### 2.1 : AppSettings
```js
{
"IsEncrypted": false,
"Values": {
"AzureWebJobsStorage": "UseDevelopmentStorage=true",
"FUNCTIONS_WORKER_RUNTIME": "dotnet",
"AzureAppConfigurationConnectionString": "[YOUR_APP_CONFIGURATION_CONNECTIONSTRING]"
},
"Settings": {
"AppName": "Azure App Configuration with Azure Functions Labs",
"Version": 1.0,
"FontSize": 50,
"RefreshRate": 1000,
"Language": "English",
"Messages": "Hello There. Thanks for using Azure App Configuration with Azure Functions.",
"BackgroundColor": "Black"
}
}
```
##### 2.2 : Configure (Function)Startup Class
```cs
class Startup : FunctionsStartup
{
public override void Configure(IFunctionsHostBuilder builder)
{
IConfigurationRefresher configurationRefresher = null;
// Load configuration from Azure App Configuration
ConfigurationBuilder configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddAzureAppConfiguration(options =>
{
options.Connect(Environment.GetEnvironmentVariable("AzureAppConfigurationConnectionString"))
// Load all keys that start with `TestApp:`
.Select("MyFuncApp:*")
// Configure to reload configuration if the registered 'Sentinel' key is modified
.ConfigureRefresh(refreshOptions =>
refreshOptions.Register("MyFuncApp:Settings:Sentinel", refreshAll: true)
)
// Indicate to load feature flags
.UseFeatureFlags();
configurationRefresher = options.GetRefresher();
});
IConfiguration configuration = configurationBuilder.Build();
// Make settings, feature manager and configuration refresher available through DI
builder.Services.Configure(configuration.GetSection("MyFuncApp:Settings"));
builder.Services.AddFeatureManagement(configuration);
builder.Services.AddSingleton(configurationRefresher);
}
}
```
### Step 3 : Use in fucntions :memo:
```cs
public class DemoFunctions
{
#region Members
private readonly Settings _settings;
private readonly IFeatureManagerSnapshot _featureManagerSnapshot;
private readonly IConfigurationRefresher _configurationRefresher;
#endregion
#region Ctor
public DemoFunctions(IOptionsSnapshot settings, IFeatureManagerSnapshot featureManagerSnapshot, IConfigurationRefresher configurationRefresher)
{
_settings = settings.Value;
_featureManagerSnapshot = featureManagerSnapshot;
_configurationRefresher = configurationRefresher;
}
#endregion
#region Functions
[FunctionName("GetSettings")]
public async Task GetSettings(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
ILogger log)
{
// The configuration is refreshed asynchronously without blocking the execution of the current function.
_ = await _configurationRefresher.TryRefreshAsync();
string appName = _settings.AppName;
return appName != null
? (ActionResult)new OkObjectResult(appName)
: new BadRequestObjectResult($"Please create a key-value with the key 'MyFuncApp:Settings:Message' in Azure App Configuration.");
}
[FunctionName("ShowBetaFeature")]
public async Task ShowBetaFeature(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
ILogger log)
{
await _configurationRefresher.TryRefreshAsync();
string featureName = "Beta";
bool featureEnalbed = await _featureManagerSnapshot.IsEnabledAsync(featureName);
return featureEnalbed
? (ActionResult)new OkObjectResult($"{featureName} feature is On")
: new BadRequestObjectResult($"{featureName} feature is Off (or the feature flag '{featureName}' is not present in Azure App Configuration).");
}
#endregion
}
```
---
## Give a Star! :star:
Feel free to request an issue on github if you find bugs or request a new feature. Your valuable feedback is much appreciated to better improve this project. If you find this useful, please give it a star to show your support for this project.
## Support :telephone:
> Reach out to me at one of the following places!
- Email :envelope: at `[email protected]`
## Author :boy:
* **Ashish Patel** - [A-Patel](https://github.com/a-patel)
##### Connect with me
| Linkedin | Portfolio | Medium | GitHub | NuGet | Microsoft | Twitter | Facebook | Instagram |
|----------|----------|----------|----------|----------|----------|----------|----------|----------|
| [](https://www.linkedin.com/in/iamaashishpatel) | [](https://aashishpatel.netlify.app/) | [](https://iamaashishpatel.medium.com) | [](https://github.com/a-patel) | [](https://nuget.org/profiles/iamaashishpatel) | [](https://docs.microsoft.com/en-us/users/iamaashishpatel) | [](https://twitter.com/aashish_mrcool) | [](https://www.facebook.com/aashish.mrcool) | [](https://www.instagram.com/iamaashishpatel/) |
## Donate :dollar:
If you find this project useful — or just feeling generous, consider buying me a beer or a coffee. Cheers! :beers: :coffee:
| PayPal | BMC | Patreon |
| ------------- | ------------- | ------------- |
| [](https://www.paypal.me/iamaashishpatel) | [](https://www.buymeacoffee.com/iamaashishpatel) | [](https://www.patreon.com/iamaashishpatel) |
## License :lock:
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.