ConfigurationClient Class

Definition

Namespace:

Azure.Data.AppConfiguration

Assembly:

Azure.Data.AppConfiguration.dll

Package:

Azure.Data.AppConfiguration v1.5.0

Source:

ConfigurationClient.cs

The client to use for interacting with the Azure Configuration Store.

public class ConfigurationClient

type ConfigurationClient = class

Public Class ConfigurationClient

Inheritance

Object

ConfigurationClient

Constructors

ConfigurationClient()	Protected constructor to allow mocking.
ConfigurationClient(String)	Initializes a new instance of the ConfigurationClient class.
ConfigurationClient(String, ConfigurationClientOptions)	Initializes a new instance of the ConfigurationClient class.
ConfigurationClient(Uri, TokenCredential)	Initializes a new instance of the ConfigurationClient class.
ConfigurationClient(Uri, TokenCredential, ConfigurationClientOptions)	Initializes a new instance of the ConfigurationClient class.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AddConfigurationSetting(ConfigurationSetting, CancellationToken)	Creates a ConfigurationSetting only if the setting does not already exist in the configuration store.
AddConfigurationSetting(String, String, String, CancellationToken)	Creates a ConfigurationSetting if the setting, uniquely identified by key and label, does not already exist in the configuration store.
AddConfigurationSettingAsync(ConfigurationSetting, CancellationToken)	Creates a ConfigurationSetting only if the setting does not already exist in the configuration store.
AddConfigurationSettingAsync(String, String, String, CancellationToken)	Creates a ConfigurationSetting if the setting, uniquely identified by key and label, does not already exist in the configuration store.
ArchiveSnapshot(String, CancellationToken)	Updates the state of a configuration snapshot to archive.
ArchiveSnapshot(String, MatchConditions, CancellationToken)	Updates the state of a configuration snapshot to archive.
ArchiveSnapshotAsync(String, CancellationToken)	Updates the state of a configuration snapshot to archive.
ArchiveSnapshotAsync(String, MatchConditions, CancellationToken)	Updates the state of a configuration snapshot to archive.
CreateSnapshot(WaitUntil, String, ConfigurationSnapshot, CancellationToken)	Creates a configuration snapshot.
CreateSnapshotAsync(WaitUntil, String, ConfigurationSnapshot, CancellationToken)	Creates a configuration snapshot.
DeleteConfigurationSetting(ConfigurationSetting, Boolean, CancellationToken)	Delete a ConfigurationSetting from the configuration store.
DeleteConfigurationSetting(String, String, CancellationToken)	Delete a ConfigurationSetting from the configuration store.
DeleteConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken)	Delete a ConfigurationSetting from the configuration store.
DeleteConfigurationSettingAsync(String, String, CancellationToken)	Delete a ConfigurationSetting from the configuration store.
GetConfigurationSetting(ConfigurationSetting, Boolean, CancellationToken)	Retrieve an existing ConfigurationSetting from the configuration store.
GetConfigurationSetting(ConfigurationSetting, DateTimeOffset, CancellationToken)	Retrieve an existing ConfigurationSetting from the configuration store.
GetConfigurationSetting(String, String, CancellationToken)	Retrieve an existing ConfigurationSetting, uniquely identified by key and label, from the configuration store.
GetConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken)	Retrieve an existing ConfigurationSetting from the configuration store.
GetConfigurationSettingAsync(ConfigurationSetting, DateTimeOffset, CancellationToken)	Retrieve an existing ConfigurationSetting from the configuration store.
GetConfigurationSettingAsync(String, String, CancellationToken)	Retrieve an existing ConfigurationSetting, uniquely identified by key and label, from the configuration store.
GetConfigurationSettings(SettingSelector, CancellationToken)	Retrieves one or more ConfigurationSetting entities that match the options specified in the passed-in SettingSelector.
GetConfigurationSettingsAsync(SettingSelector, CancellationToken)	Retrieves one or more ConfigurationSetting entities that match the options specified in the passed-in SettingSelector.
GetConfigurationSettingsForSnapshot(String, CancellationToken)	Retrieves one or more ConfigurationSetting entities for snapshots based on name.
GetConfigurationSettingsForSnapshot(String, SettingFields, CancellationToken)	Retrieves one or more ConfigurationSetting entities for snapshots based on name.
GetConfigurationSettingsForSnapshotAsync(String, CancellationToken)	Retrieves one or more ConfigurationSetting entities for snapshots based on name.
GetConfigurationSettingsForSnapshotAsync(String, SettingFields, CancellationToken)	Retrieves one or more ConfigurationSetting entities for snapshots based on name.
GetLabels(SettingLabelSelector, CancellationToken)	Gets a list of labels.
GetLabelsAsync(SettingLabelSelector, CancellationToken)	Gets a list of labels.
GetRevisions(SettingSelector, CancellationToken)	Retrieves the revisions of one or more ConfigurationSetting entities that satisfy the options of the SettingSelector.
GetRevisions(String, String, CancellationToken)	Retrieves the revisions of one or more ConfigurationSetting entities that match the specified keyFilter and labelFilter.
GetRevisionsAsync(SettingSelector, CancellationToken)	Retrieves the revisions of one or more ConfigurationSetting entities that satisfy the options of the SettingSelector.
GetRevisionsAsync(String, String, CancellationToken)	Retrieves the revisions of one or more ConfigurationSetting entities that match the specified keyFilter and labelFilter.
GetSnapshot(String, IEnumerable<SnapshotFields>, CancellationToken)	Gets a single configuration snapshot.
GetSnapshotAsync(String, IEnumerable<SnapshotFields>, CancellationToken)	Gets a single configuration snapshot.
GetSnapshots(SnapshotSelector, CancellationToken)	Gets a list of configuration snapshots.
GetSnapshotsAsync(SnapshotSelector, CancellationToken)	Gets a list of configuration snapshots.
RecoverSnapshot(String, CancellationToken)	Updates the state of a configuration snapshot to ready.
RecoverSnapshot(String, MatchConditions, CancellationToken)	Updates the state of a configuration snapshot to ready.
RecoverSnapshotAsync(String, CancellationToken)	Updates the state of a configuration snapshot to ready.
RecoverSnapshotAsync(String, MatchConditions, CancellationToken)	Updates the state of a configuration snapshot to ready.
SetConfigurationSetting(ConfigurationSetting, Boolean, CancellationToken)	Creates a ConfigurationSetting if it doesn't exist or overwrites the existing setting in the configuration store.
SetConfigurationSetting(String, String, String, CancellationToken)	Creates a ConfigurationSetting, uniquely identified by key and label, if it doesn't exist or overwrites the existing setting in the configuration store.
SetConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken)	Creates a ConfigurationSetting if it doesn't exist or overwrites the existing setting in the configuration store.
SetConfigurationSettingAsync(String, String, String, CancellationToken)	Creates a ConfigurationSetting, uniquely identified by key and label, if it doesn't exist or overwrites the existing setting in the configuration store.
SetReadOnly(ConfigurationSetting, Boolean, Boolean, CancellationToken)	Sets an existing ConfigurationSetting to read only or read write state in the configuration store.
SetReadOnly(String, Boolean, CancellationToken)	Sets an existing ConfigurationSetting to read only or read write state in the configuration store.
SetReadOnly(String, String, Boolean, CancellationToken)	Sets an existing ConfigurationSetting to read only or read write state in the configuration store.
SetReadOnlyAsync(ConfigurationSetting, Boolean, Boolean, CancellationToken)	Sets an existing ConfigurationSetting to read only or read write state in the configuration store.
SetReadOnlyAsync(String, Boolean, CancellationToken)	Sets an existing ConfigurationSetting to read only or read write state in the configuration store.
SetReadOnlyAsync(String, String, Boolean, CancellationToken)	Sets an existing ConfigurationSetting to read only or read write state in the configuration store.
UpdateSyncToken(String)	Adds an external synchronization token to ensure service requests receive up-to-date values.