sunnyatimagile/Imagile.Framework.Configurationv1.0.7
.NET 10.0
Azure configuration abstractions for .NET applications. Includes AppTokenCredential for cloud/local authentication, Key Vault reference replacement, and configuration validation with data annotations.
Get Started
$ dotnet add package Imagile.Framework.ConfigurationReadme
Imagile.Framework.Configuration
Azure configuration abstractions for .NET applications. Provides seamless integration with Azure Key Vault, automatic credential management for cloud and local development, and comprehensive configuration validation.
Installation
dotnet add package Imagile.Framework.Configuration
Quick Start
using Imagile.Framework.Configuration.Extensions;
var builder = WebApplication.CreateBuilder(args);
// One-line setup: Key Vault + Validation
builder.Services.AddFrameworkConfiguration(builder.Configuration, config => config
.WithKeyVault(new Uri("https://myvault.vault.azure.net/"))
.WithValidation());
var app = builder.Build();
app.Run();
Features
AppTokenCredential - Cloud and Local Authentication
Automatically selects the appropriate Azure authentication method based on environment:
Cloud (Azure):
- WorkloadIdentityCredential (AKS with federated identity)
- ManagedIdentityCredential (App Service, Container Apps, Functions, VMs)
Local Development:
- AzureCliCredential (fastest, cross-platform)
- VisualStudioCredential (Visual Studio account)
No code changes needed when moving between environments.
Key Vault Reference Replacement
Store secrets in Azure Key Vault and reference them in configuration using @KeyVault(SecretName) syntax:
appsettings.json:
{
"Database": {
"Host": "localhost",
"Password": "@KeyVault(DbPassword)"
},
"Api": {
"Key": "@KeyVault(ApiKey)"
}
}
The framework automatically replaces these references with actual secret values from Key Vault at startup.
Configuration Validation
Validate configuration using data annotations with recursive validation and aggregated error messages:
public class DatabaseSettings
{
[Required]
public string Host { get; set; } = string.Empty;
[Range(1, 65535)]
public int Port { get; set; }
[Required]
public RetrySettings Retry { get; set; } = null!;
}
public class RetrySettings
{
[Range(0, 10)]
public int MaxAttempts { get; set; }
}
// Validate configuration
var settings = configuration.Get<DatabaseSettings>()!;
settings.ValidateRecursively(); // Throws ConfigurationValidationException with all errors