CasCap.Common.Configuration
4.11.0
Prefix Reserved
dotnet add package CasCap.Common.Configuration --version 4.11.0
NuGet\Install-Package CasCap.Common.Configuration -Version 4.11.0
<PackageReference Include="CasCap.Common.Configuration" Version="4.11.0" />
<PackageVersion Include="CasCap.Common.Configuration" Version="4.11.0" />
<PackageReference Include="CasCap.Common.Configuration" />
paket add CasCap.Common.Configuration --version 4.11.0
#r "nuget: CasCap.Common.Configuration, 4.11.0"
#:package CasCap.Common.Configuration@4.11.0
#addin nuget:?package=CasCap.Common.Configuration&version=4.11.0
#tool nuget:?package=CasCap.Common.Configuration&version=4.11.0
CasCap.Common.Configuration
Configuration bootstrapping helpers for .NET applications — standard IConfiguration pipeline setup, Azure Key Vault integration, and validated IOptions<T> binding for IAppConfig records.
Installation
dotnet add package CasCap.Common.Configuration
Purpose
Provides a standardised way to build the configuration pipeline (appsettings.json, environment overrides, environment variables, user secrets, Azure Key Vault) and to bind configuration sections to IAppConfig record types with DataAnnotations validation on startup.
Target frameworks: netstandard2.0, net8.0, net9.0, net10.0
Extensions
| Class | Key Methods |
|---|---|
ConfigurationBuilderExtensions |
AddStandardConfiguration() — sets base path, registers appsettings.json, appsettings.{env}.json, environment variables, and optional user secrets |
AddKeyVaultConfiguration() — conditionally adds Azure Key Vault (skips silently when URI or credential is null) |
|
AddKeyVaultConfigurationFrom() — partial-builds configuration, extracts Key Vault credentials via delegate, then adds Key Vault |
|
ConfigurationServiceCollectionExtensions |
AddCasCapConfiguration<TConfig>() — binds a configuration section to an IAppConfig record with ValidateDataAnnotations and ValidateOnStart |
Usage
var configuration = new ConfigurationBuilder()
.AddStandardConfiguration(environmentName, Assembly.GetExecutingAssembly())
.AddKeyVaultConfigurationFrom(cfg =>
{
var appConfig = cfg.GetSection(AppConfig.ConfigurationSectionName).Get<AppConfig>();
return (appConfig?.KeyVaultUri, appConfig?.TokenCredential);
})
.Build();
Configuration Hierarchy
Configuration bootstrapping flow with layered sources:
flowchart TD
START["ConfigurationBuilder"]
subgraph StandardConfig["AddStandardConfiguration()"]
BASE["SetBasePath(contentRoot)"]
APPSETTINGS["appsettings.json"]
ENV_FILE["appsettings.{Environment}.json"]
ENV_VARS["Environment Variables"]
SECRETS["User Secrets<br/>(Development only)"]
end
subgraph KeyVaultConfig["AddKeyVaultConfiguration()"]
PARTIAL["Partial Build Config"]
EXTRACT["Extract Key Vault URI<br/>+ TokenCredential"]
KV["Azure Key Vault<br/>(secrets override)"]
end
subgraph Binding["IOptions Binding"]
VALIDATE["AddCasCapConfiguration<TConfig>()<br/>ValidateDataAnnotations<br/>ValidateOnStart"]
OPTIONS["IOptions<TConfig><br/>(DI injectable)"]
end
START --> BASE
BASE --> APPSETTINGS
APPSETTINGS --> ENV_FILE
ENV_FILE --> ENV_VARS
ENV_VARS --> SECRETS
SECRETS --> PARTIAL
PARTIAL --> EXTRACT
EXTRACT -."if URI present".-> KV
KV --> VALIDATE
SECRETS -."if no Key Vault".-> VALIDATE
VALIDATE --> OPTIONS
Layering Priority (later sources override earlier ones):
appsettings.jsonappsettings.{Environment}.json- Environment Variables
- User Secrets (Development only)
- Azure Key Vault (if configured)
Dependencies
NuGet Packages
| Package | Purpose |
|---|---|
Azure.Extensions.AspNetCore.Configuration.Secrets |
Azure Key Vault configuration provider |
Microsoft.Extensions.Configuration.EnvironmentVariables |
Environment variable configuration source |
Microsoft.Extensions.Configuration.FileExtensions |
File-based configuration helpers (SetBasePath) |
Microsoft.Extensions.Configuration.Json |
JSON file configuration source |
Microsoft.Extensions.Configuration.UserSecrets |
User secrets configuration source |
Microsoft.Extensions.Options.ConfigurationExtensions |
IOptions<T> binding to IConfiguration |
Microsoft.Extensions.Options.DataAnnotations |
ValidateDataAnnotations / ValidateOnStart |
Project References
| Project | Purpose |
|---|---|
CasCap.Common.Abstractions |
IAppConfig contract used as a generic constraint |
CasCap.Common.Logging |
ApplicationLogging static logger factory |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Azure.Extensions.AspNetCore.Configuration.Secrets (>= 1.5.1)
- CasCap.Common.Abstractions (>= 4.11.0)
- CasCap.Common.Logging (>= 4.11.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.7)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.7)
- Microsoft.Extensions.Configuration.Json (>= 10.0.7)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.7)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.7)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.7)
-
net10.0
- Azure.Extensions.AspNetCore.Configuration.Secrets (>= 1.5.1)
- CasCap.Common.Abstractions (>= 4.11.0)
- CasCap.Common.Logging (>= 4.11.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.7)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.7)
- Microsoft.Extensions.Configuration.Json (>= 10.0.7)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.7)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.7)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.7)
-
net8.0
- Azure.Extensions.AspNetCore.Configuration.Secrets (>= 1.5.1)
- CasCap.Common.Abstractions (>= 4.11.0)
- CasCap.Common.Logging (>= 4.11.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.7)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.7)
- Microsoft.Extensions.Configuration.Json (>= 10.0.7)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.7)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.7)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.7)
-
net9.0
- Azure.Extensions.AspNetCore.Configuration.Secrets (>= 1.5.1)
- CasCap.Common.Abstractions (>= 4.11.0)
- CasCap.Common.Logging (>= 4.11.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.7)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.7)
- Microsoft.Extensions.Configuration.Json (>= 10.0.7)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.7)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.7)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.7)
NuGet packages (5)
Showing the top 5 NuGet packages that depend on CasCap.Common.Configuration:
| Package | Downloads |
|---|---|
|
CasCap.Api.Knx
.NET client library for KNX building automation — connects via KNXnet/IP tunnelling or routing, monitors group-address telegrams, and fans events out to configurable sinks. |
|
|
CasCap.Api.Buderus
.NET client library for Buderus KM200 heat-pump controller — polls temperature datapoints via the encrypted local HTTPS API and dispatches readings to configurable sinks. |
|
|
CasCap.Api.DoorBird
.NET client library for DoorBird IP video door station — captures doorbell, motion and RFID events via the local LAN API and dispatches them to configurable sinks. |
|
|
CasCap.Api.Fronius
.NET client library for Fronius solar inverter monitoring — samples power-flow data via the local Solar API v1 and dispatches readings to configurable sinks. |
|
|
CasCap.Api.SignalCli
Typed .NET client for the signal-cli REST API with REST polling and JSON-RPC WebSocket transports, webhook endpoints, health checks, and INotifier integration. |
GitHub repositories
This package is not used by any popular GitHub repositories.