Interface IConfigurationRefresher

Namespace

Microsoft.Extensions.Configuration.AzureAppConfiguration

Assembly

Microsoft.Extensions.Configuration.AzureAppConfiguration.dll

An interface used to trigger an update for the data registered for refresh with App Configuration.

public interface IConfigurationRefresher

Properties

AppConfigurationEndpoint

The App Configuration endpoint.

Uri AppConfigurationEndpoint { get; }

Property Value

Uri

Methods

RefreshAsync()

Refreshes the data from App Configuration asynchronously.

Task RefreshAsync()

Returns

Task

Exceptions

KeyVaultReferenceException

An error occurred when resolving a reference to an Azure Key Vault resource.

Azure.RequestFailedException

The request failed with an error code from the server.

AggregateException

The refresh operation failed with one or more errors. Check InnerExceptions for more details.

InvalidOperationException

The refresh operation was invoked before Azure App Configuration Provider was initialized.

SetDirty(TimeSpan?)

Sets the cached value for key-values registered for refresh as dirty. A random delay is added before the cached value is marked as dirty to reduce potential throttling in case multiple instances refresh at the same time.

void SetDirty(TimeSpan? maxDelay = null)

Parameters

maxDelay TimeSpan?

Maximum delay before the cached value is marked as dirty. Default value is 30 seconds.

TryRefreshAsync()

Refreshes the data from App Configuration asynchronously. A return value indicates whether the operation succeeded.

Task<bool> TryRefreshAsync()

Returns

Task<bool>