Class AzureAppConfigurationOptions

Namespace

Microsoft.Extensions.Configuration.AzureAppConfiguration

Assembly

Microsoft.Extensions.Configuration.AzureAppConfiguration.dll

Options used to configure the behavior of an Azure App Configuration provider.

public class AzureAppConfigurationOptions

Inheritance

object

AzureAppConfigurationOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AzureAppConfigurationOptions()

public AzureAppConfigurationOptions()

Properties

KeyValueSelectors

A collection of KeyValueSelector.

public IEnumerable<KeyValueSelector> KeyValueSelectors { get; }

Property Value

IEnumerable<KeyValueSelector>

OfflineCache

An offline cache provider which can be used to enable offline data retrieval and storage.

public IOfflineCache OfflineCache { get; }

Property Value

IOfflineCache

Methods

ConfigureClientOptions(Action<ConfigurationClientOptions>)

Configure the client used to communicate with Azure App Configuration.

public AzureAppConfigurationOptions ConfigureClientOptions(Action<ConfigurationClientOptions> configure)

Parameters

configure Action<ConfigurationClientOptions>

A callback used to configure Azure App Configuration client options.

Returns

AzureAppConfigurationOptions

ConfigureKeyVault(Action<AzureAppConfigurationKeyVaultOptions>)

Configures the Azure App Configuration provider to use the provided Key Vault configuration to resolve key vault references.

public AzureAppConfigurationOptions ConfigureKeyVault(Action<AzureAppConfigurationKeyVaultOptions> configure)

Parameters

configure Action<AzureAppConfigurationKeyVaultOptions>

A callback used to configure Azure App Configuration key vault options.

Returns

AzureAppConfigurationOptions

ConfigureRefresh(Action<AzureAppConfigurationRefreshOptions>)

Configure refresh for key-values in the configuration provider.

public AzureAppConfigurationOptions ConfigureRefresh(Action<AzureAppConfigurationRefreshOptions> configure)

Parameters

configure Action<AzureAppConfigurationRefreshOptions>

A callback used to configure Azure App Configuration refresh options.

Returns

AzureAppConfigurationOptions

Connect(string)

Connect the provider to the Azure App Configuration service via a connection string.

public AzureAppConfigurationOptions Connect(string connectionString)

Parameters

connectionString string

Used to authenticate with Azure App Configuration.

Returns

AzureAppConfigurationOptions

Connect(Uri, TokenCredential)

Connect the provider to Azure App Configuration using endpoint and token credentials.

public AzureAppConfigurationOptions Connect(Uri endpoint, TokenCredential credential)

Parameters

endpoint Uri

The endpoint of the Azure App Configuration to connect to.

credential TokenCredential

Token credentials to use to connect.

Returns

AzureAppConfigurationOptions

GetRefresher()

Get an instance of IConfigurationRefresher that can be used to trigger a refresh for the registered key-values.

public IConfigurationRefresher GetRefresher()

Returns

IConfigurationRefresher

An instance of IConfigurationRefresher.

Select(string, string)

Specify what key-values to include in the configuration provider. Select(string, string) can be called multiple times to include multiple sets of key-values.

public AzureAppConfigurationOptions Select(string keyFilter, string labelFilter = "\0")

Parameters

keyFilter string

The key filter to apply when querying Azure App Configuration for key-values. The characters asterisk (*), comma (,) and backslash () are reserved and must be escaped using a backslash (). Built-in key filter options: KeyFilter.

labelFilter string

The label filter to apply when querying Azure App Configuration for key-values. By default the null label will be used. Built-in label filter options: LabelFilter The characters asterisk (*) and comma (,) are not supported. Backslash () character is reserved and must be escaped using another backslash ().

Returns

AzureAppConfigurationOptions

SetOfflineCache(IOfflineCache)

Use an offline file cache to store Azure App Configuration data or retrieve previously stored data during offline periods.

public AzureAppConfigurationOptions SetOfflineCache(IOfflineCache offlineCache)

Parameters

offlineCache IOfflineCache

The offline file cache to use for storing/retrieving Azure App Configuration data.

Returns

AzureAppConfigurationOptions

TrimKeyPrefix(string)

Trims the provided prefix from the keys of all key-values retrieved from Azure App Configuration.

public AzureAppConfigurationOptions TrimKeyPrefix(string prefix)

Parameters

prefix string

The prefix to be trimmed.

Returns

AzureAppConfigurationOptions

UseFeatureFlags(Action<FeatureFlagOptions>)

Enables Azure App Configuration feature flags to be parsed and transformed into feature management configuration.

public AzureAppConfigurationOptions UseFeatureFlags(Action<FeatureFlagOptions> configure = null)

Parameters

configure Action<FeatureFlagOptions>

A callback used to configure feature flag options.

Returns

AzureAppConfigurationOptions