aspnet/Microsoft.Configuration.ConfigurationBuilders.AzureAppConfigurationv3.0.0
✓ Verified
A set of Configuration Builders for the .Net Framework that draw from Azure AppConfiguration stores.
Get Started
$ dotnet add package Microsoft.Configuration.ConfigurationBuilders.AzureAppConfigurationReadme
Azure AppConfiguration ConfigBuilder
This package provides a config builder that draws its values from an Azure App Configuration. The builder uses DefaultAzureCredential for connecting with the App Configuration service. More comprehensive documentation exists at the MicrosoftConfigBuilders project.
The basic usage of this builder is given below. Parameters inside []s are optional. Parameters grouped in ()s are mutually exclusive. Parameters beginning with @ allow appSettings substitution. The first line of parameters are common to all builders and optional. Their meaning, usage, and defaults are documented here. They are grouped on one line for brevity. When a builder uses a different default value than the project default, the differing value is also listed. Builder-specific settings are listed on each line thereafter followed by a brief explanation.
<add name="AzureAppConfig"
[@mode|@enabled="enabled"|@charMap|@prefix|@stripPrefix|tokenPattern|@escapeExpandedValues]
(@endpoint="https://your-appconfig-store.azconfig.io" | @connectionString="Endpoint=https://your-appconfig-store.azconfig.io;Id=XXXXXXXXXX;Secret=XXXXXXXXXX")
[@keyFilter="string"]
[@labelFilter="label"]
[@acceptDateTime="DateTimeOffset"]
[@useAzureKeyVault="bool"]
type="Microsoft.Configuration.ConfigurationBuilders.AzureAppConfigurationBuilder, Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration" />
:information_source: [NOTE]
When connecting to an Azure App Configuration store, the identity that is being used must be assigned either the
Azure App Configuration Data Readerrole or theAzure App Configuration Data Ownerrole. Otherwise the config builder will encounter a "403 Forbidden" response from Azure and throw an exception if not .